StyleBoxLine

Documentation

Overview

A StyleBox that displays a single line of a given color and thickness. The line can be either horizontal or vertical. Useful for separators.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
  • func (self *Extension[T]) AsResource() Resource.Instance
  • func (self *Extension[T]) AsStyleBox() StyleBox.Instance
  • func (self *Extension[T]) AsStyleBoxLine() Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) AsStyleBox() StyleBox.Instance
  • func (self Instance) AsStyleBoxLine() Instance
  • func (self Instance) Color() Color.RGBA
  • func (self Instance) GrowBegin() Float.X
  • func (self Instance) GrowEnd() Float.X
  • func (self Instance) ID() ID
  • func (self Instance) SetColor(value Color.RGBA)
  • func (self Instance) SetGrowBegin(value Float.X)
  • func (self Instance) SetGrowEnd(value Float.X)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetThickness(value int)
  • func (self Instance) SetVertical(value bool)
  • func (self Instance) Thickness() int
  • func (self Instance) Vertical() bool
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsStyleBoxLine() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsStyleBox

func (self *Extension[T]) AsStyleBox() StyleBox.Instance

func (*Extension[T]) AsStyleBoxLine

func (self *Extension[T]) AsStyleBoxLine() Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.StyleBoxLine

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsStyleBox

func (self Instance) AsStyleBox() StyleBox.Instance

func (Instance) AsStyleBoxLine

func (self Instance) AsStyleBoxLine() Instance

func (Instance) Color

func (self Instance) Color() Color.RGBA

The line's color.

func (Instance) GrowBegin

func (self Instance) GrowBegin() Float.X

The number of pixels the line will extend before the StyleBoxLine's bounds. If set to a negative value, the line will begin inside the StyleBoxLine's bounds.

func (Instance) GrowEnd

func (self Instance) GrowEnd() Float.X

The number of pixels the line will extend past the StyleBoxLine's bounds. If set to a negative value, the line will end inside the StyleBoxLine's bounds.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) SetColor

func (self Instance) SetColor(value Color.RGBA)

SetColor sets the property returned by [GetColor].

func (Instance) SetGrowBegin

func (self Instance) SetGrowBegin(value Float.X)

SetGrowBegin sets the property returned by [GetGrowBegin].

func (Instance) SetGrowEnd

func (self Instance) SetGrowEnd(value Float.X)

SetGrowEnd sets the property returned by [GetGrowEnd].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetThickness

func (self Instance) SetThickness(value int)

SetThickness sets the property returned by [GetThickness].

func (Instance) SetVertical

func (self Instance) SetVertical(value bool)

SetVertical sets the property returned by [IsVertical].

func (Instance) Thickness

func (self Instance) Thickness() int

The line's thickness in pixels.

func (Instance) Vertical

func (self Instance) Vertical() bool

If true, the line will be vertical. If false, the line will be horizontal.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value