states

Documentation

Index

• type States
  • func StatesValues() []States
  • func (i States) BitIndexString() string
  • func (i States) Desc() string
  • func (i States) HasFlag(f enums.BitFlag) bool
  • func (i States) Int64() int64
  • func (st States) Is(flag enums.BitFlag) bool
  • func (i States) IsValid() bool
  • func (i States) MarshalText() ([]byte, error)
  • func (i *States) SetFlag(on bool, f ...enums.BitFlag)
  • func (i *States) SetInt64(in int64)
  • func (i *States) SetString(s string) error
  • func (i *States) SetStringOr(s string) error
  • func (st States) StateLayer() float32
  • func (i States) String() string
  • func (i *States) UnmarshalText(text []byte) error
  • func (i States) Values() []enums.Enum

Types

type States

type States int64 //enums:bitflag

States are GUI states of elements that are relevant for styling based on [CSS Pseudo-classes](https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-classes)

const (
	// Invisible elements are not displayed, and thus do not present
	// a target for GUI events.  It is identical to css display:none.
	// This can also be set when the item is out of visible display
	// as in scrolling or collapsing elements.
	// Elements can be made visible by toggling this flag and thus
	// in general should be constructed and styled, but a new layout
	// step must generally be taken after visibility status has changed.
	Invisible States = iota

	// Disabled elements cannot be interacted with or selected,
	// but do display.
	Disabled

	// ReadOnly elements cannot be changed, but can be selected.
	// A text input must not be ReadOnly for entering text.
	// A button can be pressed while ReadOnly -- if not ReadOnly then
	// the label on the button can be edited, for example.
	ReadOnly

	// Selected elements have been marked for clipboard or other such actions.
	Selected

	// Active elements are currently being interacted with,
	// usually involving a mouse button being pressed in the element.
	// A text field will be active while being clicked on, and this
	// can also result in a Focused state.
	// If further movement happens, an element can also end up being
	// Dragged or Sliding.
	Active

	// Dragging means this element is currently being dragged
	// by the mouse (i.e., a MouseDown event followed by MouseMove),
	// as part of a drag-n-drop sequence.
	Dragging

	// Sliding means this element is currently being manipulated
	// via mouse to change the slider state, which will continue
	// until the mouse is released, even if it goes off the element.
	// It should also still be Active.
	Sliding

	// Scrolling means this element is currently being scrolled.
	Scrolling

	// Focused elements receive keyboard input.
	Focused

	// FocusedWithin elements have a Focused element within them,
	// including self.
	FocusedWithin

	// Checked is for check boxes or radio buttons or other similar state.
	Checked

	// Indeterminate indicates that the true state of an item is unknown.
	// For example, [Checked] state items may be in an uncertain state
	// if they represent other checked items, some of which are checked
	// and some of which are not.
	Indeterminate

	// Hovered indicates that a mouse pointer has entered the space over
	// an element, but it is not Active (nor DragHovered).
	Hovered

	// LongHovered indicates a Hover event that persists without significant
	// movement for a minimum period of time (e.g., 500 msec),
	// which typically triggers a tooltip popup.
	LongHovered

	// LongPressed indicates a MouseDown event that persists without significant
	// movement for a minimum period of time (e.g., 500 msec),
	// which typically triggers a tooltip and/or context menu popup.
	LongPressed

	// DragHovered indicates that a mouse pointer has entered the space over
	// an element, during a drag-n-drop sequence.  This makes it a candidate
	// for a potential drop target.  See DropOK for state in relation to that.
	DragHovered

	// DropOK indicates that a DragHovered element is OK to receive a Drop
	// from the current Dragged item, subject also to the Droppable ability.
	DropOK

	// Invalid indicates that the element has invalid input and
	// needs to be corrected by the user
	Invalid

	// Required indicates that the element must be set by the user
	Required

	// Blank indicates that the element has yet to be set by user
	Blank

	// Link indicates a URL link that has not been visited yet
	Link

	// Visited indicates a URL link that has been visited
	Visited

	// AnyLink is either Link or Visited
	AnyLink
)

const StatesN States = 23

StatesN is the highest valid value for type States, plus one.

func StatesValues

func StatesValues() []States

StatesValues returns all possible values for the type States.

func (States) BitIndexString

func (i States) BitIndexString() string

BitIndexString returns the string representation of this States value if it is a bit index value (typically an enum constant), and not an actual bit flag value.

func (States) Desc

func (i States) Desc() string

Desc returns the description of the States value.

func (States) HasFlag

func (i States) HasFlag(f enums.BitFlag) bool

HasFlag returns whether these bit flags have the given bit flag set.

func (States) Int64

func (i States) Int64() int64

Int64 returns the States value as an int64.

func (States) Is

func (st States) Is(flag enums.BitFlag) bool

Is is a shortcut for HasFlag for States

func (States) IsValid

func (i States) IsValid() bool

IsValid returns whether the value is a valid option for type States.

func (States) MarshalText

func (i States) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*States) SetFlag

func (i *States) SetFlag(on bool, f ...enums.BitFlag)

SetFlag sets the value of the given flags in these flags to the given value.

func (*States) SetInt64

func (i *States) SetInt64(in int64)

SetInt64 sets the States value from an int64.

func (*States) SetString

func (i *States) SetString(s string) error

SetString sets the States value from its string representation, and returns an error if the string is invalid.

func (*States) SetStringOr

func (i *States) SetStringOr(s string) error

SetStringOr sets the States value from its string representation while preserving any bit flags already set, and returns an error if the string is invalid.

func (States) StateLayer

func (st States) StateLayer() float32

StateLayer returns the state layer opacity for the state, appropriate for use as the value of goki.dev/girl/styles.Style.StateLayer

func (States) String

func (i States) String() string

String returns the string representation of this States value.

func (*States) UnmarshalText

func (i *States) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (States) Values

func (i States) Values() []enums.Enum

Values returns all possible values for the type States.