Documentation ¶
Overview ¶
Package styles contains the style structures for the Cogent Core GUI framework.
These are all based on the CSS standard: https://www.w3schools.com/cssref/default.asp
Package styles provides style objects containing style properties used for GUI widgets and other rendering contexts.
Index ¶
- Variables
- func AlignFactor(al Aligns) float32
- func AlignPos(align Aligns, inner, outer float32) float32
- func ClampMax(v, mx float32) float32
- func ClampMaxVector(v, mx math32.Vector2) math32.Vector2
- func ClampMin(v, mn float32) float32
- func ClampMinVector(v, mn math32.Vector2) math32.Vector2
- func FixFontMods(fn string) string
- func FontNameFromMods(basenm string, str FontStretch, wt FontWeights, sty FontStyles) string
- func FontNameToMods(fn string) (basenm string, str FontStretch, wt FontWeights, sty FontStyles)
- func ObjectSizeFromFit(fit ObjectFits, obj, box math32.Vector2) math32.Vector2
- func SetClampMax(v *float32, mx float32)
- func SetClampMaxVector(v *math32.Vector2, mx math32.Vector2)
- func SetClampMin(v *float32, mn float32)
- func SetClampMinVector(v *math32.Vector2, mn math32.Vector2)
- func SetStylePropertiesXML(style string, properties *map[string]any)
- func SidesAreSame[T comparable](s Sides[T]) bool
- func SidesAreZero[T comparable](s Sides[T]) bool
- func StylePropertiesXML(properties map[string]any) string
- func SubProperties(prp map[string]any, selector string) (map[string]any, bool)
- func ToCSS(s *Style, idName, htmlName string) string
- type AlignSet
- type Aligns
- func (i Aligns) Desc() string
- func (i Aligns) Int64() int64
- func (i Aligns) MarshalText() ([]byte, error)
- func (i *Aligns) SetInt64(in int64)
- func (i *Aligns) SetString(s string) error
- func (i Aligns) String() string
- func (i *Aligns) UnmarshalText(text []byte) error
- func (i Aligns) Values() []enums.Enum
- type BaselineShifts
- func (i BaselineShifts) Desc() string
- func (i BaselineShifts) Int64() int64
- func (i BaselineShifts) MarshalText() ([]byte, error)
- func (i *BaselineShifts) SetInt64(in int64)
- func (i *BaselineShifts) SetString(s string) error
- func (i BaselineShifts) String() string
- func (i *BaselineShifts) UnmarshalText(text []byte) error
- func (i BaselineShifts) Values() []enums.Enum
- type Border
- type BorderStyles
- func (i BorderStyles) Desc() string
- func (i BorderStyles) Int64() int64
- func (i BorderStyles) MarshalText() ([]byte, error)
- func (i *BorderStyles) SetInt64(in int64)
- func (i *BorderStyles) SetString(s string) error
- func (i BorderStyles) String() string
- func (i *BorderStyles) UnmarshalText(text []byte) error
- func (i BorderStyles) Values() []enums.Enum
- type Directions
- func (i Directions) Desc() string
- func (d Directions) Dim() math32.Dims
- func (i Directions) Int64() int64
- func (i Directions) MarshalText() ([]byte, error)
- func (d Directions) Other() Directions
- func (i *Directions) SetInt64(in int64)
- func (i *Directions) SetString(s string) error
- func (i Directions) String() string
- func (i *Directions) UnmarshalText(text []byte) error
- func (i Directions) Values() []enums.Enum
- type Displays
- func (i Displays) Desc() string
- func (i Displays) Int64() int64
- func (i Displays) MarshalText() ([]byte, error)
- func (i *Displays) SetInt64(in int64)
- func (i *Displays) SetString(s string) error
- func (i Displays) String() string
- func (i *Displays) UnmarshalText(text []byte) error
- func (i Displays) Values() []enums.Enum
- type Fill
- type FillRules
- func (i FillRules) Desc() string
- func (i FillRules) Int64() int64
- func (i FillRules) MarshalText() ([]byte, error)
- func (i *FillRules) SetInt64(in int64)
- func (i *FillRules) SetString(s string) error
- func (i FillRules) String() string
- func (i *FillRules) UnmarshalText(text []byte) error
- func (i FillRules) Values() []enums.Enum
- type Font
- func (fs *Font) Defaults()
- func (fs *Font) InheritFields(parent *Font)
- func (fs *Font) SetDecoration(deco ...TextDecorations)
- func (fs *Font) SetStyleProperties(parent *Font, properties map[string]any, ctxt colors.Context)
- func (fs *Font) SetUnitContext(uc *units.Context)
- func (fs *Font) StyleFromProperties(parent *Font, properties map[string]any, ctxt colors.Context)
- func (fs *Font) ToDots(uc *units.Context)
- type FontFace
- type FontMetrics
- type FontRender
- func (fr *FontRender) Defaults()
- func (fr *FontRender) InheritFields(parent *FontRender)
- func (fr *FontRender) SetStyleProperties(parent *FontRender, properties map[string]any, ctxt colors.Context)
- func (fs *FontRender) StyleRenderFromProperties(parent *FontRender, properties map[string]any, ctxt colors.Context)
- type FontStretch
- func (i FontStretch) Desc() string
- func (i FontStretch) Int64() int64
- func (i FontStretch) MarshalText() ([]byte, error)
- func (i *FontStretch) SetInt64(in int64)
- func (i *FontStretch) SetString(s string) error
- func (i FontStretch) String() string
- func (i *FontStretch) UnmarshalText(text []byte) error
- func (i FontStretch) Values() []enums.Enum
- type FontStyles
- func (i FontStyles) Desc() string
- func (i FontStyles) Int64() int64
- func (i FontStyles) MarshalText() ([]byte, error)
- func (i *FontStyles) SetInt64(in int64)
- func (i *FontStyles) SetString(s string) error
- func (i FontStyles) String() string
- func (i *FontStyles) UnmarshalText(text []byte) error
- func (i FontStyles) Values() []enums.Enum
- type FontVariants
- func (i FontVariants) Desc() string
- func (i FontVariants) Int64() int64
- func (i FontVariants) MarshalText() ([]byte, error)
- func (i *FontVariants) SetInt64(in int64)
- func (i *FontVariants) SetString(s string) error
- func (i FontVariants) String() string
- func (i *FontVariants) UnmarshalText(text []byte) error
- func (i FontVariants) Values() []enums.Enum
- type FontWeights
- func (i FontWeights) Desc() string
- func (i FontWeights) Int64() int64
- func (i FontWeights) MarshalText() ([]byte, error)
- func (i *FontWeights) SetInt64(in int64)
- func (i *FontWeights) SetString(s string) error
- func (i FontWeights) String() string
- func (i *FontWeights) UnmarshalText(text []byte) error
- func (i FontWeights) Values() []enums.Enum
- type LineCaps
- func (i LineCaps) Desc() string
- func (i LineCaps) Int64() int64
- func (i LineCaps) MarshalText() ([]byte, error)
- func (i *LineCaps) SetInt64(in int64)
- func (i *LineCaps) SetString(s string) error
- func (i LineCaps) String() string
- func (i *LineCaps) UnmarshalText(text []byte) error
- func (i LineCaps) Values() []enums.Enum
- type LineJoins
- func (i LineJoins) Desc() string
- func (i LineJoins) Int64() int64
- func (i LineJoins) MarshalText() ([]byte, error)
- func (i *LineJoins) SetInt64(in int64)
- func (i *LineJoins) SetString(s string) error
- func (i LineJoins) String() string
- func (i *LineJoins) UnmarshalText(text []byte) error
- func (i LineJoins) Values() []enums.Enum
- type ObjectFits
- func (i ObjectFits) Desc() string
- func (i ObjectFits) Int64() int64
- func (i ObjectFits) MarshalText() ([]byte, error)
- func (i *ObjectFits) SetInt64(in int64)
- func (i *ObjectFits) SetString(s string) error
- func (i ObjectFits) String() string
- func (i *ObjectFits) UnmarshalText(text []byte) error
- func (i ObjectFits) Values() []enums.Enum
- type Overflows
- func (i Overflows) Desc() string
- func (i Overflows) Int64() int64
- func (i Overflows) MarshalText() ([]byte, error)
- func (i *Overflows) SetInt64(in int64)
- func (i *Overflows) SetString(s string) error
- func (i Overflows) String() string
- func (i *Overflows) UnmarshalText(text []byte) error
- func (i Overflows) Values() []enums.Enum
- type Paint
- func (pc *Paint) CopyStyleFrom(cp *Paint)
- func (pc *Paint) Defaults()
- func (pc *Paint) FromStyle(st *Style)
- func (pc *Paint) InheritFields(parent *Paint)
- func (pc *Paint) SetStyleProperties(parent *Paint, properties map[string]any, ctxt colors.Context)
- func (pc *Paint) SetUnitContextExt(size image.Point)
- func (pc *Paint) ToDots()
- func (pc *Paint) ToDotsImpl(uc *units.Context)
- type Shadow
- func (s *Shadow) BasePos(startPos math32.Vector2) math32.Vector2
- func (s *Shadow) BaseSize(startSize math32.Vector2) math32.Vector2
- func (s *Shadow) HasShadow() bool
- func (s *Shadow) Margin() SideFloats
- func (s *Shadow) Pos(startPos math32.Vector2) math32.Vector2
- func (s *Shadow) Size(startSize math32.Vector2) math32.Vector2
- func (s *Shadow) ToDots(uc *units.Context)
- type SideColors
- type SideFloats
- func (sf SideFloats) Add(other SideFloats) SideFloats
- func (sf SideFloats) Max(other SideFloats) SideFloats
- func (sf SideFloats) Min(other SideFloats) SideFloats
- func (sf SideFloats) MulScalar(s float32) SideFloats
- func (sf SideFloats) Pos() math32.Vector2
- func (sf SideFloats) Round() SideFloats
- func (sf SideFloats) Size() math32.Vector2
- func (sf SideFloats) Sub(other SideFloats) SideFloats
- func (sf SideFloats) ToValues() SideValues
- type SideIndexes
- func (i SideIndexes) Desc() string
- func (i SideIndexes) Int64() int64
- func (i SideIndexes) MarshalText() ([]byte, error)
- func (i *SideIndexes) SetInt64(in int64)
- func (i *SideIndexes) SetString(s string) error
- func (i SideIndexes) String() string
- func (i *SideIndexes) UnmarshalText(text []byte) error
- func (i SideIndexes) Values() []enums.Enum
- type SideValues
- type Sides
- func (s *Sides[T]) Set(vals ...T) *Sides[T]
- func (s *Sides[T]) SetAll(val T) *Sides[T]
- func (s *Sides[T]) SetAny(a any) error
- func (s *Sides[T]) SetBottom(bottom T) *Sides[T]
- func (s *Sides[T]) SetHorizontal(val T) *Sides[T]
- func (s *Sides[T]) SetLeft(left T) *Sides[T]
- func (s *Sides[T]) SetRight(right T) *Sides[T]
- func (s *Sides[T]) SetString(str string) error
- func (s *Sides[T]) SetTop(top T) *Sides[T]
- func (s *Sides[T]) SetVertical(val T) *Sides[T]
- func (s *Sides[T]) Zero() *Sides[T]
- type Stroke
- type Style
- func (s *Style) AbilityIs(able abilities.Abilities) bool
- func (s *Style) AddBoxShadow(shadow ...Shadow)
- func (s *Style) BoxShadowMargin() SideFloats
- func (s *Style) BoxShadowToDots(uc *units.Context)
- func (s *Style) BoxSpace() SideFloats
- func (s *Style) CenterAll()
- func (s *Style) ComputeActualBackground(pabg image.Image)
- func (s *Style) ComputeActualBackgroundFor(bg, pabg image.Image) image.Image
- func (s *Style) Defaults()
- func (s *Style) FontRender() *FontRender
- func (s *Style) HasBoxShadow() bool
- func (s *Style) InheritFields(parent *Style)
- func (s *Style) Is(st states.States) bool
- func (s *Style) IsFlexWrap() bool
- func (s *Style) IsReadOnly() bool
- func (s *Style) LayoutDefaults()
- func (s *Style) LayoutToDots(uc *units.Context)
- func (s *Style) MaxBoxShadowMargin() SideFloats
- func (s *Style) ResizeImage(img image.Image, box math32.Vector2) image.Image
- func (s *Style) SetAbilities(on bool, able ...abilities.Abilities)
- func (s *Style) SetEnabled(on bool) *Style
- func (s *Style) SetMono(mono bool)
- func (s *Style) SetNonSelectable()
- func (s *Style) SetReadOnly(ro bool)
- func (s *Style) SetState(on bool, state ...states.States) *Style
- func (s *Style) SetTextWrap(wrap bool)
- func (s *Style) StyleFromProperty(parent *Style, key string, val any, cc colors.Context)
- func (s *Style) ToDots()
- func (s *Style) ToDotsImpl(uc *units.Context)
- func (s *Style) TotalMargin() SideFloats
- type Text
- type TextAnchors
- func (i TextAnchors) Desc() string
- func (i TextAnchors) Int64() int64
- func (i TextAnchors) MarshalText() ([]byte, error)
- func (i *TextAnchors) SetInt64(in int64)
- func (i *TextAnchors) SetString(s string) error
- func (i TextAnchors) String() string
- func (i *TextAnchors) UnmarshalText(text []byte) error
- func (i TextAnchors) Values() []enums.Enum
- type TextDecorations
- func (i TextDecorations) BitIndexString() string
- func (i TextDecorations) Desc() string
- func (i *TextDecorations) HasFlag(f enums.BitFlag) bool
- func (i TextDecorations) Int64() int64
- func (i TextDecorations) MarshalText() ([]byte, error)
- func (i *TextDecorations) SetFlag(on bool, f ...enums.BitFlag)
- func (i *TextDecorations) SetInt64(in int64)
- func (i *TextDecorations) SetString(s string) error
- func (i *TextDecorations) SetStringOr(s string) error
- func (i TextDecorations) String() string
- func (i *TextDecorations) UnmarshalText(text []byte) error
- func (i TextDecorations) Values() []enums.Enum
- type TextDirections
- func (i TextDirections) Desc() string
- func (i TextDirections) Int64() int64
- func (i TextDirections) MarshalText() ([]byte, error)
- func (i *TextDirections) SetInt64(in int64)
- func (i *TextDirections) SetString(s string) error
- func (i TextDirections) String() string
- func (i *TextDirections) UnmarshalText(text []byte) error
- func (i TextDirections) Values() []enums.Enum
- type UnicodeBidi
- func (i UnicodeBidi) Desc() string
- func (i UnicodeBidi) Int64() int64
- func (i UnicodeBidi) MarshalText() ([]byte, error)
- func (i *UnicodeBidi) SetInt64(in int64)
- func (i *UnicodeBidi) SetString(s string) error
- func (i UnicodeBidi) String() string
- func (i *UnicodeBidi) UnmarshalText(text []byte) error
- func (i UnicodeBidi) Values() []enums.Enum
- type VectorEffects
- func (i VectorEffects) Desc() string
- func (i VectorEffects) Int64() int64
- func (i VectorEffects) MarshalText() ([]byte, error)
- func (i *VectorEffects) SetInt64(in int64)
- func (i *VectorEffects) SetString(s string) error
- func (i VectorEffects) String() string
- func (i *VectorEffects) UnmarshalText(text []byte) error
- func (i VectorEffects) Values() []enums.Enum
- type VirtualKeyboards
- func (i VirtualKeyboards) Desc() string
- func (i VirtualKeyboards) Int64() int64
- func (i VirtualKeyboards) MarshalText() ([]byte, error)
- func (i *VirtualKeyboards) SetInt64(in int64)
- func (i *VirtualKeyboards) SetString(s string) error
- func (i VirtualKeyboards) String() string
- func (i *VirtualKeyboards) UnmarshalText(text []byte) error
- func (i VirtualKeyboards) Values() []enums.Enum
- type WhiteSpaces
- func (i WhiteSpaces) Desc() string
- func (i WhiteSpaces) Int64() int64
- func (i WhiteSpaces) MarshalText() ([]byte, error)
- func (i *WhiteSpaces) SetInt64(in int64)
- func (i *WhiteSpaces) SetString(s string) error
- func (i WhiteSpaces) String() string
- func (i *WhiteSpaces) UnmarshalText(text []byte) error
- func (i WhiteSpaces) Values() []enums.Enum
- type XY
Constants ¶
This section is empty.
Variables ¶
var ( // BorderRadiusExtraSmall indicates to use extra small // 4dp rounded corners BorderRadiusExtraSmall = NewSideValues(units.Dp(4)) // BorderRadiusExtraSmallTop indicates to use extra small // 4dp rounded corners on the top of the element and no // border radius on the bottom of the element BorderRadiusExtraSmallTop = NewSideValues(units.Dp(4), units.Dp(4), units.Zero(), units.Zero()) // BorderRadiusSmall indicates to use small // 8dp rounded corners BorderRadiusSmall = NewSideValues(units.Dp(8)) // BorderRadiusMedium indicates to use medium // 12dp rounded corners BorderRadiusMedium = NewSideValues(units.Dp(12)) // BorderRadiusLarge indicates to use large // 16dp rounded corners BorderRadiusLarge = NewSideValues(units.Dp(16)) // BorderRadiusLargeEnd indicates to use large // 16dp rounded corners on the end (right side) // of the element and no border radius elsewhere BorderRadiusLargeEnd = NewSideValues(units.Zero(), units.Dp(16), units.Dp(16), units.Zero()) // BorderRadiusLargeTop indicates to use large // 16dp rounded corners on the top of the element // and no border radius on the bottom of the element BorderRadiusLargeTop = NewSideValues(units.Dp(16), units.Dp(16), units.Zero(), units.Zero()) // BorderRadiusExtraLarge indicates to use extra large // 28dp rounded corners BorderRadiusExtraLarge = NewSideValues(units.Dp(28)) // BorderRadiusExtraLargeTop indicates to use extra large // 28dp rounded corners on the top of the element // and no border radius on the bottom of the element BorderRadiusExtraLargeTop = NewSideValues(units.Dp(28), units.Dp(28), units.Zero(), units.Zero()) // BorderRadiusFull indicates to use a full border radius, // which creates a circular/pill-shaped object. // It is defined to be a value that the width/height of an object // will never exceed. BorderRadiusFull = NewSideValues(units.Dp(1_000_000_000)) )
Pre-configured border radius values, based on https://m3.material.io/styles/shape/shape-scale-tokens
var DefaultScrollbarWidth = units.Dp(10)
DefaultScrollbarWidth is the default [Style.ScrollbarWidth].
var FontSizePoints = map[string]float32{
"xx-small": 7,
"x-small": 7.5,
"small": 10,
"smallf": 10,
"medium": 12,
"large": 14,
"x-large": 18,
"xx-large": 24,
}
FontSizePoints maps standard font names to standard point sizes -- we use dpi zoom scaling instead of rescaling "medium" font size, so generally use these values as-is. smaller and larger relative scaling can move in 2pt increments
var FontStretchNames = []string{"Normal", "UltraCondensed", "ExtraCondensed", "SemiCondensed", "SemiExpanded", "ExtraExpanded", "UltraExpanded", "Condensed", "Expanded", "Condensed", "Expanded"}
FontStretchNames contains the uppercase names of all the valid font stretches used in the regularized font names. The first name is the baseline default and will be omitted from font names. Order must have names that are subsets of other names at the end so they only match if the more specific one hasn't! And also match the FontStretch enum.
var FontStyleNames = []string{"Normal", "Italic", "Oblique"}
FontStyleNames contains the uppercase names of all the valid font styles used in the regularized font names. The first name is the baseline default and will be omitted from font names.
var FontWeightNameValues = []FontWeights{WeightNormal, WeightThin, WeightExtraLight, WeightLight, WeightMedium, WeightSemiBold, WeightExtraBold, WeightBold, WeightBlack}
FontWeightNameValues is 1-to-1 index map from FontWeightNames to corresponding weight value (using more semantic term instead of numerical one)
var FontWeightNames = []string{"Normal", "Thin", "ExtraLight", "Light", "Medium", "SemiBold", "ExtraBold", "Bold", "Black"}
FontWeightNames contains the uppercase names of all the valid font weights used in the regularized font names. The first name is the baseline default and will be omitted from font names. Order must have names that are subsets of other names at the end so they only match if the more specific one hasn't!
var FontWeightToNameMap = map[FontWeights]string{ Weight100: "Thin", WeightThin: "Thin", Weight200: "ExtraLight", WeightExtraLight: "ExtraLight", Weight300: "Light", WeightLight: "Light", Weight400: "", WeightNormal: "", Weight500: "Medium", WeightMedium: "Medium", Weight600: "SemiBold", WeightSemiBold: "SemiBold", Weight700: "Bold", WeightBold: "Bold", Weight800: "ExtraBold", WeightExtraBold: "ExtraBold", Weight900: "Black", WeightBlack: "Black", WeightBolder: "Medium", WeightLighter: "Light", }
FontWeightToNameMap maps all the style enums to canonical regularized font names
var LineHeightNormal = units.Dp(-1)
LineHeightNormal represents a normal line height, equal to the default height of the font being used.
var PrefFontFamily = "Roboto"
PrefFontFamily is the preferred fallback font family to use when the specified font is not available. It defaults to Roboto.
var SettingsFont, SettingsMonoFont *string
SettingsFont and SettingsMonoFont are pointers to Font and MonoFont in [core.AppearanceSettings], which are used in Style.SetMono if non-nil. They are set automatically by core, so end users should typically not have to interact with them.
Functions ¶
func AlignFactor ¶
func AlignPos ¶
AlignPos returns the position offset based on Align.X,Y settings for given inner-sized box within given outer-sized container box.
func ClampMaxVector ¶ added in v0.0.10
ClampMaxVector returns given Vector2 values, not greater than given max _only if_ max > 0
func ClampMinVector ¶ added in v0.0.10
ClampMinVector returns given Vector2 values, not less than given min _only if_ min > 0
func FixFontMods ¶
FixFontMods ensures that standard font modifiers have a space in front of them, and that the default is not in the name -- used for regularizing font names.
func FontNameFromMods ¶
func FontNameFromMods(basenm string, str FontStretch, wt FontWeights, sty FontStyles) string
FontNameFromMods generates the appropriate regularized file name based on base name and modifiers
func FontNameToMods ¶
func FontNameToMods(fn string) (basenm string, str FontStretch, wt FontWeights, sty FontStyles)
FontNameToMods parses the regularized font name and returns the appropriate base name and associated font mods.
func ObjectSizeFromFit ¶ added in v0.0.3
func ObjectSizeFromFit(fit ObjectFits, obj, box math32.Vector2) math32.Vector2
ObjectSizeFromFit returns the target object size based on the given ObjectFits setting, original object size, and target box size for the object to fit into.
func SetClampMax ¶
SetClampMax ensures the given value is not greater than given max _only if_ max > 0
func SetClampMaxVector ¶ added in v0.0.10
SetClampMaxVector ensures the given Vector2 values are not greater than given max _only if_ max > 0
func SetClampMin ¶
SetClampMin ensures the given value is not less than given min _only if_ min > 0
func SetClampMinVector ¶ added in v0.0.10
SetClampMinVector ensures the given Vector2 values are not less than given min _only if_ min > 0
func SetStylePropertiesXML ¶ added in v0.0.10
SetStylePropertiesXML sets style properties from XML style string, which contains ';' separated name: value pairs
func SidesAreSame ¶
func SidesAreSame[T comparable](s Sides[T]) bool
SidesAreSame returns whether all of the sides/corners are the same
func SidesAreZero ¶
func SidesAreZero[T comparable](s Sides[T]) bool
SidesAreZero returns whether all of the sides/corners are equal to zero
func StylePropertiesXML ¶ added in v0.0.10
StylePropertiesXML returns style properties for XML style string, which contains ';' separated name: value pairs
func SubProperties ¶ added in v0.0.10
SubProperties returns a sub-property map from given prop map for a given styling selector (property name) -- e.g., :normal :active :hover etc -- returns false if not found
Types ¶
type AlignSet ¶
type AlignSet struct { // Content specifies the distribution of the entire collection of items within // any larger amount of space allocated to the container. By contrast, Items // and Self specify distribution within the individual element's allocated space. Content Aligns // Items specifies the distribution within the individual element's allocated space, // as a default for all items within a collection. Items Aligns // Self specifies the distribution within the individual element's allocated space, // for this specific item. Auto defaults to containers Items setting. Self Aligns }
AlignSet specifies the 3 levels of Justify or Align: Content, Items, and Self
type Aligns ¶
type Aligns int32 //enums:enum -transform kebab
Aligns has all different types of alignment and justification.
const ( // Auto means the item uses the container's AlignItems value Auto Aligns = iota // Align items to the start (top, left) of layout Start // Align items to the end (bottom, right) of layout End // Align items centered Center // Align to text baselines Baseline // First and last are flush, equal space between remaining items SpaceBetween // First and last have 1/2 space at edges, full space between remaining items SpaceAround // Equal space at start, end, and between all items SpaceEvenly )
const AlignsN Aligns = 8
AlignsN is the highest valid value for type Aligns, plus one.
func AlignsValues ¶
func AlignsValues() []Aligns
AlignsValues returns all possible values for the type Aligns.
func (Aligns) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*Aligns) SetString ¶
SetString sets the Aligns value from its string representation, and returns an error if the string is invalid.
func (*Aligns) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type BaselineShifts ¶
type BaselineShifts int32 //enums:enum -trim-prefix Shift -transform kebab
BaselineShifts are for super / sub script
const ( ShiftBaseline BaselineShifts = iota ShiftSuper ShiftSub )
const BaselineShiftsN BaselineShifts = 3
BaselineShiftsN is the highest valid value for type BaselineShifts, plus one.
func BaselineShiftsValues ¶
func BaselineShiftsValues() []BaselineShifts
BaselineShiftsValues returns all possible values for the type BaselineShifts.
func (BaselineShifts) Desc ¶
func (i BaselineShifts) Desc() string
Desc returns the description of the BaselineShifts value.
func (BaselineShifts) Int64 ¶
func (i BaselineShifts) Int64() int64
Int64 returns the BaselineShifts value as an int64.
func (BaselineShifts) MarshalText ¶
func (i BaselineShifts) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*BaselineShifts) SetInt64 ¶
func (i *BaselineShifts) SetInt64(in int64)
SetInt64 sets the BaselineShifts value from an int64.
func (*BaselineShifts) SetString ¶
func (i *BaselineShifts) SetString(s string) error
SetString sets the BaselineShifts value from its string representation, and returns an error if the string is invalid.
func (BaselineShifts) String ¶
func (i BaselineShifts) String() string
String returns the string representation of this BaselineShifts value.
func (*BaselineShifts) UnmarshalText ¶
func (i *BaselineShifts) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (BaselineShifts) Values ¶
func (i BaselineShifts) Values() []enums.Enum
Values returns all possible values for the type BaselineShifts.
type Border ¶
type Border struct { // Style specifies how to draw the border Style Sides[BorderStyles] // Width specifies the width of the border Width SideValues `display:"inline"` // Radius specifies the radius (rounding) of the corners Radius SideValues `display:"inline"` // Offset specifies how much, if any, the border is offset // from its element. It is only applicable in the standard // box model, which is used by [paint.Context.DrawStdBox] and // all standard GUI elements. Offset SideValues `display:"inline"` // Color specifies the color of the border Color Sides[image.Image] `display:"inline"` }
Border contains style parameters for borders
type BorderStyles ¶
type BorderStyles int32 //enums:enum -trim-prefix Border -transform kebab
BorderStyles determines how to draw the border
const ( // BorderSolid indicates to render a solid border. BorderSolid BorderStyles = iota // BorderDotted indicates to render a dotted border. BorderDotted // BorderDashed indicates to render a dashed border. BorderDashed // BorderDouble is not currently supported. BorderDouble // BorderGroove is not currently supported. BorderGroove // BorderRidge is not currently supported. BorderRidge // BorderInset is not currently supported. BorderInset // BorderOutset is not currently supported. BorderOutset // BorderNone indicates to render no border. BorderNone )
const BorderStylesN BorderStyles = 9
BorderStylesN is the highest valid value for type BorderStyles, plus one.
func BorderStylesValues ¶
func BorderStylesValues() []BorderStyles
BorderStylesValues returns all possible values for the type BorderStyles.
func (BorderStyles) Desc ¶
func (i BorderStyles) Desc() string
Desc returns the description of the BorderStyles value.
func (BorderStyles) Int64 ¶
func (i BorderStyles) Int64() int64
Int64 returns the BorderStyles value as an int64.
func (BorderStyles) MarshalText ¶
func (i BorderStyles) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*BorderStyles) SetInt64 ¶
func (i *BorderStyles) SetInt64(in int64)
SetInt64 sets the BorderStyles value from an int64.
func (*BorderStyles) SetString ¶
func (i *BorderStyles) SetString(s string) error
SetString sets the BorderStyles value from its string representation, and returns an error if the string is invalid.
func (BorderStyles) String ¶
func (i BorderStyles) String() string
String returns the string representation of this BorderStyles value.
func (*BorderStyles) UnmarshalText ¶
func (i *BorderStyles) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (BorderStyles) Values ¶
func (i BorderStyles) Values() []enums.Enum
Values returns all possible values for the type BorderStyles.
type Directions ¶
type Directions int32 //enums:enum -transform kebab
Direction specifies the way in which elements are laid out, or the dimension on which an element is longer / travels in.
const ( // Row indicates that elements are laid out in a row // or that an element is longer / travels in the x dimension. Row Directions = iota // Column indicates that elements are laid out in a column // or that an element is longer / travels in the y dimension. Column )
const DirectionsN Directions = 2
DirectionsN is the highest valid value for type Directions, plus one.
func DirectionsValues ¶
func DirectionsValues() []Directions
DirectionsValues returns all possible values for the type Directions.
func (Directions) Desc ¶
func (i Directions) Desc() string
Desc returns the description of the Directions value.
func (Directions) Dim ¶
func (d Directions) Dim() math32.Dims
Dim returns the corresponding dimension for the direction.
func (Directions) Int64 ¶
func (i Directions) Int64() int64
Int64 returns the Directions value as an int64.
func (Directions) MarshalText ¶
func (i Directions) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (Directions) Other ¶
func (d Directions) Other() Directions
Other returns the opposite (other) direction.
func (*Directions) SetInt64 ¶
func (i *Directions) SetInt64(in int64)
SetInt64 sets the Directions value from an int64.
func (*Directions) SetString ¶
func (i *Directions) SetString(s string) error
SetString sets the Directions value from its string representation, and returns an error if the string is invalid.
func (Directions) String ¶
func (i Directions) String() string
String returns the string representation of this Directions value.
func (*Directions) UnmarshalText ¶
func (i *Directions) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (Directions) Values ¶
func (i Directions) Values() []enums.Enum
Values returns all possible values for the type Directions.
type Displays ¶
type Displays int32 //enums:enum -trim-prefix Display -transform kebab
Displays determines how items are displayed
const ( // Flex is the default layout model, based on a simplified version of the // CSS flex layout: uses MainAxis to specify the direction, Wrap for // wrapping of elements, and Min, Max, and Grow values on elements to // determine sizing. Flex Displays = iota // Stacked is a stack of elements, with one on top that is visible Stacked // Grid is the X, Y grid layout, with Columns specifying the number // of elements in the X axis. Grid // NoLayout means that no automatic layout will be applied to elements, // which can then be managed via custom code. NoLayout // None means the item is not displayed: sets the Invisible state DisplayNone )
const DisplaysN Displays = 5
DisplaysN is the highest valid value for type Displays, plus one.
func DisplaysValues ¶
func DisplaysValues() []Displays
DisplaysValues returns all possible values for the type Displays.
func (Displays) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*Displays) SetString ¶
SetString sets the Displays value from its string representation, and returns an error if the string is invalid.
func (*Displays) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type Fill ¶
type Fill struct { // fill color image specification; filling is off if nil Color image.Image // global alpha opacity / transparency factor between 0 and 1 Opacity float32 // rule for how to fill more complex shapes with crossing lines Rule FillRules }
Fill contains all the properties for filling a region
type FillRules ¶
type FillRules int32 //enums:enum -trim-prefix FillRule -transform kebab
const FillRulesN FillRules = 2
FillRulesN is the highest valid value for type FillRules, plus one.
func FillRulesValues ¶
func FillRulesValues() []FillRules
FillRulesValues returns all possible values for the type FillRules.
func (FillRules) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*FillRules) SetString ¶
SetString sets the FillRules value from its string representation, and returns an error if the string is invalid.
func (*FillRules) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type Font ¶
type Font struct { // size of font to render (inherited); converted to points when getting font to use Size units.Value // font family (inherited): ordered list of comma-separated names from more general to more specific to use; use split on , to parse Family string // style (inherited): normal, italic, etc Style FontStyles // weight (inherited): normal, bold, etc Weight FontWeights // font stretch / condense options (inherited) Stretch FontStretch // normal or small caps (inherited) Variant FontVariants // Decoration contains the bit flag [TextDecorations] // (underline, line-through, etc). It must be set using // [Font.SetDecoration] since it contains bit flags. // It is not inherited. Decoration TextDecorations // super / sub script (not inherited) Shift BaselineShifts // full font information including enhanced metrics and actual font codes for drawing text; this is a pointer into FontLibrary of loaded fonts Face *FontFace `display:"-"` }
Font contains all font styling information. Most of font information is inherited. Font does not include all information needed for rendering -- see FontRender for that.
func (*Font) SetDecoration ¶ added in v0.0.5
func (fs *Font) SetDecoration(deco ...TextDecorations)
SetDecoration sets text decoration (underline, etc), which uses bitflags to allow multiple combinations.
func (*Font) SetStyleProperties ¶ added in v0.0.10
SetStyleProperties sets font style values based on given property map (name: value pairs), inheriting elements as appropriate from parent, and also having a default style for the "initial" setting.
func (*Font) SetUnitContext ¶
SetUnitContext sets the font-specific information in the given units.Context, based on the currently loaded face.
func (*Font) StyleFromProperties ¶ added in v0.0.10
type FontFace ¶
type FontFace struct { // The full FaceName that the font is accessed by Name string // The integer font size in raw dots Size int // The system image.Font font rendering interface Face font.Face // enhanced metric information for the font Metrics FontMetrics }
FontFace is our enhanced Font Face structure which contains the enhanced computed metrics in addition to the font.Face face
func NewFontFace ¶
NewFontFace returns a new font face
func (*FontFace) ComputeMetrics ¶
func (fs *FontFace) ComputeMetrics()
ComputeMetrics computes the Height, Em, Ex, Ch and Rem metrics associated with current font and overall units context
type FontMetrics ¶
type FontMetrics struct { // reference 1.0 spacing line height of font in dots -- computed from font as ascent + descent + lineGap, where lineGap is specified by the font as the recommended line spacing Height float32 // Em size of font -- this is NOT actually the width of the letter M, but rather the specified point size of the font (in actual display dots, not points) -- it does NOT include the descender and will not fit the entire height of the font Em float32 // Ex size of font -- this is the actual height of the letter x in the font Ex float32 // Ch size of font -- this is the actual width of the 0 glyph in the font Ch float32 }
FontMetrics are our enhanced dot-scale font metrics compared to what is available in the standard font.Metrics lib, including Ex and Ch being defined in terms of the actual letter x and 0
type FontRender ¶
type FontRender struct { Font // text color (inherited) Color image.Image // background color (not inherited, transparent by default) Background image.Image // alpha value between 0 and 1 to apply to the foreground and background of this element and all of its children Opacity float32 }
FontRender contains all font styling information that is needed for SVG text rendering. It is passed to Paint and Style functions. It should typically not be used by end-user code -- see Font for that. It stores all values as pointers so that they correspond to the values of the style object it was derived from.
func (*FontRender) Defaults ¶
func (fr *FontRender) Defaults()
func (*FontRender) InheritFields ¶
func (fr *FontRender) InheritFields(parent *FontRender)
InheritFields from parent
func (*FontRender) SetStyleProperties ¶ added in v0.0.10
func (fr *FontRender) SetStyleProperties(parent *FontRender, properties map[string]any, ctxt colors.Context)
SetStyleProperties sets font style values based on given property map (name: value pairs), inheriting elements as appropriate from parent, and also having a default style for the "initial" setting.
func (*FontRender) StyleRenderFromProperties ¶ added in v0.0.10
func (fs *FontRender) StyleRenderFromProperties(parent *FontRender, properties map[string]any, ctxt colors.Context)
type FontStretch ¶
type FontStretch int32 //enums:enum -trim-prefix FontStr
FontStretch are different stretch levels of font. These are less typically available on most platforms by default.
const ( FontStrNormal FontStretch = iota FontStrUltraCondensed FontStrExtraCondensed FontStrSemiCondensed FontStrSemiExpanded FontStrExtraExpanded FontStrUltraExpanded FontStrCondensed FontStrExpanded FontStrNarrower FontStrWider )
const FontStretchN FontStretch = 11
FontStretchN is the highest valid value for type FontStretch, plus one.
func FontStretchValues ¶
func FontStretchValues() []FontStretch
FontStretchValues returns all possible values for the type FontStretch.
func (FontStretch) Desc ¶
func (i FontStretch) Desc() string
Desc returns the description of the FontStretch value.
func (FontStretch) Int64 ¶
func (i FontStretch) Int64() int64
Int64 returns the FontStretch value as an int64.
func (FontStretch) MarshalText ¶
func (i FontStretch) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*FontStretch) SetInt64 ¶
func (i *FontStretch) SetInt64(in int64)
SetInt64 sets the FontStretch value from an int64.
func (*FontStretch) SetString ¶
func (i *FontStretch) SetString(s string) error
SetString sets the FontStretch value from its string representation, and returns an error if the string is invalid.
func (FontStretch) String ¶
func (i FontStretch) String() string
String returns the string representation of this FontStretch value.
func (*FontStretch) UnmarshalText ¶
func (i *FontStretch) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (FontStretch) Values ¶
func (i FontStretch) Values() []enums.Enum
Values returns all possible values for the type FontStretch.
type FontStyles ¶
type FontStyles int32 //enums:enum -trim-prefix Font -transform kebab
FontStyles styles of font: normal, italic, etc
const ( FontNormal FontStyles = iota // Italic indicates to make font italic Italic // Oblique indicates to make font slanted Oblique )
const FontStylesN FontStyles = 3
FontStylesN is the highest valid value for type FontStyles, plus one.
func FontStylesValues ¶
func FontStylesValues() []FontStyles
FontStylesValues returns all possible values for the type FontStyles.
func (FontStyles) Desc ¶
func (i FontStyles) Desc() string
Desc returns the description of the FontStyles value.
func (FontStyles) Int64 ¶
func (i FontStyles) Int64() int64
Int64 returns the FontStyles value as an int64.
func (FontStyles) MarshalText ¶
func (i FontStyles) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*FontStyles) SetInt64 ¶
func (i *FontStyles) SetInt64(in int64)
SetInt64 sets the FontStyles value from an int64.
func (*FontStyles) SetString ¶
func (i *FontStyles) SetString(s string) error
SetString sets the FontStyles value from its string representation, and returns an error if the string is invalid.
func (FontStyles) String ¶
func (i FontStyles) String() string
String returns the string representation of this FontStyles value.
func (*FontStyles) UnmarshalText ¶
func (i *FontStyles) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (FontStyles) Values ¶
func (i FontStyles) Values() []enums.Enum
Values returns all possible values for the type FontStyles.
type FontVariants ¶
type FontVariants int32 //enums:enum -trim-prefix FontVar -transform kebab
FontVariants is just normal vs. small caps. todo: not currently supported
const ( FontVarNormal FontVariants = iota FontVarSmallCaps )
const FontVariantsN FontVariants = 2
FontVariantsN is the highest valid value for type FontVariants, plus one.
func FontVariantsValues ¶
func FontVariantsValues() []FontVariants
FontVariantsValues returns all possible values for the type FontVariants.
func (FontVariants) Desc ¶
func (i FontVariants) Desc() string
Desc returns the description of the FontVariants value.
func (FontVariants) Int64 ¶
func (i FontVariants) Int64() int64
Int64 returns the FontVariants value as an int64.
func (FontVariants) MarshalText ¶
func (i FontVariants) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*FontVariants) SetInt64 ¶
func (i *FontVariants) SetInt64(in int64)
SetInt64 sets the FontVariants value from an int64.
func (*FontVariants) SetString ¶
func (i *FontVariants) SetString(s string) error
SetString sets the FontVariants value from its string representation, and returns an error if the string is invalid.
func (FontVariants) String ¶
func (i FontVariants) String() string
String returns the string representation of this FontVariants value.
func (*FontVariants) UnmarshalText ¶
func (i *FontVariants) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (FontVariants) Values ¶
func (i FontVariants) Values() []enums.Enum
Values returns all possible values for the type FontVariants.
type FontWeights ¶
type FontWeights int32 //enums:enum -trim-prefix Weight -transform kebab
FontWeights are the valid names for different weights of font, with both the numeric and standard names given. The regularized font names in the font library use the names, as those are typically found in the font files.
const ( WeightNormal FontWeights = iota Weight100 WeightThin // (Hairline) Weight200 WeightExtraLight // (UltraLight) Weight300 WeightLight Weight400 Weight500 WeightMedium Weight600 WeightSemiBold // (DemiBold) Weight700 WeightBold Weight800 WeightExtraBold // (UltraBold) Weight900 WeightBlack WeightBolder WeightLighter )
const FontWeightsN FontWeights = 20
FontWeightsN is the highest valid value for type FontWeights, plus one.
func FontWeightsValues ¶
func FontWeightsValues() []FontWeights
FontWeightsValues returns all possible values for the type FontWeights.
func (FontWeights) Desc ¶
func (i FontWeights) Desc() string
Desc returns the description of the FontWeights value.
func (FontWeights) Int64 ¶
func (i FontWeights) Int64() int64
Int64 returns the FontWeights value as an int64.
func (FontWeights) MarshalText ¶
func (i FontWeights) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*FontWeights) SetInt64 ¶
func (i *FontWeights) SetInt64(in int64)
SetInt64 sets the FontWeights value from an int64.
func (*FontWeights) SetString ¶
func (i *FontWeights) SetString(s string) error
SetString sets the FontWeights value from its string representation, and returns an error if the string is invalid.
func (FontWeights) String ¶
func (i FontWeights) String() string
String returns the string representation of this FontWeights value.
func (*FontWeights) UnmarshalText ¶
func (i *FontWeights) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (FontWeights) Values ¶
func (i FontWeights) Values() []enums.Enum
Values returns all possible values for the type FontWeights.
type LineCaps ¶
type LineCaps int32 //enums:enum -trim-prefix LineCap -transform kebab
end-cap of a line: stroke-linecap property in SVG
const ( // LineCapButt indicates to draw no line caps; it draws a // line with the length of the specified length. LineCapButt LineCaps = iota // LineCapRound indicates to draw a semicircle on each line // end with a diameter of the stroke width. LineCapRound // LineCapSquare indicates to draw a rectangle on each line end // with a height of the stroke width and a width of half of the // stroke width. LineCapSquare // LineCapCubic is a rasterx extension LineCapCubic // LineCapQuadratic is a rasterx extension LineCapQuadratic )
const LineCapsN LineCaps = 5
LineCapsN is the highest valid value for type LineCaps, plus one.
func LineCapsValues ¶
func LineCapsValues() []LineCaps
LineCapsValues returns all possible values for the type LineCaps.
func (LineCaps) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*LineCaps) SetString ¶
SetString sets the LineCaps value from its string representation, and returns an error if the string is invalid.
func (*LineCaps) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type LineJoins ¶
type LineJoins int32 //enums:enum -trim-prefix LineJoin -transform kebab
the way in which lines are joined together: stroke-linejoin property in SVG
const LineJoinsN LineJoins = 6
LineJoinsN is the highest valid value for type LineJoins, plus one.
func LineJoinsValues ¶
func LineJoinsValues() []LineJoins
LineJoinsValues returns all possible values for the type LineJoins.
func (LineJoins) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*LineJoins) SetString ¶
SetString sets the LineJoins value from its string representation, and returns an error if the string is invalid.
func (*LineJoins) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type ObjectFits ¶
type ObjectFits int32 //enums:enum -trim-prefix Fit -transform kebab
ObjectFits are the different ways in which a replaced element (image, video, etc) can be fit into its containing box.
const ( // FitFill indicates that the replaced object will fill // the element's entire content box, stretching if necessary. FitFill ObjectFits = iota // FitContain indicates that the replaced object will resize // as large as possible while fully fitting within the element's // content box and maintaining its aspect ratio. Therefore, // it may not fill the entire element. FitContain // FitCover indicates that the replaced object will fill // the element's entire content box, clipping if necessary. FitCover // FitNone indicates that the replaced object will not resize. FitNone // FitScaleDown indicates that the replaced object will size // as if [FitNone] or [FitContain] was specified, using // whichever will result in a smaller final size. FitScaleDown )
const ObjectFitsN ObjectFits = 5
ObjectFitsN is the highest valid value for type ObjectFits, plus one.
func ObjectFitsValues ¶
func ObjectFitsValues() []ObjectFits
ObjectFitsValues returns all possible values for the type ObjectFits.
func (ObjectFits) Desc ¶
func (i ObjectFits) Desc() string
Desc returns the description of the ObjectFits value.
func (ObjectFits) Int64 ¶
func (i ObjectFits) Int64() int64
Int64 returns the ObjectFits value as an int64.
func (ObjectFits) MarshalText ¶
func (i ObjectFits) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*ObjectFits) SetInt64 ¶
func (i *ObjectFits) SetInt64(in int64)
SetInt64 sets the ObjectFits value from an int64.
func (*ObjectFits) SetString ¶
func (i *ObjectFits) SetString(s string) error
SetString sets the ObjectFits value from its string representation, and returns an error if the string is invalid.
func (ObjectFits) String ¶
func (i ObjectFits) String() string
String returns the string representation of this ObjectFits value.
func (*ObjectFits) UnmarshalText ¶
func (i *ObjectFits) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (ObjectFits) Values ¶
func (i ObjectFits) Values() []enums.Enum
Values returns all possible values for the type ObjectFits.
type Overflows ¶
type Overflows int32 //enums:enum -trim-prefix Overflow -transform kebab
overflow type -- determines what happens when there is too much stuff in a layout
const ( // OverflowVisible makes the overflow visible, meaning that the size // of the container is always at least the Min size of its contents. // No scrollbars are shown. OverflowVisible Overflows = iota // OverflowHidden hides the overflow and doesn't present scrollbars. OverflowHidden // OverflowAuto automatically determines if scrollbars should be added to show // the overflow. Scrollbars are added only if the actual content size is greater // than the currently available size. OverflowAuto // OverflowScroll means that scrollbars are always visible, // and is otherwise identical to Auto. However, only during Viewport PrefSize call, // the actual content size is used -- otherwise it behaves just like Auto. OverflowScroll )
const OverflowsN Overflows = 4
OverflowsN is the highest valid value for type Overflows, plus one.
func OverflowsValues ¶
func OverflowsValues() []Overflows
OverflowsValues returns all possible values for the type Overflows.
func (Overflows) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*Overflows) SetString ¶
SetString sets the Overflows value from its string representation, and returns an error if the string is invalid.
func (*Overflows) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type Paint ¶
type Paint struct { // prop: display:none -- node and everything below it are off, non-rendering Off bool // todo big enum of how to display item -- controls layout etc Display bool // stroke (line drawing) parameters StrokeStyle Stroke // fill (region filling) parameters FillStyle Fill // font also has global opacity setting, along with generic color, background-color settings, which can be copied into stroke / fill as needed FontStyle FontRender // TextStyle has the text styling settings. TextStyle Text // various rendering special effects settings VectorEffect VectorEffects // our additions to transform -- pushed to render state Transform math32.Matrix2 // unit context -- parameters necessary for anchoring relative units UnitContext units.Context // have the styles already been set? StyleSet bool PropertiesNil bool // contains filtered or unexported fields }
Paint provides the styling parameters for SVG-style rendering
func (*Paint) CopyStyleFrom ¶
CopyStyleFrom copies styles from another paint
func (*Paint) InheritFields ¶
InheritFields from parent
func (*Paint) SetStyleProperties ¶ added in v0.0.10
SetStyleProperties sets paint values based on given property map (name: value pairs), inheriting elements as appropriate from parent, and also having a default style for the "initial" setting
func (*Paint) SetUnitContextExt ¶
SetUnitContextExt sets the unit context for external usage of paint outside of Core Scene context, based on overall size of painting canvas. caches everything out in terms of raw pixel dots for rendering call at start of render.
func (*Paint) ToDots ¶
func (pc *Paint) ToDots()
ToDots runs ToDots on unit values, to compile down to raw pixels
func (*Paint) ToDotsImpl ¶
ToDotsImpl runs ToDots on unit values, to compile down to raw pixels
type Shadow ¶
type Shadow struct { // OffsetX is th horizontal offset of the shadow. // Positive moves it right, negative moves it left. OffsetX units.Value // OffsetY is the vertical offset of the shadow. // Positive moves it down, negative moves it up. OffsetY units.Value // Blur specifies the blur radius of the shadow. // Higher numbers make it more blurry. Blur units.Value // Spread specifies the spread radius of the shadow. // Positive numbers increase the size of the shadow, // and negative numbers decrease the size. Spread units.Value // Color specifies the color of the shadow. Color image.Image // Inset specifies whether the shadow is inset within the // box instead of outset outside of the box. // TODO: implement. Inset bool }
style parameters for shadows
func BoxShadow0 ¶
func BoxShadow0() []Shadow
BoxShadow0 returns the shadows to be used on Elevation 0 elements. There are no shadows part of BoxShadow0, so applying it is purely semantic.
func BoxShadow1 ¶
func BoxShadow1() []Shadow
BoxShadow1 contains the shadows to be used on Elevation 1 elements.
func BoxShadow2 ¶
func BoxShadow2() []Shadow
BoxShadow2 returns the shadows to be used on Elevation 2 elements.
func BoxShadow3 ¶
func BoxShadow3() []Shadow
BoxShadow3 returns the shadows to be used on Elevation 3 elements.
func BoxShadow4 ¶
func BoxShadow4() []Shadow
BoxShadow4 returns the shadows to be used on Elevation 4 elements.
func BoxShadow5 ¶
func BoxShadow5() []Shadow
BoxShadow5 returns the shadows to be used on Elevation 5 elements.
func (*Shadow) BasePos ¶
BasePos returns the position at which the base box shadow (the actual solid, unblurred box part) should be rendered if the shadow is on an element with the given starting position.
func (*Shadow) BaseSize ¶
BaseSize returns the total size the base box shadow (the actual solid, unblurred part) should be if the shadow is on an element with the given starting size.
func (*Shadow) Margin ¶
func (s *Shadow) Margin() SideFloats
Margin returns the effective margin created by the shadow on each side in terms of raw display dots. It should be added to margin for sizing considerations.
func (*Shadow) Pos ¶
Pos returns the position at which the blurred box shadow should start if the shadow is on an element with the given starting position.
type SideColors ¶
SideColors contains color values for each side/corner of a box
func NewSideColors ¶
func NewSideColors(vals ...color.RGBA) SideColors
NewSideColors is a helper that creates new side/corner colors and calls Set on them with the given values. It does not return any error values and just logs them.
type SideFloats ¶
SideFloats contains float32 values for each side/corner of a box
func BoxShadowMargin ¶
func BoxShadowMargin(shadows []Shadow) SideFloats
BoxShadowMargin returns the maximum effective box shadow margin of the given box shadows, calculated through Shadow.Margin.
func NewSideFloats ¶
func NewSideFloats(vals ...float32) SideFloats
NewSideFloats is a helper that creates new side/corner floats and calls Set on them with the given values.
func (SideFloats) Add ¶
func (sf SideFloats) Add(other SideFloats) SideFloats
Add adds the side floats to the other side floats and returns the result
func (SideFloats) Max ¶
func (sf SideFloats) Max(other SideFloats) SideFloats
Max returns a new side floats containing the maximum values of the two side floats
func (SideFloats) Min ¶
func (sf SideFloats) Min(other SideFloats) SideFloats
Min returns a new side floats containing the minimum values of the two side floats
func (SideFloats) MulScalar ¶ added in v0.2.1
func (sf SideFloats) MulScalar(s float32) SideFloats
MulScalar multiplies each side by the given scalar value and returns the result.
func (SideFloats) Pos ¶
func (sf SideFloats) Pos() math32.Vector2
Pos returns the position offset casued by the side/corner values (Left, Top)
func (SideFloats) Round ¶ added in v0.0.4
func (sf SideFloats) Round() SideFloats
Round returns a new side floats with each side value rounded to the nearest whole number.
func (SideFloats) Size ¶
func (sf SideFloats) Size() math32.Vector2
Size returns the toal size the side/corner values take up (Left + Right, Top + Bottom)
func (SideFloats) Sub ¶
func (sf SideFloats) Sub(other SideFloats) SideFloats
Sub subtracts the other side floats from the side floats and returns the result
func (SideFloats) ToValues ¶
func (sf SideFloats) ToValues() SideValues
ToValues returns the side floats a SideValues composed of units.UnitDot values
type SideIndexes ¶
type SideIndexes int32 //enums:enum
SideIndexes provides names for the Sides in order defined
const ( Top SideIndexes = iota Right Bottom Left )
const SideIndexesN SideIndexes = 4
SideIndexesN is the highest valid value for type SideIndexes, plus one.
func SideIndexesValues ¶
func SideIndexesValues() []SideIndexes
SideIndexesValues returns all possible values for the type SideIndexes.
func (SideIndexes) Desc ¶
func (i SideIndexes) Desc() string
Desc returns the description of the SideIndexes value.
func (SideIndexes) Int64 ¶
func (i SideIndexes) Int64() int64
Int64 returns the SideIndexes value as an int64.
func (SideIndexes) MarshalText ¶
func (i SideIndexes) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*SideIndexes) SetInt64 ¶
func (i *SideIndexes) SetInt64(in int64)
SetInt64 sets the SideIndexes value from an int64.
func (*SideIndexes) SetString ¶
func (i *SideIndexes) SetString(s string) error
SetString sets the SideIndexes value from its string representation, and returns an error if the string is invalid.
func (SideIndexes) String ¶
func (i SideIndexes) String() string
String returns the string representation of this SideIndexes value.
func (*SideIndexes) UnmarshalText ¶
func (i *SideIndexes) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (SideIndexes) Values ¶
func (i SideIndexes) Values() []enums.Enum
Values returns all possible values for the type SideIndexes.
type SideValues ¶
SideValues contains units.Value values for each side/corner of a box
func NewSideValues ¶
func NewSideValues(vals ...units.Value) SideValues
NewSideValues is a helper that creates new side/corner values and calls Set on them with the given values.
func (SideValues) Dots ¶
func (sv SideValues) Dots() SideFloats
Dots returns the dot values of the sides/corners as a SideFloats. It does not compute them; see ToDots for that.
func (*SideValues) ToDots ¶
func (sv *SideValues) ToDots(uc *units.Context) SideFloats
ToDots converts the values for each of the sides/corners to raw display pixels (dots) and sets the Dots field for each of the values. It returns the dot values as a SideFloats.
type Sides ¶
type Sides[T any] struct { // top/top-left value Top T // right/top-right value Right T // bottom/bottom-right value Bottom T // left/bottom-left value Left T }
Sides contains values for each side or corner of a box. If Sides contains sides, the struct field names correspond directly to the side values (ie: Top = top side value). If Sides contains corners, the struct field names correspond to the corners as follows: Top = top left, Right = top right, Bottom = bottom right, Left = bottom left.
func NewSides ¶
NewSides is a helper that creates new sides/corners of the given type and calls Set on them with the given values.
func (*Sides[T]) Set ¶
Set sets the values of the sides/corners from the given list of 0 to 4 values. If 0 values are provided, all sides/corners are set to the zero value of the type. If 1 value is provided, all sides/corners are set to that value. If 2 values are provided, the top/top-left and bottom/bottom-right are set to the first value and the right/top-right and left/bottom-left are set to the second value. If 3 values are provided, the top/top-left is set to the first value, the right/top-right and left/bottom-left are set to the second value, and the bottom/bottom-right is set to the third value. If 4 values are provided, the top/top-left is set to the first value, the right/top-right is set to the second value, the bottom/bottom-right is set to the third value, and the left/bottom-left is set to the fourth value. If more than 4 values are provided, the behavior is the same as with 4 values, but Set also logs a programmer error. This behavior is based on the CSS multi-side/corner setting syntax, like that with padding and border-radius (see https://www.w3schools.com/css/css_padding.asp and https://www.w3schools.com/cssref/css3_pr_border-radius.php)
func (*Sides[T]) SetHorizontal ¶ added in v0.0.10
SetHorizontal sets the values for the sides/corners in the horizontal/diagonally ascending direction (right/top-right and left/bottom-left) to the given value
func (*Sides[T]) SetVertical ¶ added in v0.0.10
SetVertical sets the values for the sides/corners in the vertical/diagonally descending direction (top/top-left and bottom/bottom-right) to the given value
type Stroke ¶
type Stroke struct { // stroke color image specification; stroking is off if nil Color image.Image // global alpha opacity / transparency factor between 0 and 1 Opacity float32 // line width Width units.Value // minimum line width used for rendering -- if width is > 0, then this is the smallest line width -- this value is NOT subject to transforms so is in absolute dot values, and is ignored if vector-effects non-scaling-stroke is used -- this is an extension of the SVG / CSS standard MinWidth units.Value // Dashes are the dashes of the stroke. Each pair of values specifies // the amount to paint and then the amount to skip. Dashes []float32 // how to draw the end cap of lines Cap LineCaps // how to join line segments Join LineJoins // limit of how far to miter -- must be 1 or larger MiterLimit float32 `min:"1"` }
Stroke contains all the properties for painting a line
func (*Stroke) ApplyBorderStyle ¶
func (ss *Stroke) ApplyBorderStyle(bs BorderStyles)
ApplyBorderStyle applies the given border style to the stroke style.
type Style ¶
type Style struct { // State holds style-relevant state flags, for convenient styling access, // given that styles typically depend on element states. State states.States // Abilities specifies the abilities of this element, which determine // which kinds of states the element can express. // This is used by the system/events system. Putting this info next // to the State info makes it easy to configure and manage. Abilities abilities.Abilities // the cursor to switch to upon hovering over the element (inherited) Cursor cursors.Cursor // Padding is the transparent space around central content of box, // which is _included_ in the size of the standard box rendering. Padding SideValues `display:"inline"` // Margin is the outer-most transparent space around box element, // which is _excluded_ from standard box rendering. Margin SideValues `display:"inline"` // Display controls how items are displayed, in terms of layout Display Displays // Direction specifies the way in which elements are laid out, or // the dimension on which an element is longer / travels in. Direction Directions // Wrap causes elements to wrap around in the CrossAxis dimension // to fit within sizing constraints. Wrap bool // Justify specifies the distribution of elements along the main axis, // i.e., the same as Direction, for Flex Display. For Grid, the main axis is // given by the writing direction (e.g., Row-wise for latin based languages). Justify AlignSet `display:"inline"` // Align specifies the cross-axis alignment of elements, orthogonal to the // main Direction axis. For Grid, the cross-axis is orthogonal to the // writing direction (e.g., Column-wise for latin based languages). Align AlignSet `display:"inline"` // Min is the minimum size of the actual content, exclusive of additional space // from padding, border, margin; 0 = default is sum of Min for all content // (which _includes_ space for all sub-elements). // This is equivalent to the Basis for the CSS flex styling model. Min units.XY `display:"inline"` // Max is the maximum size of the actual content, exclusive of additional space // from padding, border, margin; 0 = default provides no Max size constraint Max units.XY `display:"inline"` // Grow is the proportional amount that the element can grow (stretch) // if there is more space available. 0 = default = no growth. // Extra available space is allocated as: Grow / sum (all Grow). // Important: grow elements absorb available space and thus are not // subject to alignment (Center, End). Grow math32.Vector2 // GrowWrap is a special case for Text elements where it grows initially // in the horizontal axis to allow for longer, word wrapped text to fill // the available space, but then it does not grow thereafter, so that alignment // operations still work (Grow elements do not align because they absorb all // available space). GrowWrap bool // RenderBox determines whether to render the standard box model for the element. // This is typically necessary for most elements and helps prevent text, border, // and box shadow from rendering over themselves. Therefore, it should be kept at // its default value of true in most circumstances, but it can be set to false // when the element is fully managed by something that is guaranteed to render the // appropriate background color and/or border for the element. RenderBox bool // FillMargin determines is whether to fill the margin with // the surrounding background color before rendering the element itself. // This is typically necessary to prevent text, border, and box shadow from // rendering over themselves. Therefore, it should be kept at its default value // of true in most circumstances, but it can be set to false when the element // is fully managed by something that is guaranteed to render the // appropriate background color for the element. It is irrelevant if RenderBox // is false. FillMargin bool // Overflow determines how to handle overflowing content in a layout. // Default is OverflowVisible. Set to OverflowAuto to enable scrollbars. Overflow XY[Overflows] // For layouts, extra space added between elements in the layout. Gap units.XY `display:"inline"` // For grid layouts, the number of columns to use. // If > 0, number of rows is computed as N elements / Columns. // Used as a constraint in layout if individual elements // do not specify their row, column positions Columns int // If this object is a replaced object (image, video, etc) // or has a background image, ObjectFit specifies the way // in which the replaced object should be fit into the element. ObjectFit ObjectFits // If this object is a replaced object (image, video, etc) // or has a background image, ObjectPosition specifies the // X,Y position of the object within the space allocated for // the object (see ObjectFit). ObjectPosition units.XY // Border is a rendered border around the element. Border Border // MaxBorder is the largest border that will ever be rendered // around the element, the size of which is used for computing // the effective margin to allocate for the element. MaxBorder Border // BoxShadow is the box shadows to render around box (can have multiple) BoxShadow []Shadow // MaxBoxShadow contains the largest shadows that will ever be rendered // around the element, the size of which are used for computing the // effective margin to allocate for the element. MaxBoxShadow []Shadow // Color specifies the text / content color, and it is inherited. Color image.Image // Background specifies the background of the element. It is not inherited, // and it is nil (transparent) by default. Background image.Image // alpha value between 0 and 1 to apply to the foreground and background of this element and all of its children Opacity float32 // StateLayer, if above zero, indicates to create a state layer over the element with this much opacity (on a scale of 0-1) and the // color Color (or StateColor if it defined). It is automatically set based on State, but can be overridden in stylers. StateLayer float32 // StateColor, if not nil, is the color to use for the StateLayer instead of Color. If you want to disable state layers // for an element, do not use this; instead, set StateLayer to 0. StateColor image.Image // ActualBackground is the computed actual background rendered for the element, // taking into account its Background, Opacity, StateLayer, and parent // ActualBackground. It is automatically computed and should not be set manually. ActualBackground image.Image // VirtualKeyboard is the virtual keyboard to display, if any, // on mobile platforms when this element is focused. It is not // used if the element is read only. VirtualKeyboard VirtualKeyboards // Pos is used for the position of the widget if the parent frame // has [Style.Display] = [NoLayout]. Pos units.XY `display:"inline"` // ordering factor for rendering depth -- lower numbers rendered first. // Sort children according to this factor ZIndex int // specifies the row that this element should appear within a grid layout Row int // specifies the column that this element should appear within a grid layout Col int // specifies the number of sequential rows that this element should occupy // within a grid layout (todo: not currently supported) RowSpan int // specifies the number of sequential columns that this element should occupy // within a grid layout ColSpan int // ScrollbarWidth is the width of layout scrollbars. It defaults // to [DefaultScrollbarWidth], and it is inherited. ScrollbarWidth units.Value // font styling parameters Font Font // text styling parameters Text Text // unit context: parameters necessary for anchoring relative units UnitContext units.Context }
Style contains all of the style properties used for GUI widgets.
var StyleDefault Style
StyleDefault is default style can be used when property specifies "default"
func (*Style) AbilityIs ¶
AbilityIs returns whether the given abilities.Abilities flag is set
func (*Style) AddBoxShadow ¶
AddBoxShadow adds the given box shadows to the style
func (*Style) BoxShadowMargin ¶
func (s *Style) BoxShadowMargin() SideFloats
BoxShadowMargin returns the effective box shadow margin of the style, calculated through Shadow.Margin
func (*Style) BoxShadowToDots ¶
BoxShadowToDots runs ToDots on all box shadow unit values to compile down to raw pixels
func (*Style) BoxSpace ¶
func (s *Style) BoxSpace() SideFloats
BoxSpace returns the extra space around the central content in the box model in dots. It rounds all of the sides first.
func (*Style) CenterAll ¶ added in v0.1.1
func (s *Style) CenterAll()
CenterAll sets all of the alignment properties to Center such that all children are fully centered.
func (*Style) ComputeActualBackground ¶
ComputeActualBackground sets [Style.ActualBackground] based on the given parent actual background and the properties of the style object.
func (*Style) ComputeActualBackgroundFor ¶
ComputeActualBackgroundFor returns the actual background for the given background based on the given parent actual background and the properties of the style object.
func (*Style) FontRender ¶
func (s *Style) FontRender() *FontRender
FontRender returns the font-rendering-related styles of the style object as a FontRender
func (*Style) HasBoxShadow ¶
HasBoxShadow returns whether the style has any box shadows
func (*Style) InheritFields ¶
InheritFields from parent
func (*Style) Is ¶
Is returns whether the given states.States flag is set
func (*Style) IsFlexWrap ¶
IsFlexWrap returns whether the style is both [Style.Wrap] and Flex.
func (*Style) IsReadOnly ¶ added in v0.3.2
IsReadOnly returns whether this style object is flagged as either states.ReadOnly or states.Disabled.
func (*Style) LayoutDefaults ¶
func (s *Style) LayoutDefaults()
func (*Style) LayoutToDots ¶
ToDots runs ToDots on unit values, to compile down to raw pixels
func (*Style) MaxBoxShadowMargin ¶
func (s *Style) MaxBoxShadowMargin() SideFloats
MaxBoxShadowMargin returns the maximum effective box shadow margin of the style, calculated through Shadow.Margin
func (*Style) ResizeImage ¶
ResizeImage resizes the given image according to [Style.ObjectFit] in an object of the given box size.
func (*Style) SetAbilities ¶
SetAbilities sets the given states.State flags to the given value
func (*Style) SetEnabled ¶
SetEnabled sets the Disabled State flag according to given bool
func (*Style) SetMono ¶ added in v0.1.4
SetMono sets whether the font is monospace, using the SettingsFont and SettingsMonoFont pointers if possible, and falling back on "mono" and "sans-serif" otherwise.
func (*Style) SetNonSelectable ¶
func (s *Style) SetNonSelectable()
SetNonSelectable turns off the Selectable and DoubleClickable abilities and sets the Cursor to None.
func (*Style) SetReadOnly ¶ added in v0.1.1
SetReadOnly sets the states.ReadOnly flag to the given value.
func (*Style) SetState ¶
SetState sets the given states.States flags to the given value
func (*Style) SetTextWrap ¶
SetTextWrap sets the Text.WhiteSpace and GrowWrap properties in a coordinated manner. If wrap == true, then WhiteSpaceNormal and GrowWrap = true; else WhiteSpaceNowrap and GrowWrap = false, which are typically the two desired stylings.
func (*Style) StyleFromProperty ¶ added in v0.3.1
StyleFromProperty sets style field values based on the given property key and value
func (*Style) ToDots ¶
func (s *Style) ToDots()
ToDots caches all style elements in terms of raw pixel dots for rendering.
func (*Style) ToDotsImpl ¶
ToDotsImpl runs ToDots on unit values, to compile down to raw pixels
func (*Style) TotalMargin ¶
func (s *Style) TotalMargin() SideFloats
TotalMargin returns the total effective margin of the element holding the style, using the sum of the actual margin, the max border width, and the max box shadow effective margin. If the values for the max border width / box shadow are unset, the current values are used instead, which allows for the omission of the max properties when the values do not change.
type Text ¶
type Text struct { // how to align text, horizontally (inherited). // This *only* applies to the text within its containing element, // and is typically relevant only for multi-line text: // for single-line text, if element does not have a specified size // that is different from the text size, then this has *no effect*. Align Aligns // vertical alignment of text (inherited). // This *only* applies to the text within its containing element: // if that element does not have a specified size // that is different from the text size, then this has *no effect*. AlignV Aligns // for svg rendering only (inherited): // determines the alignment relative to text position coordinate. // For RTL start is right, not left, and start is top for TB Anchor TextAnchors // spacing between characters and lines LetterSpacing units.Value // extra space to add between words (inherited) WordSpacing units.Value // specified height of a line of text (inherited); text is centered within the overall lineheight; // the standard way to specify line height is in terms of em LineHeight units.Value // WhiteSpace (not inherited) specifies how white space is processed, // and how lines are wrapped. If set to WhiteSpaceNormal (default) lines are wrapped. // See info about interactions with Grow.X setting for this and the NoWrap case. WhiteSpace WhiteSpaces // determines how to treat unicode bidirectional information (inherited) UnicodeBidi UnicodeBidi // bidi-override or embed -- applies to all text elements (inherited) Direction TextDirections // overall writing mode -- only for text elements, not span (inherited) WritingMode TextDirections // for TBRL writing mode (only), determines orientation of alphabetic characters (inherited); // 90 is default (rotated); 0 means keep upright OrientationVert float32 // for horizontal LR/RL writing mode (only), determines orientation of all characters (inherited); // 0 is default (upright) OrientationHoriz float32 // how much to indent the first line in a paragraph (inherited) Indent units.Value // extra spacing between paragraphs (inherited); copied from [Style.Margin] per CSS spec // if that is non-zero, else can be set directly with para-spacing ParaSpacing units.Value // tab size, in number of characters (inherited) TabSize int }
Text is used for layout-level (widget, html-style) text styling -- FontStyle contains all the lower-level text rendering info used in SVG -- most of these are inherited
func (*Text) AlignFactors ¶
AlignFactors gets basic text alignment factors
func (*Text) EffLineHeight ¶
EffLineHeight returns the effective line height for the given font height, handling the LineHeightNormal special case.
func (*Text) HasPre ¶
HasPre returns true if current white space option preserves existing whitespace (or at least requires that parser in case of PreLine, which is intermediate)
func (*Text) HasWordWrap ¶
HasWordWrap returns true if current white space option supports word wrap
type TextAnchors ¶
type TextAnchors int32 //enums:enum -trim-prefix Anchor -transform kebab
TextAnchors are for direction of text writing, used in direction and writing-mode styles
const ( AnchorStart TextAnchors = iota AnchorMiddle AnchorEnd )
const TextAnchorsN TextAnchors = 3
TextAnchorsN is the highest valid value for type TextAnchors, plus one.
func TextAnchorsValues ¶
func TextAnchorsValues() []TextAnchors
TextAnchorsValues returns all possible values for the type TextAnchors.
func (TextAnchors) Desc ¶
func (i TextAnchors) Desc() string
Desc returns the description of the TextAnchors value.
func (TextAnchors) Int64 ¶
func (i TextAnchors) Int64() int64
Int64 returns the TextAnchors value as an int64.
func (TextAnchors) MarshalText ¶
func (i TextAnchors) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*TextAnchors) SetInt64 ¶
func (i *TextAnchors) SetInt64(in int64)
SetInt64 sets the TextAnchors value from an int64.
func (*TextAnchors) SetString ¶
func (i *TextAnchors) SetString(s string) error
SetString sets the TextAnchors value from its string representation, and returns an error if the string is invalid.
func (TextAnchors) String ¶
func (i TextAnchors) String() string
String returns the string representation of this TextAnchors value.
func (*TextAnchors) UnmarshalText ¶
func (i *TextAnchors) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (TextAnchors) Values ¶
func (i TextAnchors) Values() []enums.Enum
Values returns all possible values for the type TextAnchors.
type TextDecorations ¶
type TextDecorations int64 //enums:bitflag -trim-prefix Deco -transform kebab
TextDecorations are underline, line-through, etc, as bit flags that must be set using Font.SetDecoration. Also used for additional layout hints for RuneRender.
const ( DecoNone TextDecorations = iota // Underline indicates to place a line below text Underline // Overline indicates to place a line above text Overline // LineThrough indicates to place a line through text LineThrough // Blink is not currently supported (and probably a bad idea generally ;) DecoBlink // DottedUnderline is used for abbr tag -- otherwise not a standard text-decoration option afaik DecoDottedUnderline // DecoParaStart at start of a SpanRender indicates that it should be // styled as the start of a new paragraph and not just the start of a new // line DecoParaStart // DecoSuper indicates super-scripted text DecoSuper // DecoSub indicates sub-scripted text DecoSub // DecoBackgroundColor indicates that a bg color has been set -- for use in optimizing rendering DecoBackgroundColor )
const TextDecorationsN TextDecorations = 10
TextDecorationsN is the highest valid value for type TextDecorations, plus one.
func TextDecorationsValues ¶
func TextDecorationsValues() []TextDecorations
TextDecorationsValues returns all possible values for the type TextDecorations.
func (TextDecorations) BitIndexString ¶
func (i TextDecorations) BitIndexString() string
BitIndexString returns the string representation of this TextDecorations value if it is a bit index value (typically an enum constant), and not an actual bit flag value.
func (TextDecorations) Desc ¶
func (i TextDecorations) Desc() string
Desc returns the description of the TextDecorations value.
func (*TextDecorations) HasFlag ¶
func (i *TextDecorations) HasFlag(f enums.BitFlag) bool
HasFlag returns whether these bit flags have the given bit flag set.
func (TextDecorations) Int64 ¶
func (i TextDecorations) Int64() int64
Int64 returns the TextDecorations value as an int64.
func (TextDecorations) MarshalText ¶
func (i TextDecorations) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*TextDecorations) SetFlag ¶
func (i *TextDecorations) SetFlag(on bool, f ...enums.BitFlag)
SetFlag sets the value of the given flags in these flags to the given value.
func (*TextDecorations) SetInt64 ¶
func (i *TextDecorations) SetInt64(in int64)
SetInt64 sets the TextDecorations value from an int64.
func (*TextDecorations) SetString ¶
func (i *TextDecorations) SetString(s string) error
SetString sets the TextDecorations value from its string representation, and returns an error if the string is invalid.
func (*TextDecorations) SetStringOr ¶
func (i *TextDecorations) SetStringOr(s string) error
SetStringOr sets the TextDecorations value from its string representation while preserving any bit flags already set, and returns an error if the string is invalid.
func (TextDecorations) String ¶
func (i TextDecorations) String() string
String returns the string representation of this TextDecorations value.
func (*TextDecorations) UnmarshalText ¶
func (i *TextDecorations) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (TextDecorations) Values ¶
func (i TextDecorations) Values() []enums.Enum
Values returns all possible values for the type TextDecorations.
type TextDirections ¶
type TextDirections int32 //enums:enum -transform lower
TextDirections are for direction of text writing, used in direction and writing-mode styles
const ( LRTB TextDirections = iota RLTB TBRL LR RL TB LTR RTL )
const TextDirectionsN TextDirections = 8
TextDirectionsN is the highest valid value for type TextDirections, plus one.
func TextDirectionsValues ¶
func TextDirectionsValues() []TextDirections
TextDirectionsValues returns all possible values for the type TextDirections.
func (TextDirections) Desc ¶
func (i TextDirections) Desc() string
Desc returns the description of the TextDirections value.
func (TextDirections) Int64 ¶
func (i TextDirections) Int64() int64
Int64 returns the TextDirections value as an int64.
func (TextDirections) MarshalText ¶
func (i TextDirections) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*TextDirections) SetInt64 ¶
func (i *TextDirections) SetInt64(in int64)
SetInt64 sets the TextDirections value from an int64.
func (*TextDirections) SetString ¶
func (i *TextDirections) SetString(s string) error
SetString sets the TextDirections value from its string representation, and returns an error if the string is invalid.
func (TextDirections) String ¶
func (i TextDirections) String() string
String returns the string representation of this TextDirections value.
func (*TextDirections) UnmarshalText ¶
func (i *TextDirections) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (TextDirections) Values ¶
func (i TextDirections) Values() []enums.Enum
Values returns all possible values for the type TextDirections.
type UnicodeBidi ¶
type UnicodeBidi int32 //enums:enum -trim-prefix Bidi -transform kebab
UnicodeBidi determines the type of bidirectional text support. See https://pkg.go.dev/golang.org/x/text/unicode/bidi.
const ( BidiNormal UnicodeBidi = iota BidiEmbed BidiBidiOverride )
const UnicodeBidiN UnicodeBidi = 3
UnicodeBidiN is the highest valid value for type UnicodeBidi, plus one.
func UnicodeBidiValues ¶
func UnicodeBidiValues() []UnicodeBidi
UnicodeBidiValues returns all possible values for the type UnicodeBidi.
func (UnicodeBidi) Desc ¶
func (i UnicodeBidi) Desc() string
Desc returns the description of the UnicodeBidi value.
func (UnicodeBidi) Int64 ¶
func (i UnicodeBidi) Int64() int64
Int64 returns the UnicodeBidi value as an int64.
func (UnicodeBidi) MarshalText ¶
func (i UnicodeBidi) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*UnicodeBidi) SetInt64 ¶
func (i *UnicodeBidi) SetInt64(in int64)
SetInt64 sets the UnicodeBidi value from an int64.
func (*UnicodeBidi) SetString ¶
func (i *UnicodeBidi) SetString(s string) error
SetString sets the UnicodeBidi value from its string representation, and returns an error if the string is invalid.
func (UnicodeBidi) String ¶
func (i UnicodeBidi) String() string
String returns the string representation of this UnicodeBidi value.
func (*UnicodeBidi) UnmarshalText ¶
func (i *UnicodeBidi) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (UnicodeBidi) Values ¶
func (i UnicodeBidi) Values() []enums.Enum
Values returns all possible values for the type UnicodeBidi.
type VectorEffects ¶
type VectorEffects int32 //enums:enum -trim-prefix VectorEffect -transform kebab
VectorEffects contains special effects for rendering
const ( VectorEffectNone VectorEffects = iota // VectorEffectNonScalingStroke means that the stroke width is not affected by // transform properties VectorEffectNonScalingStroke )
const VectorEffectsN VectorEffects = 2
VectorEffectsN is the highest valid value for type VectorEffects, plus one.
func VectorEffectsValues ¶
func VectorEffectsValues() []VectorEffects
VectorEffectsValues returns all possible values for the type VectorEffects.
func (VectorEffects) Desc ¶
func (i VectorEffects) Desc() string
Desc returns the description of the VectorEffects value.
func (VectorEffects) Int64 ¶
func (i VectorEffects) Int64() int64
Int64 returns the VectorEffects value as an int64.
func (VectorEffects) MarshalText ¶
func (i VectorEffects) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*VectorEffects) SetInt64 ¶
func (i *VectorEffects) SetInt64(in int64)
SetInt64 sets the VectorEffects value from an int64.
func (*VectorEffects) SetString ¶
func (i *VectorEffects) SetString(s string) error
SetString sets the VectorEffects value from its string representation, and returns an error if the string is invalid.
func (VectorEffects) String ¶
func (i VectorEffects) String() string
String returns the string representation of this VectorEffects value.
func (*VectorEffects) UnmarshalText ¶
func (i *VectorEffects) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (VectorEffects) Values ¶
func (i VectorEffects) Values() []enums.Enum
Values returns all possible values for the type VectorEffects.
type VirtualKeyboards ¶ added in v0.0.6
type VirtualKeyboards int32 //enums:enum -trim-prefix Keyboard -transform kebab
VirtualKeyboards are all of the supported virtual keyboard types to display on mobile platforms.
const ( // KeyboardNone indicates to display no virtual keyboard. KeyboardNone VirtualKeyboards = iota // KeyboardSingleLine indicates to display a virtual keyboard // with a default input style and a "Done" return key. KeyboardSingleLine // KeyboardMultiLine indicates to display a virtual keyboard // with a default input style and a "Return" return key. KeyboardMultiLine // KeyboardNumber indicates to display a virtual keyboard // for inputting a number. KeyboardNumber // KeyboardPassword indicates to display a virtual keyboard // for inputting a password. KeyboardPassword // KeyboardEmail indicates to display a virtual keyboard // for inputting an email address. KeyboardEmail // KeyboardPhone indicates to display a virtual keyboard // for inputting a phone number. KeyboardPhone // KeyboardURL indicates to display a virtual keyboard for // inputting a URL / URI / web address. KeyboardURL )
const VirtualKeyboardsN VirtualKeyboards = 8
VirtualKeyboardsN is the highest valid value for type VirtualKeyboards, plus one.
func VirtualKeyboardsValues ¶ added in v0.0.6
func VirtualKeyboardsValues() []VirtualKeyboards
VirtualKeyboardsValues returns all possible values for the type VirtualKeyboards.
func (VirtualKeyboards) Desc ¶ added in v0.0.6
func (i VirtualKeyboards) Desc() string
Desc returns the description of the VirtualKeyboards value.
func (VirtualKeyboards) Int64 ¶ added in v0.0.6
func (i VirtualKeyboards) Int64() int64
Int64 returns the VirtualKeyboards value as an int64.
func (VirtualKeyboards) MarshalText ¶ added in v0.0.6
func (i VirtualKeyboards) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*VirtualKeyboards) SetInt64 ¶ added in v0.0.6
func (i *VirtualKeyboards) SetInt64(in int64)
SetInt64 sets the VirtualKeyboards value from an int64.
func (*VirtualKeyboards) SetString ¶ added in v0.0.6
func (i *VirtualKeyboards) SetString(s string) error
SetString sets the VirtualKeyboards value from its string representation, and returns an error if the string is invalid.
func (VirtualKeyboards) String ¶ added in v0.0.6
func (i VirtualKeyboards) String() string
String returns the string representation of this VirtualKeyboards value.
func (*VirtualKeyboards) UnmarshalText ¶ added in v0.0.6
func (i *VirtualKeyboards) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (VirtualKeyboards) Values ¶ added in v0.0.6
func (i VirtualKeyboards) Values() []enums.Enum
Values returns all possible values for the type VirtualKeyboards.
type WhiteSpaces ¶
type WhiteSpaces int32 //enums:enum -trim-prefix WhiteSpace
WhiteSpaces determine how white space is processed
const ( // WhiteSpaceNormal means that all white space is collapsed to a single // space, and text wraps when necessary. To get full word wrapping to // expand to all available space, you also need to set GrowWrap = 1. // Use the SetTextWrap convenience method to set both. WhiteSpaceNormal WhiteSpaces = iota // WhiteSpaceNowrap means that sequences of whitespace will collapse into // a single whitespace. Text will never wrap to the next line except // if there is an explicit line break via a <br> tag. In general you // also don't want simple non-wrapping text labels to Grow (GrowWrap = 0). // Use the SetTextWrap method to set both. WhiteSpaceNowrap // WhiteSpacePre means that whitespace is preserved. Text // will only wrap on line breaks. Acts like the <pre> tag in HTML. This // invokes a different hand-written parser because the default Go // parser automatically throws away whitespace. WhiteSpacePre // WhiteSpacePreLine means that sequences of whitespace will collapse // into a single whitespace. Text will wrap when necessary, and on line // breaks WhiteSpacePreLine // WhiteSpacePreWrap means that whitespace is preserved. // Text will wrap when necessary, and on line breaks WhiteSpacePreWrap )
const WhiteSpacesN WhiteSpaces = 5
WhiteSpacesN is the highest valid value for type WhiteSpaces, plus one.
func WhiteSpacesValues ¶
func WhiteSpacesValues() []WhiteSpaces
WhiteSpacesValues returns all possible values for the type WhiteSpaces.
func (WhiteSpaces) Desc ¶
func (i WhiteSpaces) Desc() string
Desc returns the description of the WhiteSpaces value.
func (WhiteSpaces) Int64 ¶
func (i WhiteSpaces) Int64() int64
Int64 returns the WhiteSpaces value as an int64.
func (WhiteSpaces) MarshalText ¶
func (i WhiteSpaces) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface.
func (*WhiteSpaces) SetInt64 ¶
func (i *WhiteSpaces) SetInt64(in int64)
SetInt64 sets the WhiteSpaces value from an int64.
func (*WhiteSpaces) SetString ¶
func (i *WhiteSpaces) SetString(s string) error
SetString sets the WhiteSpaces value from its string representation, and returns an error if the string is invalid.
func (WhiteSpaces) String ¶
func (i WhiteSpaces) String() string
String returns the string representation of this WhiteSpaces value.
func (*WhiteSpaces) UnmarshalText ¶
func (i *WhiteSpaces) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface.
func (WhiteSpaces) Values ¶
func (i WhiteSpaces) Values() []enums.Enum
Values returns all possible values for the type WhiteSpaces.
type XY ¶
type XY[T any] struct { // X is the horizontal axis value X T // Y is the vertical axis value Y T }
XY represents X,Y values
func (*XY[T]) Set ¶
func (xy *XY[T]) Set(v ...T)
Set sets the X, Y values according to the given values. no values: set to 0. 1 value: set both to that value. 2 values, set X, Y to the two values respectively.