display

package
v5.20.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2024 License: MPL-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

Options holds all possible values.

Functions

This section is empty.

Types

type Option

type Option byte

Option holds a display option.

const (
	NotShown Option = iota
	Inline
	Tooltip
	InlineAndTooltip
)

Possible values.

const LastOption Option = InlineAndTooltip

LastOption is the last valid value.

func ExtractOption

func ExtractOption(str string) Option

ExtractOption extracts the value from a string.

func (Option) EnsureValid

func (enum Option) EnsureValid() Option

EnsureValid ensures this is of a known value.

func (Option) Inline

func (enum Option) Inline() bool

Inline returns true if inline notes should be shown.

func (Option) Key

func (enum Option) Key() string

Key returns the key used in serialization.

func (Option) MarshalText

func (enum Option) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface.

func (Option) String

func (enum Option) String() string

String implements fmt.Stringer.

func (Option) Tooltip

func (enum Option) Tooltip() bool

Tooltip returns true if tooltips should be shown.

func (*Option) UnmarshalText

func (enum *Option) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL