gui

package
Version: v0.0.0-...-47917a8 Latest Latest
Warning

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

Go to latest
Published: Sep 15, 2019 License: BSD-2-Clause Imports: 32 Imported by: 0

Documentation

Overview

Package gui implements the GUI infraestructure and several widgets.

Index

Constants

View Source
const (
	AlignNone   = Align(iota) // No alignment
	AlignLeft                 // Align horizontally at left
	AlignRight                // Align horizontally at right
	AlignWidth                // Align horizontally using all width
	AlignTop                  // Align vertically at the top
	AlignBottom               // Align vertically at the cnter
	AlignHeight               // Align vertically using all height
	AlignCenter               // Align horizontally/vertically at the center
)

The various types of alignment.

View Source
const (
	TypePanel       = "panel"
	TypeImagePanel  = "imagepanel"
	TypeLabel       = "label"
	TypeImageLabel  = "imagelabel"
	TypeButton      = "button"
	TypeCheckBox    = "checkbox"
	TypeRadioButton = "radiobutton"
	TypeEdit        = "edit"
	TypeVList       = "vlist"
	TypeHList       = "hlist"
	TypeDropDown    = "dropdown"
	TypeHSlider     = "hslider"
	TypeVSlider     = "vslider"
	TypeHSplitter   = "hsplitter"
	TypeVSplitter   = "vsplitter"
	TypeSeparator   = "separator"
	TypeTree        = "tree"
	TypeTreeNode    = "node"
	TypeMenuBar     = "menubar"
	TypeMenu        = "menu"
	TypeWindow      = "window"
	TypeChart       = "chart"
	TypeTable       = "table"
	TypeTabBar      = "tabbar"
	TypeHBoxLayout  = "hbox"
	TypeVBoxLayout  = "vbox"
	TypeGridLayout  = "grid"
	TypeDockLayout  = "dock"
)

Panel and layout types

View Source
const (
	AttribAlignv         = "alignv"        // Align
	AttribAlignh         = "alignh"        // Align
	AttribAspectHeight   = "aspectheight"  // float32
	AttribAspectWidth    = "aspectwidth"   // float32
	AttribBgColor        = "bgcolor"       // Color4
	AttribBorders        = "borders"       // RectBounds
	AttribBorderColor    = "bordercolor"   // Color4
	AttribChecked        = "checked"       // bool
	AttribColor          = "color"         // Color4
	AttribCols           = "cols"          // int GridLayout
	AttribColSpan        = "colspan"       // int GridLayout
	AttribColumns        = "columns"       // []map[string]interface{} Table
	AttribContent        = "content"       // map[string]interface{} Table
	AttribCountStepx     = "countstepx"    // float32
	AttribEdge           = "edge"          // int
	AttribEnabled        = "enabled"       // bool
	AttribExpand         = "expand"        // float32
	AttribExpandh        = "expandh"       // bool
	AttribExpandv        = "expandv"       // bool
	AttribFirstx         = "firstx"        // float32
	AttribFontColor      = "fontcolor"     // Color4
	AttribFontDPI        = "fontdpi"       // float32
	AttribFontSize       = "fontsize"      // float32
	AttribFormat         = "format"        // string
	AttribGroup          = "group"         // string
	AttribHeader         = "header"        // string
	AttribHeight         = "height"        // float32
	AttribHidden         = "hidden"        // bool Table
	AttribId             = "id"            // string
	AttribIcon           = "icon"          // string
	AttribImageFile      = "imagefile"     // string
	AttribImageLabel     = "imagelabel"    // []map[string]interface{}
	AttribItems          = "items"         // []map[string]interface{}
	AttribLayout         = "layout"        // map[string]interface{}
	AttribLayoutParams   = "layoutparams"  // map[string]interface{}
	AttribLineSpacing    = "linespacing"   // float32
	AttribLines          = "lines"         // int
	AttribMargin         = "margin"        // float32
	AttribMargins        = "margins"       // RectBounds
	AttribMinwidth       = "minwidth"      // float32 Table
	AttribAutoHeight     = "autoheight"    // bool
	AttribAutoWidth      = "autowidth"     // bool
	AttribName           = "name"          // string
	AttribPaddings       = "paddings"      // RectBounds
	AttribPanel0         = "panel0"        // map[string]interface{}
	AttribPanel1         = "panel1"        // map[string]interface{}
	AttribParentInternal = "parent_"       // string (internal attribute)
	AttribPinned         = "pinned"        // bool
	AttribPlaceHolder    = "placeholder"   // string
	AttribPosition       = "position"      // []float32
	AttribRangeAuto      = "rangeauto"     // bool
	AttribRangeMin       = "rangemin"      // float32
	AttribRangeMax       = "rangemax"      // float32
	AttribRender         = "render"        // bool
	AttribResizeBorders  = "resizeborders" // Resizable
	AttribResize         = "resize"        // bool Table
	AttribScaleFactor    = "scalefactor"   // float32
	AttribScalex         = "scalex"        // map[string]interface{}
	AttribScaley         = "scaley"        // map[string]interface{}
	AttribShortcut       = "shortcut"      // []int
	AttribShowHeader     = "showheader"    // bool
	AttribSortType       = "sorttype"      // TableSortType Table
	AttribSpacing        = "spacing"       // float32
	AttribSplit          = "split"         // float32
	AttribStepx          = "stepx"         // float32
	AttribText           = "text"          // string
	AttribTitle          = "title"         // string
	AttribType           = "type"          // string
	AttribUserData       = "userdata"      // interface{}
	AttribWidth          = "width"         // float32
	AttribValue          = "value"         // float32
	AttribVisible        = "visible"       // bool
)

Common attribute names

View Source
const (
	DockTop = iota + 1
	DockRight
	DockBottom
	DockLeft
	DockCenter
)

The different types of docking.

View Source
const (
	// Events sent to target panel's lowest subscribed ancestor
	OnMouseDown = window.OnMouseDown // Any mouse button is pressed
	OnMouseUp   = window.OnMouseUp   // Any mouse button is released
	OnScroll    = window.OnScroll    // Scrolling mouse wheel

	// Events sent to all panels except the ancestors of the target panel
	OnMouseDownOut = "gui.OnMouseDownOut" // Any mouse button is pressed
	OnMouseUpOut   = "gui.OnMouseUpOut"   // Any mouse button is released

	// Event sent to new target panel and all of its ancestors up to (not including) the common ancestor of the new and old targets
	OnCursorEnter = "gui.OnCursorEnter" // Cursor entered the panel or a descendant
	// Event sent to old target panel and all of its ancestors up to (not including) the common ancestor of the new and old targets
	OnCursorLeave = "gui.OnCursorLeave" // Cursor left the panel or a descendant
	// Event sent to the cursor-focused IDispatcher if any, else sent to target panel's lowest subscribed ancestor
	OnCursor = window.OnCursor // Cursor is over the panel

	// Event sent to the new key-focused IDispatcher, specified on a call to gui.Manager().SetKeyFocus(core.IDispatcher)
	OnFocus = "gui.OnFocus" // All keyboard events will be exclusively sent to the receiving IDispatcher
	// Event sent to the previous key-focused IDispatcher when another panel is key-focused
	OnFocusLost = "gui.OnFocusLost" // Keyboard events will stop being sent to the receiving IDispatcher

	// Events sent to the key-focused IDispatcher
	OnKeyDown   = window.OnKeyDown   // A key is pressed
	OnKeyUp     = window.OnKeyUp     // A key is released
	OnKeyRepeat = window.OnKeyRepeat // A key was pressed and is now automatically repeating
	OnChar      = window.OnChar      // A unicode key is pressed
)

Core events sent by the GUI manager. The target panel is the panel immediately under the mouse cursor.

View Source
const (
	OnResize     = "gui.OnResize"     // Panel size changed (no parameters)
	OnEnable     = "gui.OnEnable"     // Panel enabled/disabled (no parameters)
	OnClick      = "gui.OnClick"      // Widget clicked by mouse left button or via key press
	OnChange     = "gui.OnChange"     // Value was changed. Emitted by List, DropDownList, CheckBox and Edit
	OnRadioGroup = "gui.OnRadioGroup" // Radio button within a group changed state
)
View Source
const (
	ScrollNone       = ScrollMode(0x00)                              // No scrolling allowed
	ScrollVertical   = ScrollMode(0x01)                              // Vertical scrolling allowed
	ScrollHorizontal = ScrollMode(0x02)                              // Horizontal scrolling allowed
	ScrollBoth       = ScrollMode(ScrollVertical | ScrollHorizontal) // Both vertical and horizontal scrolling allowed
)

The various scroll modes.

View Source
const (
	ScrollbarInterlockingNone       = ScrollbarInterlocking(iota) // No scrollbar interlocking
	ScrollbarInterlockingVertical                                 // Vertical scrollbar takes precedence
	ScrollbarInterlockingHorizontal                               // Horizontal scrollbar takes precedence
)

The three scrollbar interlocking types.

View Source
const (
	ScrollbarLeft   = ScrollbarPosition(iota) // Scrollbar is positioned on the left of the scroller
	ScrollbarRight                            // Scrollbar is positioned on the right of the scroller
	ScrollbarTop                              // Scrollbar is positioned on the top of the scroller
	ScrollbarBottom                           // Scrollbar is positioned on the bottom of the scroller
)

The four possible scrollbar positions.

View Source
const (
	StyleOver = iota + 1
	StyleFocus
	StyleDisabled
	StyleNormal
	StyleDef
)

States that a GUI element can be in

View Source
const (
	// OnTableClick is the event generated when the table is right or left clicked
	// Parameter is TableClickEvent
	OnTableClick = "onTableClick"
	// OnTableRowCount is the event generated when the table row count changes (no parameters)
	OnTableRowCount = "onTableRowCount"
)
View Source
const IgnoreSuffix = "_"

IgnoreSuffix specifies the suffix of ignored keys

View Source
const OnListItemResize = "gui.OnListItemResize"

OnListItemResize is the identifier of the event dispatched when a ListItem's child panel is resized

View Source
const ScrollModifierKey = window.ModShift

ScrollModifierKey is the ModifierKey that changes the scrolling direction from vertical to horizontal when pressed

Variables

This section is empty.

Functions

func AttribCheckAlign

func AttribCheckAlign(b *Builder, am map[string]interface{}, fname string) error

AttribCheckAlign checks and converts layout align* attribute

func AttribCheckBool

func AttribCheckBool(b *Builder, am map[string]interface{}, fname string) error

AttribCheckBool checks and convert attribute to bool

func AttribCheckBorderSizes

func AttribCheckBorderSizes(b *Builder, am map[string]interface{}, fname string) error

AttribCheckBorderSizes checks and convert attribute with border sizes

func AttribCheckColor

func AttribCheckColor(b *Builder, am map[string]interface{}, fname string) error

AttribCheckColor checks and converts attribute with color name or color component values

func AttribCheckEdge

func AttribCheckEdge(b *Builder, am map[string]interface{}, fname string) error

AttribCheckEdge checks and converts attribute with name of layout edge

func AttribCheckFloat

func AttribCheckFloat(b *Builder, am map[string]interface{}, fname string) error

AttribCheckFloat checks and convert attribute to float32

func AttribCheckIcons

func AttribCheckIcons(b *Builder, am map[string]interface{}, fname string) error

AttribCheckIcons checks and converts attribute with a list of icon names or codepoints

func AttribCheckInt

func AttribCheckInt(b *Builder, am map[string]interface{}, fname string) error

AttribCheckInt checks and convert attribute to int

func AttribCheckInterface

func AttribCheckInterface(b *Builder, am map[string]interface{}, fname string) error

AttribCheckInterface accepts any attribute value

func AttribCheckLayout

func AttribCheckLayout(b *Builder, am map[string]interface{}, fname string) error

AttribCheckLayout checks and converts layout attribute

func AttribCheckListMap

func AttribCheckListMap(b *Builder, am map[string]interface{}, fname string) error

AttribCheckListMap checks and converts attribute to []map[string]interface{}

func AttribCheckMap

func AttribCheckMap(b *Builder, am map[string]interface{}, fname string) error

AttribCheckMap checks and converts attribute to map[string]interface{}

func AttribCheckMenuShortcut

func AttribCheckMenuShortcut(b *Builder, am map[string]interface{}, fname string) error

AttribCheckMenuShortcut checks and converts attribute describing menu shortcut key

func AttribCheckPosition

func AttribCheckPosition(b *Builder, am map[string]interface{}, fname string) error

AttribCheckPosition checks and convert attribute with x and y position

func AttribCheckResizeBorders

func AttribCheckResizeBorders(b *Builder, am map[string]interface{}, fname string) error

AttribCheckResizeBorders checks and converts attribute with list of window resizable borders

func AttribCheckString

func AttribCheckString(b *Builder, am map[string]interface{}, fname string) error

AttribCheckString checks and convert attribute to string

func AttribCheckStringLower

func AttribCheckStringLower(b *Builder, am map[string]interface{}, fname string) error

AttribCheckStringLower checks and convert string attribute to lower case

func AttribCheckTableSortType

func AttribCheckTableSortType(b *Builder, am map[string]interface{}, fname string) error

AttribCheckTableSortType checks and converts attribute table column sort type

func Manager

func Manager() *manager

Manager returns the GUI manager singleton (creating it the first time)

func SetStyleDefault

func SetStyleDefault(s *Style)

SetStyleDefault sets the default style

Types

type Align

type Align int

Align specifies the alignment of an object inside another.

type AttribCheckFunc

type AttribCheckFunc func(b *Builder, am map[string]interface{}, fname string) error

AttribCheckFunc is the type for all attribute check functions

type BasicStyle

type BasicStyle struct {
	PanelStyle
	FgColor math32.Color4
}

BasicStyle extends PanelStyle by adding a foreground color. Many GUI components can be styled using BasicStyle or redeclared versions thereof (e.g. ButtonStyle)

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder builds GUI objects from a declarative description in YAML format

func NewBuilder

func NewBuilder() *Builder

NewBuilder creates and returns a pointer to a new gui Builder object

func (*Builder) AddAttrib

func (b *Builder) AddAttrib(typename string, acf AttribCheckFunc)

AddAttrib adds an attribute type and its checker/converte If the attribute type name already exists it is replaced.

func (*Builder) AddBuilderLayout

func (b *Builder) AddBuilderLayout(typename string, bl IBuilderLayout)

AddBuilderLayout adds a layout builder object for the specified type name. If the type name already exists it is replaced.

func (*Builder) AddBuilderPanel

func (b *Builder) AddBuilderPanel(typename string, bf BuilderFunc)

AddBuilderPanel adds a panel builder function for the specified type name. If the type name already exists it is replaced.

func (*Builder) Build

func (b *Builder) Build(name string) (IPanel, error)

Build builds a gui object and all its children recursively. The specified name should be a top level name from a from a previously parsed description If the descriptions contains a single object with no name, It should be specified the empty string to build this object.

func (*Builder) Names

func (b *Builder) Names() []string

Names returns a sorted list of names of top level previously parsed objects. Only objects with defined types are returned. If there is only a single object with no name, its name is returned as an empty string

func (*Builder) ParseFile

func (b *Builder) ParseFile(filepath string) error

ParseFile parses a file with gui objects descriptions in YAML format It there was a previously parsed description, it is cleared.

func (*Builder) ParseString

func (b *Builder) ParseString(desc string) error

ParseString parses a string with gui objects descriptions in YAML format It there was a previously parsed description, it is cleared.

func (*Builder) SetAttribs

func (b *Builder) SetAttribs(am map[string]interface{}, ipan IPanel) error

SetAttribs sets common attributes from the description to the specified panel

func (*Builder) SetImagepath

func (b *Builder) SetImagepath(path string)

SetImagepath Sets the path for image panels relative image files

type BuilderFunc

type BuilderFunc func(*Builder, map[string]interface{}) (IPanel, error)

BuilderFunc is type for functions which build a gui object from an attribute map

type BuilderLayoutDock

type BuilderLayoutDock struct{}

BuilderLayoutDock is builder for Dock layout

func (*BuilderLayoutDock) BuildLayout

func (bl *BuilderLayoutDock) BuildLayout(b *Builder, am map[string]interface{}) (ILayout, error)

BuildLayout builds and returns a DockLayout with the specified attributes

func (*BuilderLayoutDock) BuildParams

func (bl *BuilderLayoutDock) BuildParams(b *Builder, am map[string]interface{}) (interface{}, error)

BuildParams builds and returns a pointer to DockLayoutParams with the specified attributes

type BuilderLayoutGrid

type BuilderLayoutGrid struct{}

BuilderLayoutGrid is builder for Grid layout

func (*BuilderLayoutGrid) BuildLayout

func (bl *BuilderLayoutGrid) BuildLayout(b *Builder, am map[string]interface{}) (ILayout, error)

BuildLayout builds and returns a GridLayout with the specified attributes

func (*BuilderLayoutGrid) BuildParams

func (bl *BuilderLayoutGrid) BuildParams(b *Builder, am map[string]interface{}) (interface{}, error)

BuildParams builds and returns a pointer to GridLayoutParams with the specified attributes

type BuilderLayoutHBox

type BuilderLayoutHBox struct{}

BuilderLayoutHBox is builder for HBox layout

func (*BuilderLayoutHBox) BuildLayout

func (bl *BuilderLayoutHBox) BuildLayout(b *Builder, am map[string]interface{}) (ILayout, error)

BuildLayout builds and returns an HBoxLayout with the specified attributes

func (*BuilderLayoutHBox) BuildParams

func (bl *BuilderLayoutHBox) BuildParams(b *Builder, am map[string]interface{}) (interface{}, error)

BuildParams builds and returns a pointer to HBoxLayoutParams with the specified attributes

type BuilderLayoutVBox

type BuilderLayoutVBox struct{}

BuilderLayoutVBox is builder for VBox layout

func (*BuilderLayoutVBox) BuildLayout

func (bl *BuilderLayoutVBox) BuildLayout(b *Builder, am map[string]interface{}) (ILayout, error)

BuildLayout builds and returns an VBoxLayout with the specified attributes

func (*BuilderLayoutVBox) BuildParams

func (bl *BuilderLayoutVBox) BuildParams(b *Builder, am map[string]interface{}) (interface{}, error)

BuildParams builds and returns a pointer to VBoxLayoutParams with the specified attributes

type Button

type Button struct {
	Panel        // Embedded Panel
	Label *Label // Label panel
	// contains filtered or unexported fields
}

Button represents a button GUI element

func NewButton

func NewButton(text string) *Button

NewButton creates and returns a pointer to a new button widget with the specified text for the button label.

func (*Button) SetIcon

func (b *Button) SetIcon(icode string)

SetIcon sets the button icon from the default Icon font. If there is currently a selected image, it is removed

func (*Button) SetImage

func (b *Button) SetImage(imgfile string) error

SetImage sets the button left image from the specified filename If there is currently a selected icon, it is removed

func (*Button) SetStyles

func (b *Button) SetStyles(bs *ButtonStyles)

SetStyles set the button styles overriding the default style

type ButtonState

type ButtonState int

ButtonState specifies a button state.

const (
	ButtonNormal ButtonState = iota
	ButtonOver
	ButtonPressed
	ButtonDisabled
)

The possible button states.

type ButtonStyle

type ButtonStyle BasicStyle

ButtonStyle contains the styling of a Button

type ButtonStyles

type ButtonStyles struct {
	Normal   ButtonStyle
	Over     ButtonStyle
	Focus    ButtonStyle
	Pressed  ButtonStyle
	Disabled ButtonStyle
}

ButtonStyles contains one ButtonStyle for each possible button state

type Chart

type Chart struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Chart implements a panel which can contain a title, an x scale, an y scale and several graphs

func NewChart

func NewChart(width, height float32) *Chart

NewChart creates and returns a new chart panel with the specified dimensions in pixels.

func (*Chart) AddLineGraph

func (ch *Chart) AddLineGraph(color *math32.Color, data []float32) *Graph

AddLineGraph adds a line graph to the chart

func (*Chart) ClearScaleX

func (ch *Chart) ClearScaleX()

ClearScaleX removes the X scale if it was previously set

func (*Chart) ClearScaleY

func (ch *Chart) ClearScaleY()

ClearScaleY removes the Y scale if it was previously set

func (*Chart) Init

func (ch *Chart) Init(width float32, height float32)

Init initializes a new chart with the specified width and height It is normally used to initialize a Chart embedded in a struct

func (*Chart) RangeY

func (ch *Chart) RangeY() (minY, maxY float32)

RangeY returns the current y range

func (*Chart) RemoveGraph

func (ch *Chart) RemoveGraph(g *Graph)

RemoveGraph removes and disposes of the specified graph from the chart

func (*Chart) SetFontSizeX

func (ch *Chart) SetFontSizeX(size float64)

SetFontSizeX sets the font size for the x scale labels

func (*Chart) SetFontSizeY

func (ch *Chart) SetFontSizeY(size float64)

SetFontSizeY sets the font size for the y scale labels

func (*Chart) SetFormatX

func (ch *Chart) SetFormatX(format string)

SetFormatX sets the string format of the X scale labels

func (*Chart) SetFormatY

func (ch *Chart) SetFormatY(format string)

SetFormatY sets the string format of the Y scale labels

func (*Chart) SetMarginX

func (ch *Chart) SetMarginX(bottom float32)

SetMarginX sets the x scale margin

func (*Chart) SetMarginY

func (ch *Chart) SetMarginY(left float32)

SetMarginY sets the y scale margin

func (*Chart) SetRangeX

func (ch *Chart) SetRangeX(firstX float32, stepX float32, countStepX float32)

SetRangeX sets the X scale labels and range per step firstX is the value of first label of the x scale stepX is the step to be added to get the next x scale label countStepX is the number of elements of the data buffer for each line step

func (*Chart) SetRangeY

func (ch *Chart) SetRangeY(min float32, max float32)

SetRangeY sets the minimum and maximum values of the y scale

func (*Chart) SetRangeYauto

func (ch *Chart) SetRangeYauto(auto bool)

SetRangeYauto sets the state of the auto

func (*Chart) SetScaleX

func (ch *Chart) SetScaleX(lines int, color *math32.Color)

SetScaleX sets the X scale number of lines, lines color and label font size

func (*Chart) SetScaleY

func (ch *Chart) SetScaleY(lines int, color *math32.Color)

SetScaleY sets the Y scale number of lines and color

func (*Chart) SetTitle

func (ch *Chart) SetTitle(title string, size float64)

SetTitle sets the chart title text and font size. To remove the title pass an empty string

type CheckRadio

type CheckRadio struct {
	Panel        // Embedded panel
	Label *Label // Text label
	// contains filtered or unexported fields
}

CheckRadio is a GUI element that can be either a checkbox or a radio button

func NewCheckBox

func NewCheckBox(text string) *CheckRadio

NewCheckBox creates and returns a pointer to a new CheckBox widget with the specified text

func NewRadioButton

func NewRadioButton(text string) *CheckRadio

NewRadioButton creates and returns a pointer to a new RadioButton widget with the specified text

func (*CheckRadio) Group

func (cb *CheckRadio) Group() string

Group returns the name of the radio group

func (*CheckRadio) SetGroup

func (cb *CheckRadio) SetGroup(group string) *CheckRadio

SetGroup sets the name of the radio group

func (*CheckRadio) SetStyles

func (cb *CheckRadio) SetStyles(bs *CheckRadioStyles)

SetStyles set the button styles overriding the default style

func (*CheckRadio) SetValue

func (cb *CheckRadio) SetValue(state bool) *CheckRadio

SetValue sets the current state of the checkbox

func (*CheckRadio) Value

func (cb *CheckRadio) Value() bool

Value returns the current state of the checkbox

type CheckRadioStyle

type CheckRadioStyle BasicStyle

CheckRadioStyle contains the styling of a CheckRadio

type CheckRadioStyles

type CheckRadioStyles struct {
	Normal   CheckRadioStyle
	Over     CheckRadioStyle
	Focus    CheckRadioStyle
	Disabled CheckRadioStyle
}

CheckRadioStyles contains an CheckRadioStyle for each valid GUI state

type ColorStyle

type ColorStyle struct {
	BgDark    math32.Color4
	BgMed     math32.Color4
	BgNormal  math32.Color4
	BgOver    math32.Color4
	Highlight math32.Color4
	Select    math32.Color4
	Text      math32.Color4
	TextDis   math32.Color4
}

ColorStyle defines the main colors used.

type ControlFolder

type ControlFolder struct {
	Folder // Embedded folder
	// contains filtered or unexported fields
}

ControlFolder represents a folder with controls.

func NewControlFolder

func NewControlFolder(text string, width float32) *ControlFolder

NewControlFolder creates and returns a pointer to a new control folder widget with the specified text and initial width

func (*ControlFolder) AddCheckBox

func (f *ControlFolder) AddCheckBox(text string) *CheckRadio

AddCheckBox adds a checkbox to the control folder's tree

func (*ControlFolder) AddGroup

func (f *ControlFolder) AddGroup(text string) *ControlFolderGroup

AddGroup adds a group to the control folder

func (*ControlFolder) AddPanel

func (f *ControlFolder) AddPanel(pan IPanel)

AddPanel adds an IPanel to the control folder's tree

func (*ControlFolder) AddSlider

func (f *ControlFolder) AddSlider(text string, sf, v float32) *Slider

AddSlider adds a slider to the control folder's tree

func (*ControlFolder) Clear

func (f *ControlFolder) Clear()

Clear clears the control folder's tree

func (*ControlFolder) Initialize

func (f *ControlFolder) Initialize(text string, width float32)

Initialize initializes the control folder with the specified text and initial width It is normally used when the control folder is embedded in another object

func (*ControlFolder) RemoveAt

func (f *ControlFolder) RemoveAt(pos int) IPanel

RemoveAt removes the IPanel at the specified position from the control folder's tree

func (*ControlFolder) SetStyles

func (f *ControlFolder) SetStyles(fs *ControlFolderStyles)

SetStyles set the folder styles overriding the default style

type ControlFolderGroup

type ControlFolderGroup struct {
	// contains filtered or unexported fields
}

ControlFolderGroup represents a group of controls in the control folder.

func (*ControlFolderGroup) AddCheckBox

func (g *ControlFolderGroup) AddCheckBox(text string) *CheckRadio

AddCheckBox adds a checkbox to the control folder group

func (*ControlFolderGroup) AddPanel

func (g *ControlFolderGroup) AddPanel(pan IPanel)

AddPanel adds a panel to the control folder group

func (*ControlFolderGroup) AddSlider

func (g *ControlFolderGroup) AddSlider(text string, sf, v float32) *Slider

AddSlider adds a slider to the control folder group

type ControlFolderStyles

type ControlFolderStyles struct {
	Folder *FolderStyles
	Tree   *TreeStyles
}

ControlFolderStyles contains the styling for the valid GUI states of the components of a ControlFolder.

type DockLayout

type DockLayout struct {
}

DockLayout is the layout for docking panels to the internal edges of their parent.

func NewDockLayout

func NewDockLayout() *DockLayout

NewDockLayout returns a pointer to a new DockLayout.

func (*DockLayout) Recalc

func (dl *DockLayout) Recalc(ipan IPanel)

Recalc (which satisfies the ILayout interface) recalculates the positions and sizes of the children panels.

type DockLayoutParams

type DockLayoutParams struct {
	Edge int
}

DockLayoutParams specifies the edge to dock to.

type DropDown struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

DropDown represents a dropdown GUI element.

func NewDropDown

func NewDropDown(width float32, item *ImageLabel) *DropDown

NewDropDown creates and returns a pointer to a new drop down widget with the specified width.

func (dd *DropDown) Add(item *ImageLabel)

Add adds a list item at the end of the list

func (dd *DropDown) InsertAt(pos int, item *ImageLabel)

InsertAt inserts a list item at the specified position Returs true if the item was successfully inserted

func (dd *DropDown) ItemAt(pos int) *ImageLabel

ItemAt returns the list item at the specified position

func (dd *DropDown) Len() int

Len returns the number of items in the dropdown's list.

func (dd *DropDown) RemoveAt(pos int)

RemoveAt removes the list item from the specified position Returs true if the item was successfully removed

func (dd *DropDown) SelectPos(pos int)

SelectPos selects the item at the specified position

func (dd *DropDown) Selected() *ImageLabel

Selected returns the currently selected item or nil if no item was selected

func (dd *DropDown) SelectedPos() int

SelectedPos returns the currently selected position or -1 if no item was selected

func (dd *DropDown) SetSelected(item *ImageLabel)

SetSelected sets the selected item

func (dd *DropDown) SetStyles(dds *DropDownStyles)

SetStyles sets the drop down styles overriding the default style

type DropDownStyle BasicStyle

DropDownStyle contains the styling of a DropDown.

type DropDownStyles struct {
	Normal   DropDownStyle
	Over     DropDownStyle
	Focus    DropDownStyle
	Disabled DropDownStyle
}

DropDownStyles contains a DropDownStyle for each valid GUI state.

type Edit

type Edit struct {
	Label         // Embedded label
	MaxLength int // Maximum number of characters
	// contains filtered or unexported fields
}

Edit represents a text edit box GUI element

func NewEdit

func NewEdit(width int, placeHolder string) *Edit

NewEdit creates and returns a pointer to a new edit widget

func (*Edit) CursorBack

func (ed *Edit) CursorBack()

CursorBack deletes the character at left of the cursor if possible

func (*Edit) CursorDelete

func (ed *Edit) CursorDelete()

CursorDelete deletes the character at the right of the cursor if possible

func (*Edit) CursorEnd

func (ed *Edit) CursorEnd()

CursorEnd moves the edit cursor to the end of the text

func (*Edit) CursorHome

func (ed *Edit) CursorHome()

CursorHome moves the edit cursor to the beginning of the text

func (*Edit) CursorInput

func (ed *Edit) CursorInput(s string)

CursorInput inserts the specified string at the current cursor position

func (*Edit) CursorLeft

func (ed *Edit) CursorLeft()

CursorLeft moves the edit cursor one character left if possible

func (*Edit) CursorPos

func (ed *Edit) CursorPos(col int)

CursorPos sets the position of the cursor at the specified column if possible

func (*Edit) CursorRight

func (ed *Edit) CursorRight()

CursorRight moves the edit cursor one character right if possible

func (*Edit) OnFocusLost

func (ed *Edit) OnFocusLost(evname string, ev interface{})

LostKeyFocus satisfies the IPanel interface and is called by gui root container when the panel loses the key focus

func (*Edit) SetFontSize

func (ed *Edit) SetFontSize(size float64) *Edit

SetFontSize sets label font size (overrides Label.SetFontSize)

func (*Edit) SetStyles

func (ed *Edit) SetStyles(es *EditStyles)

SetStyles set the button styles overriding the default style

func (*Edit) SetText

func (ed *Edit) SetText(text string) *Edit

SetText sets this edit text

func (*Edit) Text

func (ed *Edit) Text() string

Text returns the current edited text

type EditStyle

type EditStyle struct {
	Border      RectBounds
	Paddings    RectBounds
	BorderColor math32.Color4
	BgColor     math32.Color4
	BgAlpha     float32
	FgColor     math32.Color4
	HolderColor math32.Color4
}

EditStyle contains the styling of an Edit

type EditStyles

type EditStyles struct {
	Normal   EditStyle
	Over     EditStyle
	Focus    EditStyle
	Disabled EditStyle
}

EditStyles contains an EditStyle for each valid GUI state

type FillLayout

type FillLayout struct {
	// contains filtered or unexported fields
}

FillLayout is the simple layout where the assigned panel "fills" its parent in the specified dimension(s)

func NewFillLayout

func NewFillLayout(width, height bool) *FillLayout

NewFillLayout creates and returns a pointer of a new fill layout

func (*FillLayout) Recalc

func (f *FillLayout) Recalc(ipan IPanel)

Recalc is called by the panel which has this layout

type Folder

type Folder struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Folder represents a folder GUI element.

func NewFolder

func NewFolder(text string, width float32, contentPanel IPanel) *Folder

NewFolder creates and returns a pointer to a new folder widget with the specified text and initial width.

func (*Folder) Height

func (f *Folder) Height() float32

Height returns this folder total height considering the contents panel, if visible.

func (*Folder) Initialize

func (f *Folder) Initialize(text string, width float32, contentPanel IPanel)

Initialize initializes the Folder with the specified text and initial width It is normally used when the folder is embedded in another object.

func (*Folder) SetAlignRight

func (f *Folder) SetAlignRight(state bool)

SetAlignRight sets the side of the alignment of the content panel in relation to the folder.

func (*Folder) SetStyles

func (f *Folder) SetStyles(fs *FolderStyles)

SetStyles set the folder styles overriding the default style.

type FolderStyle

type FolderStyle struct {
	PanelStyle
	FgColor math32.Color4
	Icons   [2]string
}

FolderStyle contains the styling of a Folder.

type FolderStyles

type FolderStyles struct {
	Normal   FolderStyle
	Over     FolderStyle
	Focus    FolderStyle
	Disabled FolderStyle
}

FolderStyles contains a FolderStyle for each valid GUI state.

type Graph

type Graph struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Graph is the GUI element that represents a single plotted function. A Chart has an array of Graph objects.

func (*Graph) RenderSetup

func (lg *Graph) RenderSetup(gs *gls.GLS, rinfo *core.RenderInfo)

RenderSetup is called by the renderer before drawing this graphic It overrides the original panel RenderSetup Calculates the model matrix and transfer to OpenGL.

func (*Graph) SetColor

func (lg *Graph) SetColor(color *math32.Color)

SetColor sets the color of the graph

func (*Graph) SetData

func (lg *Graph) SetData(data []float32)

SetData sets the graph data

func (*Graph) SetLineWidth

func (lg *Graph) SetLineWidth(width float32)

SetLineWidth sets the graph line width

type GridLayout

type GridLayout struct {
	// contains filtered or unexported fields
}

GridLayout is a panel layout which arranges its children in a rectangular grid. It is necessary to set the number of columns of the grid when the layout is created. The panel's child elements are positioned in the grid cells accordingly to the order they were added to the panel. The height of each row is determined by the height of the heightest child in the row. The width of each column is determined by the width of the widest child in the column

func NewGridLayout

func NewGridLayout(ncols int) *GridLayout

NewGridLayout creates and returns a pointer of a new grid layout

func (*GridLayout) Recalc

func (g *GridLayout) Recalc(ipan IPanel)

Recalc sets the position and sizes of all of the panel's children. It is normally called by the parent panel when its size changes or a child is added or removed.

func (*GridLayout) SetAlignH

func (g *GridLayout) SetAlignH(align Align)

SetAlignH sets the horizontal alignment for all the grid cells The alignment of an individual cell can be set by settings its layout parameters.

func (*GridLayout) SetAlignV

func (g *GridLayout) SetAlignV(align Align)

SetAlignV sets the vertical alignment for all the grid cells The alignment of an individual cell can be set by settings its layout parameters.

func (*GridLayout) SetColAlignH

func (g *GridLayout) SetColAlignH(col int, align Align)

SetColAlignH sets the horizontal alignment for all the cells of the specified column. The function panics if the supplied column is invalid.

func (*GridLayout) SetColAlignV

func (g *GridLayout) SetColAlignV(col int, align Align)

SetColAlignV sets the vertical alignment for all the cells of the specified column. The function panics if the supplied column is invalid

func (*GridLayout) SetExpandH

func (g *GridLayout) SetExpandH(expand bool)

SetExpandH sets it the columns should expand horizontally if possible

func (*GridLayout) SetExpandV

func (g *GridLayout) SetExpandV(expand bool)

SetExpandV sets it the rowss should expand vertically if possible

type GridLayoutParams

type GridLayoutParams struct {
	ColSpan int   // Number of additional columns to ocuppy to the right
	AlignH  Align // Vertical alignment
	AlignV  Align // Horizontal alignment
}

GridLayoutParams describes layout parameter for an specific child

type HBoxLayout

type HBoxLayout struct {
	// contains filtered or unexported fields
}

HBoxLayout implements a panel layout which arranges the panel children horizontally. The children can be separated by a space in pixels set by SetSpacing(). The whole group of children can be aligned horizontally by SetAlignH() which can accept the following types of alignment:

AlignLeft: Try to align the group of children to the left if the panel width is
greater the the sum of the children widths + spacing.

AlignRight: Try to align the group of children to the right if the panel width is
greater the the sum of the children widths + spacing.

AlignCenter: Try to align the group of children in the center if the panel width is
greater the the sum of the children widths + spacing.

AlignWidth - Try to align the individual children with the same same space between each other.
Each individual child can be aligned vertically by SetLayoutParameters()

If the layout method SetAutoHeight(true) is called, the panel minimum content height will be the height of the child with the largest height.

If the layout method SetAutoWidth(true) is called, the panel minimum content width will be the sum of its children's widths plus the spacing.

func NewHBoxLayout

func NewHBoxLayout() *HBoxLayout

NewHBoxLayout creates and returns a pointer to a new horizontal box layout

func (*HBoxLayout) Recalc

func (bl *HBoxLayout) Recalc(ipan IPanel)

Recalc recalculates and sets the position and sizes of all children

func (*HBoxLayout) SetAlignH

func (bl *HBoxLayout) SetAlignH(align Align)

SetAlignH sets the horizontal alignment of the whole group of items inside the parent panel and updates the layout. This only has any effect if there are no expanded items.

func (*HBoxLayout) SetAutoHeight

func (bl *HBoxLayout) SetAutoHeight(state bool)

SetAutoHeight sets if the panel minimum height should be the height of the largest of its children's height.

func (*HBoxLayout) SetAutoWidth

func (bl *HBoxLayout) SetAutoWidth(state bool)

SetAutoWidth sets if the panel minimum width should be sum of its children's width plus the spacing

func (*HBoxLayout) SetSpacing

func (bl *HBoxLayout) SetSpacing(spacing float32)

SetSpacing sets the horizontal spacing between the items in pixels and updates the layout if possible

type HBoxLayoutParams

type HBoxLayoutParams struct {
	Expand float32 // item expand horizontally factor (0 - no expand)
	AlignV Align   // item vertical alignment
}

HBoxLayoutParams specify the vertical alignment of each individual child.

type IBuilderLayout

type IBuilderLayout interface {
	BuildLayout(b *Builder, am map[string]interface{}) (ILayout, error)
	BuildParams(b *Builder, am map[string]interface{}) (interface{}, error)
}

IBuilderLayout is the interface for all layout builders

type ILayout

type ILayout interface {
	Recalc(ipan IPanel)
}

ILayout is the interface for layouts

type IPanel

type IPanel interface {
	graphic.IGraphic
	GetPanel() *Panel
	Width() float32
	Height() float32
	Enabled() bool
	SetEnabled(bool)
	SetLayout(ILayout)
	InsideBorders(x, y float32) bool
	SetZLayerDelta(zLayerDelta int)
	ZLayerDelta() int

	// TODO these methods here should probably be defined in INode
	SetPosition(x, y float32)
	SetPositionX(x float32)
	SetPositionY(y float32)
	SetPositionZ(y float32)
}

IPanel is the interface for all panel types

type Image

type Image struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Image is a Panel which contains a single Image

func NewImage

func NewImage(imgfile string) (image *Image, err error)

NewImage creates and returns an image panel with the image from the specified image used as a texture. Initially the size of the panel content area is the exact size of the image.

func NewImageFromRGBA

func NewImageFromRGBA(rgba *image.RGBA) *Image

NewImageFromRGBA creates and returns an image panel from the specified image

func NewImageFromTex

func NewImageFromTex(tex *texture.Texture2D) *Image

NewImageFromTex creates and returns an image panel from the specified texture2D

func (*Image) SetImage

func (i *Image) SetImage(imgfile string) error

SetImage sets the image from the specified image file

func (*Image) SetTexture

func (i *Image) SetTexture(tex *texture.Texture2D) *texture.Texture2D

SetTexture changes the image texture to the specified texture2D. It returns a pointer to the previous texture.

type ImageButton

type ImageButton struct {
	*Panel // Embedded Panel
	// contains filtered or unexported fields
}

ImageButton represents an image button GUI element

func NewImageButton

func NewImageButton(normalImgPath string) (*ImageButton, error)

NewImageButton creates and returns a pointer to a new ImageButton widget with the specified image.

func (*ImageButton) Dispose

func (b *ImageButton) Dispose()

Dispose releases resources used by this widget

func (*ImageButton) SetFontSize

func (b *ImageButton) SetFontSize(size float64)

SetFontSize sets the font size of the label/icon

func (*ImageButton) SetIcon

func (b *ImageButton) SetIcon(icode string)

SetIcon sets the icon

func (*ImageButton) SetImage

func (b *ImageButton) SetImage(state ButtonState, imgfile string) error

SetImage sets the button left image from the specified filename If there is currently a selected icon, it is removed

func (*ImageButton) SetStyles

func (b *ImageButton) SetStyles(bs *ImageButtonStyles)

SetStyles set the button styles overriding the default style

func (*ImageButton) SetText

func (b *ImageButton) SetText(text string)

SetText sets the text of the label

type ImageButtonStyle

type ImageButtonStyle BasicStyle

ImageButtonStyle contains the styling of an ImageButton.

type ImageButtonStyles

type ImageButtonStyles struct {
	Normal   ImageButtonStyle
	Over     ImageButtonStyle
	Focus    ImageButtonStyle
	Pressed  ImageButtonStyle
	Disabled ImageButtonStyle
}

ImageButtonStyles contains one ImageButtonStyle for each possible ImageButton state.

type ImageLabel

type ImageLabel struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

ImageLabel is a panel which can contain an Image or Icon plus a Label side by side.

func NewImageLabel

func NewImageLabel(text string) *ImageLabel

NewImageLabel creates and returns a pointer to a new image label widget with the specified text for the label and no image/icon

func (*ImageLabel) CopyFields

func (il *ImageLabel) CopyFields(other *ImageLabel)

CopyFields copies another image label icon/image and text to this one

func (*ImageLabel) ImageVisible

func (il *ImageLabel) ImageVisible() bool

ImageVisible returns the image visibility

func (*ImageLabel) SetBgColor

func (il *ImageLabel) SetBgColor(color *math32.Color)

SetBgColor sets the color of the image label background The color alpha is set to 1.0

func (*ImageLabel) SetBgColor4

func (il *ImageLabel) SetBgColor4(color *math32.Color4)

SetBgColor4 sets the color4 of the image label background

func (*ImageLabel) SetColor

func (il *ImageLabel) SetColor(color *math32.Color)

SetColor sets the color of the label and icon text

func (*ImageLabel) SetColor4

func (il *ImageLabel) SetColor4(color *math32.Color4)

SetColor4 sets the color4 of the label and icon

func (*ImageLabel) SetFontSize

func (il *ImageLabel) SetFontSize(size float64)

SetFontSize sets the size of the image label font size

func (*ImageLabel) SetIcon

func (il *ImageLabel) SetIcon(icon string)

SetIcon sets the image label icon from the default Icon font. If there is currently a selected image, it is removed

func (*ImageLabel) SetImage

func (il *ImageLabel) SetImage(img *Image)

SetImage sets the image label image

func (*ImageLabel) SetImageFromFile

func (il *ImageLabel) SetImageFromFile(imgfile string) error

SetImageFromFile sets the image label image from the specified filename If there is currently a selected icon, it is removed

func (*ImageLabel) SetImageVisible

func (il *ImageLabel) SetImageVisible(vis bool)

SetImageVisible sets the image visibility

func (*ImageLabel) SetText

func (il *ImageLabel) SetText(text string)

SetText sets the text of the image label

func (*ImageLabel) Text

func (il *ImageLabel) Text() string

Text returns the current label text

type ImageLabelStyle

type ImageLabelStyle BasicStyle

ImageLabelStyle contains the styling of an ImageLabel.

type ItemScroller

type ItemScroller struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

ItemScroller is the GUI element that allows scrolling of IPanels

func NewHScroller

func NewHScroller(width, height float32) *ItemScroller

NewHScroller creates and returns a pointer to a new horizontal scroller panel with the specified dimensions.

func NewVScroller

func NewVScroller(width, height float32) *ItemScroller

NewVScroller creates and returns a pointer to a new vertical scroller panel with the specified dimensions.

func (*ItemScroller) Add

func (s *ItemScroller) Add(item IPanel)

Add appends the specified item to the end of the scroller

func (*ItemScroller) ApplyStyle

func (s *ItemScroller) ApplyStyle(style int)

ApplyStyle applies the specified style to the ItemScroller

func (*ItemScroller) Clear

func (s *ItemScroller) Clear()

Clear removes and disposes of all the scroller children

func (*ItemScroller) First

func (s *ItemScroller) First() int

First returns the position of the first visible item

func (*ItemScroller) InsertAt

func (s *ItemScroller) InsertAt(pos int, item IPanel)

InsertAt inserts an item at the specified position

func (*ItemScroller) ItemAt

func (s *ItemScroller) ItemAt(pos int) IPanel

ItemAt returns the item at the specified position. Returns nil if the position is invalid.

func (*ItemScroller) ItemPosition

func (s *ItemScroller) ItemPosition(item IPanel) int

ItemPosition returns the position of the specified item in the scroller of -1 if not found

func (*ItemScroller) ItemVisible

func (s *ItemScroller) ItemVisible(pos int) bool

ItemVisible returns indication if the item at the specified position is completely visible or not

func (*ItemScroller) Len

func (s *ItemScroller) Len() int

Len return the number of items in the scroller

func (*ItemScroller) Remove

func (s *ItemScroller) Remove(item IPanel)

Remove removes the specified item from the ItemScroller

func (*ItemScroller) RemoveAt

func (s *ItemScroller) RemoveAt(pos int) IPanel

RemoveAt removes item from the specified position

func (*ItemScroller) ScrollDown

func (s *ItemScroller) ScrollDown()

ScrollDown scrolls the list down one item if possible

func (*ItemScroller) ScrollUp

func (s *ItemScroller) ScrollUp()

ScrollUp scrolls the list up one item if possible

func (*ItemScroller) SetAutoButtonSize

func (s *ItemScroller) SetAutoButtonSize(autoButtonSize bool)

SetAutoButtonSize specified whether the scrollbutton size should be adjusted relative to the size of the content/view

func (*ItemScroller) SetAutoHeight

func (s *ItemScroller) SetAutoHeight(maxHeight float32)

SetAutoHeight sets the maximum automatic height

func (*ItemScroller) SetAutoWidth

func (s *ItemScroller) SetAutoWidth(maxWidth float32)

SetAutoWidth sets the maximum automatic width

func (*ItemScroller) SetFirst

func (s *ItemScroller) SetFirst(pos int)

SetFirst set the position of first visible if possible

func (*ItemScroller) SetStyles

func (s *ItemScroller) SetStyles(ss *ItemScrollerStyles)

SetStyles set the scroller styles overriding the default style

type ItemScrollerStyle

type ItemScrollerStyle BasicStyle

ItemScrollerStyle contains the styling of a ItemScroller

type ItemScrollerStyles

type ItemScrollerStyles struct {
	Normal   ItemScrollerStyle
	Over     ItemScrollerStyle
	Focus    ItemScrollerStyle
	Disabled ItemScrollerStyle
}

ItemScrollerStyles contains a ItemScrollerStyle for each valid GUI state

type Label

type Label struct {
	Panel // Embedded Panel
	// contains filtered or unexported fields
}

Label is a panel which contains a texture with text. The content size of the label panel is the exact size of the texture.

func NewIcon

func NewIcon(icon string) *Label

NewIcon creates and returns a label panel with the specified text drawn using the default icon font.

func NewLabel

func NewLabel(text string) *Label

NewLabel creates and returns a label panel with the specified text drawn using the default text font.

func NewLabelWithFont

func NewLabelWithFont(msg string, font *text.Font) *Label

NewLabelWithFont creates and returns a label panel with the specified text drawn using the specified font.

func (*Label) BgColor

func (l *Label) BgColor() math32.Color4

BgColor returns returns the background color.

func (*Label) Color

func (l *Label) Color() math32.Color4

Color returns the text color.

func (*Label) Font

func (l *Label) Font() *text.Font

Font returns the font.

func (*Label) FontDPI

func (l *Label) FontDPI() float64

FontDPI returns the resolution of the font in dots per inch (DPI).

func (*Label) FontSize

func (l *Label) FontSize() float64

FontSize returns the point size of the font.

func (*Label) LineSpacing

func (l *Label) LineSpacing() float64

LineSpacing returns the spacing between lines.

func (*Label) SetBgColor

func (l *Label) SetBgColor(color *math32.Color) *Label

SetBgColor sets the background color. The color alpha is set to 1.0

func (*Label) SetBgColor4

func (l *Label) SetBgColor4(color *math32.Color4) *Label

SetBgColor4 sets the background color.

func (*Label) SetColor

func (l *Label) SetColor(color *math32.Color) *Label

SetColor sets the text color. Alpha is set to 1 (opaque).

func (*Label) SetColor4

func (l *Label) SetColor4(color4 *math32.Color4) *Label

SetColor4 sets the text color.

func (*Label) SetFont

func (l *Label) SetFont(f *text.Font)

SetFont sets the font.

func (*Label) SetFontDPI

func (l *Label) SetFontDPI(dpi float64) *Label

SetFontDPI sets the resolution of the font in dots per inch (DPI).

func (*Label) SetFontSize

func (l *Label) SetFontSize(size float64) *Label

SetFontSize sets the point size of the font.

func (*Label) SetLineSpacing

func (l *Label) SetLineSpacing(spacing float64) *Label

SetLineSpacing sets the spacing between lines.

func (*Label) SetText

func (l *Label) SetText(text string)

SetText sets and draws the label text using the font.

func (*Label) Text

func (l *Label) Text() string

Text returns the label text.

type LabelStyle

type LabelStyle struct {
	PanelStyle
	text.FontAttributes
	FgColor math32.Color4
}

LabelStyle contains all the styling attributes of a Label. It's essentially a BasicStyle combined with FontAttributes.

type List

type List struct {
	ItemScroller // Embedded scroller
	// contains filtered or unexported fields
}

List represents a list GUI element

func NewHList

func NewHList(width, height float32) *List

NewHList creates and returns a pointer to a new horizontal list panel with the specified dimensions

func NewVList

func NewVList(width, height float32) *List

NewVList creates and returns a pointer to a new vertical list panel with the specified dimensions

func (*List) Add

func (li *List) Add(item IPanel) *ListItem

Add add a list item at the end of the list

func (*List) InsertAt

func (li *List) InsertAt(pos int, item IPanel) *ListItem

InsertAt inserts a list item at the specified position Returs true if the item was successfully inserted

func (*List) ItemAt

func (li *List) ItemAt(pos int) IPanel

ItemAt returns the list item at the specified position

func (*List) ItemPosition

func (li *List) ItemPosition(item IPanel) int

ItemPosition returns the position of the specified item in the list or -1 if not found

func (*List) Remove

func (li *List) Remove(item IPanel)

Remove removes the specified item from the list

func (*List) RemoveAt

func (li *List) RemoveAt(pos int) IPanel

RemoveAt removes the list item from the specified position

func (*List) SelectPos

func (li *List) SelectPos(pos int, state bool)

SelectPos selects or unselects the item at the specified position

func (*List) Selected

func (li *List) Selected() []IPanel

Selected returns list with the currently selected items

func (*List) SetItemPadLeftAt

func (li *List) SetItemPadLeftAt(pos int, pad float32)

SetItemPadLeftAt sets the additional left padding for this item It is used mainly by the tree control

func (*List) SetSelected

func (li *List) SetSelected(item IPanel, state bool)

SetSelected selects or unselects the specified item

func (*List) SetSingle

func (li *List) SetSingle(state bool)

SetSingle sets the single/multiple selection flag of the list

func (*List) SetStyles

func (li *List) SetStyles(s *ListStyles)

SetStyles set the listr styles overriding the default style

func (*List) Single

func (li *List) Single() bool

Single returns the current state of the single/multiple selection flag

type ListItem

type ListItem struct {
	Panel // Container panel
	// contains filtered or unexported fields
}

ListItem encapsulates each item inserted into the list

func (*ListItem) SetHighlighted

func (litem *ListItem) SetHighlighted(state bool)

SetHighlighted sets this item selected state

func (*ListItem) SetSelected

func (litem *ListItem) SetSelected(state bool)

SetSelected sets this item selected state

type ListItemStyle

type ListItemStyle BasicStyle

ListItemStyle contains the styling of a list item.

type ListItemStyles

type ListItemStyles struct {
	Normal      ListItemStyle
	Over        ListItemStyle
	Selected    ListItemStyle
	Highlighted ListItemStyle
	SelHigh     ListItemStyle
}

ListItemStyles contains one ListItemStyle for each possible item state.

type ListStyles

type ListStyles struct {
	Scroller *ItemScrollerStyles
	Item     *ListItemStyles
}

ListStyles encapsulates a set of styles for the list and item.

type Menu struct {
	Panel // embedded panel
	// contains filtered or unexported fields
}

Menu is the menu GUI element

func NewMenu

func NewMenu() *Menu

NewMenu creates and returns a pointer to a new empty vertical menu

func NewMenuBar

func NewMenuBar() *Menu

NewMenuBar creates and returns a pointer to a new empty menu bar

func (m *Menu) AddMenu(text string, subm *Menu) *MenuItem

AddMenu creates and adds a new menu item to this menu with the specified text and sub menu. Returns the pointer to the created menu item.

func (m *Menu) AddOption(text string) *MenuItem

AddOption creates and adds a new menu item to this menu with the specified text and returns the pointer to the created menu item.

func (m *Menu) AddSeparator() *MenuItem

AddSeparator creates and adds a new separator to the menu

func (m *Menu) RemoveItem(mi *MenuItem)

RemoveItem removes the specified menu item from this menu

type MenuBodyStyle BasicStyle

MenuBodyStyle describes the style of the menu body

type MenuBodyStyles struct {
	Normal   MenuBodyStyle
	Over     MenuBodyStyle
	Focus    MenuBodyStyle
	Disabled MenuBodyStyle
}

MenuBodyStyles describes all styles of the menu body

type MenuItem struct {
	Panel // embedded panel
	// contains filtered or unexported fields
}

MenuItem is an option of a Menu

func (mi *MenuItem) Id() string

Id returns this menu item current id

func (mi *MenuItem) IdPath() []string

IdPath returns a slice with the path of menu items ids to this menu item

func (mi *MenuItem) SetEnabled(enabled bool)

SetEnabled sets the enabled state of this menu item

func (mi *MenuItem) SetIcon(icon string) *MenuItem

SetIcon sets the left icon of this menu item If an image was previously set it is replaced by this icon

func (mi *MenuItem) SetId(id string) *MenuItem

SetId sets this menu item string id which can be used to identify the selected menu option.

func (mi *MenuItem) SetImage(img *Image)

SetImage sets the left image of this menu item If an icon was previously set it is replaced by this image

func (mi *MenuItem) SetShortcut(mods window.ModifierKey, key window.Key) *MenuItem

SetShortcut sets the keyboard shortcut of this menu item

func (mi *MenuItem) SetSubmenu(smi *MenuItem) *MenuItem

SetSubmenu sets an associated sub menu item for this menu item

func (mi *MenuItem) SetText(text string) *MenuItem

SetText sets the text of this menu item

type MenuItemStyle struct {
	PanelStyle
	FgColor          math32.Color4
	IconPaddings     RectBounds
	ShortcutPaddings RectBounds
	RiconPaddings    RectBounds
}

MenuItemStyle describes the style of a menu item

type MenuItemStyles struct {
	Normal    MenuItemStyle
	Over      MenuItemStyle
	Disabled  MenuItemStyle
	Separator MenuItemStyle
}

MenuItemStyles describes all the menu item styles

type MenuStyles struct {
	Body *MenuBodyStyles // Menu body styles
	Item *MenuItemStyles // Menu item styles
}

MenuStyles describes all styles of the menu body and menu item

type Panel

type Panel struct {
	*graphic.Graphic // Embedded graphic
	// contains filtered or unexported fields
}

Panel is 2D rectangular graphic which by default has a quad (2 triangles) geometry. When using the default geometry, a panel has margins, borders, paddings and a content area. The content area can be associated with a texture It is the building block of most GUI widgets.

func NewPanel

func NewPanel(width, height float32) *Panel

NewPanel creates and returns a pointer to a new panel with the specified dimensions in pixels and a default quad geometry

func (*Panel) Add

func (p *Panel) Add(ichild IPanel) *Panel

Add adds a child panel to this one This overrides the Node method to enforce that IPanels can only have IPanels as children

func (*Panel) ApplyStyle

func (p *Panel) ApplyStyle(ps *PanelStyle)

ApplyStyle applies the provided PanelStyle to the panel

func (*Panel) Borders

func (p *Panel) Borders() RectBounds

Borders returns this panel current border sizes

func (*Panel) BordersColor4

func (p *Panel) BordersColor4() math32.Color4

BordersColor4 returns current border color

func (*Panel) Bounded

func (p *Panel) Bounded() bool

Bounded returns this panel bounded state

func (*Panel) Color4

func (p *Panel) Color4() math32.Color4

Color4 returns the current color of the panel content area

func (*Panel) ContainsPosition

func (p *Panel) ContainsPosition(x, y float32) bool

ContainsPosition returns indication if this panel contains the specified screen position in pixels.

func (*Panel) ContentCoords

func (p *Panel) ContentCoords(wx, wy float32) (float32, float32)

ContentCoords converts the specified window absolute coordinates in pixels (as informed by OnMouse event) to this panel internal content area pixel coordinates

func (*Panel) ContentHeight

func (p *Panel) ContentHeight() float32

ContentHeight returns the current height of the content area in pixels

func (*Panel) ContentWidth

func (p *Panel) ContentWidth() float32

ContentWidth returns the current width of the content area in pixels

func (*Panel) Enabled

func (p *Panel) Enabled() bool

Enabled returns the current enabled state of this panel

func (*Panel) GetPanel

func (p *Panel) GetPanel() *Panel

GetPanel satisfies the IPanel interface and returns pointer to this panel

func (*Panel) Height

func (p *Panel) Height() float32

Height returns the current panel external height in pixels

func (*Panel) Initialize

func (p *Panel) Initialize(ipan IPanel, width, height float32)

Initialize initializes this panel and is normally used by other types which embed a panel.

func (*Panel) InitializeGraphic

func (p *Panel) InitializeGraphic(width, height float32, gr *graphic.Graphic)

InitializeGraphic initializes this panel with a different graphic

func (*Panel) InsideBorders

func (p *Panel) InsideBorders(x, y float32) bool

InsideBorders returns indication if the specified screen position in pixels is inside the panel borders, including the borders width. Unlike "ContainsPosition" is does not consider the panel margins.

func (*Panel) Intersects

func (p *Panel) Intersects(other *Panel) bool

Intersects returns if this panel intersects with the other panel

func (*Panel) Layout

func (p *Panel) Layout() ILayout

Layout returns this panel current layout

func (*Panel) LayoutParams

func (p *Panel) LayoutParams() interface{}

LayoutParams returns this panel current layout parameters

func (*Panel) Margins

func (p *Panel) Margins() RectBounds

Margins returns the current margin sizes in pixels

func (*Panel) Material

func (p *Panel) Material() *material.Material

Material returns a pointer for this panel's Material

func (*Panel) MinHeight

func (p *Panel) MinHeight() float32

MinHeight returns the minimum height of this panel (ContentHeight = 0)

func (*Panel) MinWidth

func (p *Panel) MinWidth() float32

MinWidth returns the minimum width of this panel (ContentWidth = 0)

func (*Panel) Paddings

func (p *Panel) Paddings() RectBounds

Paddings returns this panel padding sizes in pixels

func (*Panel) Pospix

func (p *Panel) Pospix() math32.Vector3

Pospix returns this panel absolute coordinate in pixels

func (*Panel) Remove

func (p *Panel) Remove(ichild IPanel) bool

Remove removes the specified child from this panel

func (*Panel) RenderSetup

func (p *Panel) RenderSetup(gl *gls.GLS, rinfo *core.RenderInfo)

RenderSetup is called by the Engine before drawing the object

func (*Panel) SetBorders

func (p *Panel) SetBorders(top, right, bottom, left float32)

SetBorders sets this panel border sizes in pixels and recalculates the panel external size

func (*Panel) SetBordersColor

func (p *Panel) SetBordersColor(color *math32.Color)

SetBordersColor sets the color of this panel borders The borders opacity is set to 1.0 (full opaque)

func (*Panel) SetBordersColor4

func (p *Panel) SetBordersColor4(color *math32.Color4)

SetBordersColor4 sets the color and opacity of this panel borders

func (*Panel) SetBordersFrom

func (p *Panel) SetBordersFrom(src *RectBounds)

SetBordersFrom sets this panel border sizes from the specified RectBounds pointer and recalculates the panel size

func (*Panel) SetBounded

func (p *Panel) SetBounded(bounded bool)

SetBounded sets this panel bounded state

func (*Panel) SetColor

func (p *Panel) SetColor(color *math32.Color) *Panel

SetColor sets the color of the panel paddings and content area

func (*Panel) SetColor4

func (p *Panel) SetColor4(color *math32.Color4) *Panel

SetColor4 sets the color of the panel paddings and content area

func (*Panel) SetContentAspectHeight

func (p *Panel) SetContentAspectHeight(height float32)

SetContentAspectHeight sets the height of the content area of the panel to the specified value and adjusts its width to keep the same aspect ratio.

func (*Panel) SetContentAspectWidth

func (p *Panel) SetContentAspectWidth(width float32)

SetContentAspectWidth sets the width of the content area of the panel to the specified value and adjusts its height to keep the same aspect radio.

func (*Panel) SetContentHeight

func (p *Panel) SetContentHeight(height float32)

SetContentHeight sets this panel content height to the specified dimension in pixels. The external size of the panel may increase or decrease to accommodate the new width

func (*Panel) SetContentSize

func (p *Panel) SetContentSize(width, height float32)

SetContentSize sets this panel content size to the specified dimensions. The external size of the panel may increase or decrease to acomodate the new content size.

func (*Panel) SetContentWidth

func (p *Panel) SetContentWidth(width float32)

SetContentWidth sets this panel content width to the specified dimension in pixels. The external size of the panel may increase or decrease to accommodate the new width

func (*Panel) SetEnabled

func (p *Panel) SetEnabled(state bool)

SetEnabled sets the panel enabled state A disabled panel do not process key or mouse events.

func (*Panel) SetHeight

func (p *Panel) SetHeight(height float32)

SetHeight sets this panel external height in pixels. The internal panel areas and positions are recalculated

func (*Panel) SetLayout

func (p *Panel) SetLayout(ilayout ILayout)

SetLayout sets the layout to use to position the children of this panel To remove the layout, call this function passing nil as parameter.

func (*Panel) SetLayoutParams

func (p *Panel) SetLayoutParams(params interface{})

SetLayoutParams sets the layout parameters for this panel

func (*Panel) SetMargins

func (p *Panel) SetMargins(top, right, bottom, left float32)

SetMargins set this panel margin sizes in pixels and recalculates the panel external size

func (*Panel) SetMarginsFrom

func (p *Panel) SetMarginsFrom(src *RectBounds)

SetMarginsFrom sets this panel margins sizes from the specified RectBounds pointer and recalculates the panel external size

func (*Panel) SetModelMatrix

func (p *Panel) SetModelMatrix(gl *gls.GLS, mm *math32.Matrix4)

SetModelMatrix calculates and sets the specified matrix with the model matrix for this panel

func (*Panel) SetPaddings

func (p *Panel) SetPaddings(top, right, bottom, left float32)

SetPaddings sets the panel padding sizes in pixels

func (*Panel) SetPaddingsColor

func (p *Panel) SetPaddingsColor(color *math32.Color)

SetPaddingsColor sets the color of this panel paddings.

func (*Panel) SetPaddingsFrom

func (p *Panel) SetPaddingsFrom(src *RectBounds)

SetPaddingsFrom sets this panel padding sizes from the specified RectBounds pointer and recalculates the panel size

func (*Panel) SetPosition

func (p *Panel) SetPosition(x, y float32)

SetPosition sets this panel absolute position in pixel coordinates from left to right and from top to bottom of the screen.

func (*Panel) SetSize

func (p *Panel) SetSize(width, height float32)

SetSize sets this panel external width and height in pixels.

func (*Panel) SetTopChild

func (p *Panel) SetTopChild(ipan IPanel)

SetTopChild sets the Z coordinate of the specified panel to be on top of all other children of this panel. The function does not check if the specified panel is a child of this one.

func (*Panel) SetWidth

func (p *Panel) SetWidth(width float32)

SetWidth sets this panel external width in pixels. The internal panel areas and positions are recalculated

func (*Panel) SetZLayerDelta

func (p *Panel) SetZLayerDelta(zLayerDelta int)

SetZLayerDelta sets the Z-layer of the panel relative to its parent.

func (*Panel) Size

func (p *Panel) Size() (float32, float32)

Size returns this panel current external width and height in pixels

func (*Panel) UpdateMatrixWorld

func (p *Panel) UpdateMatrixWorld()

UpdateMatrixWorld overrides the standard core.Node version which is called by the Engine before rendering the frame.

func (*Panel) Width

func (p *Panel) Width() float32

Width returns the current panel external width in pixels

func (*Panel) ZLayerDelta

func (p *Panel) ZLayerDelta() int

ZLayerDelta returns the Z-layer of the panel relative to its parent.

type PanelStyle

type PanelStyle struct {
	Margin      RectBounds
	Border      RectBounds
	Padding     RectBounds
	BorderColor math32.Color4
	BgColor     math32.Color4
}

PanelStyle contains all the styling attributes of a Panel.

type Rect

type Rect struct {
	X      float32
	Y      float32
	Width  float32
	Height float32
}

Rect represents a rectangle.

func (*Rect) Contains

func (r *Rect) Contains(x, y float32) bool

Contains determines whether a 2D point is inside the Rect.

type RectBounds

type RectBounds struct {
	Top    float32
	Right  float32
	Bottom float32
	Left   float32
}

RectBounds specifies the size of the boundaries of a rectangle. It can represent the thickness of the borders, the margins, or the padding of a rectangle.

func (*RectBounds) Set

func (bs *RectBounds) Set(top, right, bottom, left float32)

Set sets the values of the RectBounds.

type ScrollBar

type ScrollBar struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

ScrollBar is the scrollbar GUI element.

func NewHScrollBar

func NewHScrollBar(width, height float32) *ScrollBar

NewHScrollBar creates and returns a pointer to a new horizontal scroll bar with the specified dimensions.

func NewVScrollBar

func NewVScrollBar(width, height float32) *ScrollBar

NewVScrollBar creates and returns a pointer to a new vertical scroll bar with the specified dimensions.

func (*ScrollBar) SetButtonSize

func (sb *ScrollBar) SetButtonSize(size float32)

SetButtonSize sets the button size

func (*ScrollBar) SetValue

func (sb *ScrollBar) SetValue(v float32)

SetValue sets the position of the button of the scrollbar from 0.0 (minimum) to 1.0 (maximum).

func (*ScrollBar) Value

func (sb *ScrollBar) Value() float64

Value returns the current position of the button in the scrollbar The returned value is between 0.0 and 1.0

type ScrollBarStyle

type ScrollBarStyle struct {
	PanelStyle
	Button       PanelStyle
	ButtonLength float32 // This is the default/minimum button length

}

ScrollBarStyle contains the styling of a ScrollBar.

type ScrollBarStyles

type ScrollBarStyles struct {
	Normal   ScrollBarStyle
	Over     ScrollBarStyle
	Disabled ScrollBarStyle
}

ScrollBarStyles contains a ScrollBarStyle for each valid GUI state.

type ScrollMode

type ScrollMode int

ScrollMode specifies which scroll directions are allowed.

type ScrollbarInterlocking

type ScrollbarInterlocking int

ScrollbarInterlocking specifies what happens where the vertical and horizontal scrollbars meet.

type ScrollbarPosition

type ScrollbarPosition int

ScrollbarPosition specifies where the scrollbar is located. For the vertical scrollbar it specifies whether it's added to the left or to the right. For the horizontal scrollbar it specifies whether it's added to the top or to the bottom.

type Scroller

type Scroller struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Scroller is the GUI element that allows scrolling of a target IPanel. A scroller can have up to two scrollbars, one vertical and one horizontal. The vertical scrollbar, if any, can be located either on the left or on the right. The horizontal scrollbar, if any, can be located either on the top or on the bottom. The interlocking of the scrollbars (which happens when both scrollbars are visible) can be configured. Whether each scrollbar overlaps the content can also be configured (useful for transparent UIs).

func NewScroller

func NewScroller(width, height float32, mode ScrollMode, target IPanel) *Scroller

NewScroller creates and returns a pointer to a new Scroller with the specified target IPanel and ScrollMode.

func (*Scroller) CornerCovered

func (s *Scroller) CornerCovered() bool

CornerCovered returns whether the corner covering panel is being shown when appropriate

func (*Scroller) HorizontalScrollbarAutoSizeButton

func (s *Scroller) HorizontalScrollbarAutoSizeButton() bool

HorizontalScrollbarAutoSizeButton returns whether the horizontal scrollbar button is sized automatically

func (*Scroller) HorizontalScrollbarBroadness

func (s *Scroller) HorizontalScrollbarBroadness() float32

HorizontalScrollbarBroadness returns the broadness of the horizontal scrollbar

func (*Scroller) HorizontalScrollbarOverlapping

func (s *Scroller) HorizontalScrollbarOverlapping() bool

HorizontalScrollbarOverlapping returns whether the horizontal scrollbar overlaps the content area

func (*Scroller) HorizontalScrollbarPosition

func (s *Scroller) HorizontalScrollbarPosition() ScrollbarPosition

HorizontalScrollbarPosition returns the current position of the horizontal scrollbar (i.e. top or bottom)

func (*Scroller) ScrollMode

func (s *Scroller) ScrollMode() ScrollMode

ScrollMode returns the current scroll mode

func (*Scroller) ScrollTo

func (s *Scroller) ScrollTo(x, y float32)

ScrollTo scrolls the target panel such that the specified target point is centered on the scroller's view area

func (*Scroller) ScrollbarInterlocking

func (s *Scroller) ScrollbarInterlocking() ScrollbarInterlocking

ScrollbarInterlocking returns the current scrollbar interlocking mode

func (*Scroller) SetCornerCovered

func (s *Scroller) SetCornerCovered(state bool)

SetCornerCovered specifies whether the corner covering panel is shown when appropriate

func (*Scroller) SetHorizontalScrollbarAutoSizeButton

func (s *Scroller) SetHorizontalScrollbarAutoSizeButton(state bool)

SetHorizontalScrollbarAutoSizeButton specifies whether the horizontal scrollbar button is sized automatically

func (*Scroller) SetHorizontalScrollbarBroadness

func (s *Scroller) SetHorizontalScrollbarBroadness(broadness float32)

SetHorizontalScrollbarBroadness sets the broadness of the horizontal scrollbar

func (*Scroller) SetHorizontalScrollbarOverlapping

func (s *Scroller) SetHorizontalScrollbarOverlapping(state bool)

SetHorizontalScrollbarOverlapping specifies whether the horizontal scrollbar overlaps the content area

func (*Scroller) SetHorizontalScrollbarPosition

func (s *Scroller) SetHorizontalScrollbarPosition(pos ScrollbarPosition)

SetHorizontalScrollbarPosition sets the position of the horizontal scrollbar (i.e. top or bottom)

func (*Scroller) SetScrollMode

func (s *Scroller) SetScrollMode(mode ScrollMode)

SetScrollMode sets the scroll mode

func (*Scroller) SetScrollbarInterlocking

func (s *Scroller) SetScrollbarInterlocking(interlocking ScrollbarInterlocking)

SetScrollbarInterlocking sets the scrollbar interlocking mode

func (*Scroller) SetVerticalScrollbarAutoSizeButton

func (s *Scroller) SetVerticalScrollbarAutoSizeButton(state bool)

SetVerticalScrollbarAutoSizeButton specifies whether the vertical scrollbar button is sized automatically

func (*Scroller) SetVerticalScrollbarBroadness

func (s *Scroller) SetVerticalScrollbarBroadness(broadness float32)

SetVerticalScrollbarBroadness sets the broadness of the vertical scrollbar

func (*Scroller) SetVerticalScrollbarOverlapping

func (s *Scroller) SetVerticalScrollbarOverlapping(state bool)

SetVerticalScrollbarOverlapping specifies whether the vertical scrollbar overlaps the content area

func (*Scroller) SetVerticalScrollbarPosition

func (s *Scroller) SetVerticalScrollbarPosition(pos ScrollbarPosition)

SetVerticalScrollbarPosition sets the position of the vertical scrollbar (i.e. left or right)

func (*Scroller) Update

func (s *Scroller) Update()

Update updates the visibility of the scrollbars, corner panel, and then recalculates

func (*Scroller) VerticalScrollbarAutoSizeButton

func (s *Scroller) VerticalScrollbarAutoSizeButton() bool

VerticalScrollbarAutoSizeButton returns whether the vertical scrollbar button is sized automatically

func (*Scroller) VerticalScrollbarBroadness

func (s *Scroller) VerticalScrollbarBroadness() float32

VerticalScrollbarBroadness returns the broadness of the vertical scrollbar

func (*Scroller) VerticalScrollbarOverlapping

func (s *Scroller) VerticalScrollbarOverlapping() bool

VerticalScrollbarOverlapping returns whether the vertical scrollbar overlaps the content area

func (*Scroller) VerticalScrollbarPosition

func (s *Scroller) VerticalScrollbarPosition() ScrollbarPosition

VerticalScrollbarPosition returns the current position of the vertical scrollbar (i.e. left or right)

type ScrollerScrollbarStyle

type ScrollerScrollbarStyle struct {
	ScrollBarStyle                   // Embedded ScrollBarStyle (TODO, should be ScrollBarStyle*S*, implement style logic)
	Position       ScrollbarPosition // Specifies the positioning of the scrollbar
	Broadness      float32           // Broadness of the scrollbar
	OverlapContent bool              // Specifies whether the scrollbar is shown above the content area
	AutoSizeButton bool              // Specifies whether the scrollbar button size is adjusted based on content/view proportion
}

ScrollerScrollbarStyle is the set of style options for a scrollbar that is part of a scroller.

type ScrollerStyle

type ScrollerStyle struct {
	PanelStyle                                   // Embedded PanelStyle
	VerticalScrollbar     ScrollerScrollbarStyle // The style of the vertical scrollbar
	HorizontalScrollbar   ScrollerScrollbarStyle // The style of the horizontal scrollbar
	CornerPanel           PanelStyle             // The style of the corner panel
	ScrollbarInterlocking ScrollbarInterlocking  // Specifies what happens where the vertical and horizontal scrollbars meet
	CornerCovered         bool                   // True indicates that the corner panel should be visible when appropriate
}

ScrollerStyle contains the styling of a Scroller

type Slider

type Slider struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Slider is the GUI element for sliders and progress bars

func NewHSlider

func NewHSlider(width, height float32) *Slider

NewHSlider creates and returns a pointer to a new horizontal slider with the specified initial dimensions.

func NewVSlider

func NewVSlider(width, height float32) *Slider

NewVSlider creates and returns a pointer to a new vertical slider with the specified initial dimensions.

func (*Slider) ScaleFactor

func (s *Slider) ScaleFactor() float32

ScaleFactor returns the slider current scale factor (default = 1.0)

func (*Slider) SetScaleFactor

func (s *Slider) SetScaleFactor(factor float32) *Slider

SetScaleFactor set the slider scale factor (default = 1.0)

func (*Slider) SetStyles

func (s *Slider) SetStyles(ss *SliderStyles) *Slider

SetStyles set the slider styles overriding the default style

func (*Slider) SetText

func (s *Slider) SetText(text string) *Slider

SetText sets the text of the slider optional label

func (*Slider) SetValue

func (s *Slider) SetValue(value float32) *Slider

SetValue sets the value of the slider considering the current scale factor and updates its visual appearance.

func (*Slider) Value

func (s *Slider) Value() float32

Value returns the current value of the slider considering the current scale factor

type SliderStyle

type SliderStyle BasicStyle

SliderStyle contains the styling of a Slider

type SliderStyles

type SliderStyles struct {
	Normal   SliderStyle
	Over     SliderStyle
	Focus    SliderStyle
	Disabled SliderStyle
}

SliderStyles contains a SliderStyle for each valid GUI state

type Splitter

type Splitter struct {
	Panel       // Embedded panel
	P0    Panel // Left/Top panel
	P1    Panel // Right/Bottom panel
	// contains filtered or unexported fields
}

Splitter is a GUI element that splits two panels and can be adjusted

func NewHSplitter

func NewHSplitter(width, height float32) *Splitter

NewHSplitter creates and returns a pointer to a new horizontal splitter widget with the specified initial dimensions

func NewVSplitter

func NewVSplitter(width, height float32) *Splitter

NewVSplitter creates and returns a pointer to a new vertical splitter widget with the specified initial dimensions

func (*Splitter) SetSplit

func (s *Splitter) SetSplit(pos float32)

SetSplit sets the position of the splitter bar. It accepts a value from 0.0 to 1.0

func (*Splitter) Split

func (s *Splitter) Split() float32

Split returns the current position of the splitter bar. It returns a value from 0.0 to 1.0

type SplitterStyle

type SplitterStyle struct {
	SpacerBorderColor math32.Color4
	SpacerColor       math32.Color4
	SpacerSize        float32
}

SplitterStyle contains the styling of a Splitter

type SplitterStyles

type SplitterStyles struct {
	Normal SplitterStyle
	Over   SplitterStyle
	Drag   SplitterStyle
}

SplitterStyles contains a SplitterStyle for each valid GUI state

type Style

type Style struct {
	Color         ColorStyle
	Font          *text.Font
	FontIcon      *text.Font
	Label         LabelStyle
	Button        ButtonStyles
	CheckRadio    CheckRadioStyles
	Edit          EditStyles
	ScrollBar     ScrollBarStyles
	Slider        SliderStyles
	Splitter      SplitterStyles
	Window        WindowStyles
	ItemScroller  ItemScrollerStyles
	Scroller      ScrollerStyle
	List          ListStyles
	DropDown      DropDownStyles
	Folder        FolderStyles
	Tree          TreeStyles
	ControlFolder ControlFolderStyles
	Menu          MenuStyles
	Table         TableStyles
	ImageButton   ImageButtonStyles
	TabBar        TabBarStyles
}

Style contains the styles for all GUI elements

func NewDarkStyle

func NewDarkStyle() *Style

NewDarkStyle creates and returns a pointer to the a new "dark" style

func NewLightStyle

func NewLightStyle() *Style

NewLightStyle creates and returns a pointer to the a new "light" style

func StyleDefault

func StyleDefault() *Style

StyleDefault returns a pointer to the current default style

type Tab

type Tab struct {
	// contains filtered or unexported fields
}

Tab describes an individual tab of the TabBar

func (*Tab) Content

func (tab *Tab) Content() IPanel

Content returns a pointer to the specified Tab content panel

func (*Tab) Header

func (tab *Tab) Header() *Panel

Header returns a pointer to this Tab header panel. Can be used to set an event handler when the Tab header is right clicked. (to show a context Menu for example).

func (*Tab) Pinned

func (tab *Tab) Pinned() bool

Pinned returns this tab pinned state

func (*Tab) SetContent

func (tab *Tab) SetContent(ipan IPanel)

SetContent sets or replaces this tab content panel.

func (*Tab) SetIcon

func (tab *Tab) SetIcon(icon string) *Tab

SetIcon sets the optional icon of the Tab header

func (*Tab) SetImage

func (tab *Tab) SetImage(imgfile string) error

SetImage sets the optional image of the Tab header

func (*Tab) SetPinned

func (tab *Tab) SetPinned(pinned bool)

SetPinned sets the tab pinned state. A pinned tab cannot be removed by the user because the close icon is not shown.

func (*Tab) SetText

func (tab *Tab) SetText(text string) *Tab

SetText sets the text of the tab header

type TabBar

type TabBar struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

TabBar is a panel which can contain other panels arranged in horizontal Tabs. Only one panel is visible at a time. To show another panel the corresponding Tab must be selected.

func NewTabBar

func NewTabBar(width, height float32) *TabBar

NewTabBar creates and returns a pointer to a new TabBar widget with the specified width and height

func (*TabBar) AddTab

func (tb *TabBar) AddTab(text string) *Tab

AddTab creates and adds a new Tab panel with the specified header text at the end of this TabBar list of tabs. Returns the pointer to thew new Tab.

func (*TabBar) InsertTab

func (tb *TabBar) InsertTab(text string, pos int) *Tab

InsertTab creates and inserts a new Tab panel with the specified header text at the specified position in the TabBar from left to right. Returns the pointer to the new Tab or nil if the position is invalid.

func (*TabBar) MoveTab

func (tb *TabBar) MoveTab(src, dest int) error

MoveTab moves a Tab to another position in the Tabs list

func (*TabBar) RemoveTab

func (tb *TabBar) RemoveTab(pos int) error

RemoveTab removes the tab at the specified position in the TabBar. Returns an error if the position is invalid.

func (*TabBar) Selected

func (tb *TabBar) Selected() int

Selected returns the position of the selected Tab. Returns value < 0 if there is no selected Tab.

func (*TabBar) SetSelected

func (tb *TabBar) SetSelected(pos int) *Tab

SetSelected sets the selected tab of the TabBar to the tab with the specified position. Returns the pointer of the selected tab or nil if the position is invalid.

func (*TabBar) TabAt

func (tb *TabBar) TabAt(pos int) *Tab

TabAt returns the pointer of the Tab object at the specified position. Return nil if the position is invalid

func (*TabBar) TabCount

func (tb *TabBar) TabCount() int

TabCount returns the current number of Tabs in the TabBar

func (*TabBar) TabPosition

func (tb *TabBar) TabPosition(tab *Tab) int

TabPosition returns the position of the Tab specified by its pointer

type TabBarStyle

type TabBarStyle BasicStyle

TabBarStyle describes the style of the TabBar

type TabBarStyles

type TabBarStyles struct {
	SepHeight          float32     // Separator width
	ListButtonIcon     string      // Icon for list button
	ListButtonPaddings RectBounds  // Paddings for list button
	Normal             TabBarStyle // Style for normal exhibition
	Over               TabBarStyle // Style when cursor is over the TabBar
	Focus              TabBarStyle // Style when the TabBar has key focus
	Disabled           TabBarStyle // Style when the TabBar is disabled
	Tab                TabStyles   // Style for Tabs
}

TabBarStyles describes all the TabBarStyles

type TabStyle

type TabStyle BasicStyle

TabStyle describes the style of the individual Tabs header

type TabStyles

type TabStyles struct {
	IconPaddings  RectBounds // Paddings for optional icon
	ImagePaddings RectBounds // Paddings for optional image
	IconClose     string     // Codepoint for close icon in Tab header
	Normal        TabStyle   // Style for normal exhibition
	Over          TabStyle   // Style when cursor is over the Tab
	Focus         TabStyle   // Style when the Tab has key focus
	Disabled      TabStyle   // Style when the Tab is disabled
	Selected      TabStyle   // Style when the Tab is selected
}

TabStyles describes all Tab styles

type Table

type Table struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

Table implements a panel which can contains child panels organized in rows and columns.

func NewTable

func NewTable(width, height float32, cols []TableColumn) (*Table, error)

NewTable creates and returns a pointer to a new Table with the specified width, height and columns

func (*Table) AddRow

func (t *Table) AddRow(values map[string]interface{})

AddRow adds a new row at the end of the table with the specified values

func (*Table) Cell

func (t *Table) Cell(col string, ri int) interface{}

Cell returns the current content of the specified cell

func (*Table) Clear

func (t *Table) Clear()

Clear removes all rows from the table

func (*Table) EnableColResize

func (t *Table) EnableColResize(colid string, enable bool)

EnableColResize enable or disables if the specified column can be resized by the user using the mouse.

func (*Table) InsertRow

func (t *Table) InsertRow(row int, values map[string]interface{})

InsertRow inserts the specified values in a new row at the specified index

func (*Table) RemoveRow

func (t *Table) RemoveRow(row int)

RemoveRow removes from the specified row from the table

func (*Table) Row

func (t *Table) Row(ri int) map[string]interface{}

Row returns a map with the current contents of the specified row index

func (*Table) RowCount

func (t *Table) RowCount() int

RowCount returns the current number of rows in the table

func (*Table) Rows

func (t *Table) Rows(fi, li int) []map[string]interface{}

Rows returns a slice of maps with the contents of the table rows specified by the rows first and last index. To get all the table rows, use Rows(0, -1)

func (*Table) SelectedRows

func (t *Table) SelectedRows() []int

SelectedRows returns a slice with the indexes of the currently selected rows If no row are selected returns an empty slice

func (*Table) SetCell

func (t *Table) SetCell(row int, colid string, value interface{})

SetCell sets the value of the cell specified by its row and column id The function panics if the passed row or column id is invalid

func (*Table) SetColExpand

func (t *Table) SetColExpand(colid string, expand float32)

SetColExpand sets the column expand factor. When the table width is increased the columns widths are increased proportionally to their expand factor. A column with expand factor = 0 is not increased.

func (*Table) SetColFormat

func (t *Table) SetColFormat(id, format string)

SetColFormat sets the formatting string (Printf) for the specified column Update must be called to update the table.

func (*Table) SetColOrder

func (t *Table) SetColOrder(colid string, order int)

SetColOrder sets the exhibition order of the specified column. The previous column which has the specified order will have the original column order.

func (*Table) SetColWidth

func (t *Table) SetColWidth(colid string, width float32)

SetColWidth sets the specified column width and may change the widths of the columns to the right

func (*Table) SetRow

func (t *Table) SetRow(row int, values map[string]interface{})

SetRow sets the value of all the cells of the specified row from the specified map indexed by column id.

func (*Table) SetRows

func (t *Table) SetRows(values []map[string]interface{})

SetRows clears all current rows of the table and sets new rows from the specifying parameter. Each row is a map keyed by the colum id. The map value currently can be a string or any number type If a row column is not found it is ignored

func (*Table) SetSelectionType

func (t *Table) SetSelectionType(sel TableSelType)

SetSelectionType sets this table selection type Possible values are: TableSelSingleRow|TableSelMultiRow

func (*Table) SetStatusText

func (t *Table) SetStatusText(text string)

SetStatusText sets the text of status line at the bottom of the table It does not change its current visibility

func (*Table) SetStyles

func (t *Table) SetStyles(ts *TableStyles)

SetStyles set this table styles overriding the default

func (*Table) ShowAllColumns

func (t *Table) ShowAllColumns()

ShowAllColumns shows all the table columns

func (*Table) ShowColumn

func (t *Table) ShowColumn(col string, show bool)

ShowColumn sets the visibility of the column with the specified id If the column id does not exit the function panics.

func (*Table) ShowHeader

func (t *Table) ShowHeader(show bool)

ShowHeader shows or hides the table header

func (*Table) ShowStatus

func (t *Table) ShowStatus(show bool)

ShowStatus sets the visibility of the status lines at the bottom of the table

func (*Table) SortColumn

func (t *Table) SortColumn(col string, asString bool, asc bool)

SortColumn sorts the specified column interpreting its values as strings or numbers and sorting in ascending or descending order. This sorting is independent of the sort configuration of column set when the table was created

type TableCell

type TableCell struct {
	Tab   *Table      // Pointer to table
	Row   int         // Row index
	Col   string      // Column id
	Value interface{} // Cell value
}

TableCell describes a table cell. It is used as a parameter for formatting function

type TableClickEvent

type TableClickEvent struct {
	window.MouseEvent         // Embedded window mouse event
	X                 float32 // Table content area X coordinate
	Y                 float32 // Table content area Y coordinate
	Header            bool    // True if header was clicked
	Row               int     // Index of table row (may be -1)
	Col               string  // Id of table column (may be empty)
	ColOrder          int     // Current column exhibition order
}

TableClickEvent describes a mouse click event over a table It contains the original mouse event plus additional information

type TableColumn

type TableColumn struct {
	Id         string          // Column id used to reference the column. Must be unique
	Header     string          // Column name shown in the table header
	Width      float32         // Initial column width in pixels
	Minwidth   float32         // Minimum width in pixels for this column
	Hidden     bool            // Hidden flag
	Align      Align           // Cell content alignment: AlignLeft|AlignCenter|AlignRight
	Format     string          // Format string for formatting the columns' cells
	FormatFunc TableFormatFunc // Format function (overrides Format string)
	Expand     float32         // Column width expansion factor (0 for no expansion)
	Sort       TableSortType   // Column sort type
	Resize     bool            // Allow column to be resized by user
}

TableColumn describes a table column

type TableFormatFunc

type TableFormatFunc func(cell TableCell) string

TableFormatFunc is the type for formatting functions

type TableHeaderStyle

type TableHeaderStyle BasicStyle

TableHeaderStyle describes the style of the table header

type TableResizerStyle

type TableResizerStyle struct {
	Width       float32
	Border      RectBounds
	BorderColor math32.Color4
	BgColor     math32.Color4
}

TableResizerStyle describes the style of the table resizer panel

type TableRowStyle

type TableRowStyle BasicStyle

TableRowStyle describes the style of the table row

type TableSelType

type TableSelType int

TableSelType is the type used to specify the table row selection

const (
	// TableSelSingleRow is the single row selection mode (default)
	TableSelSingleRow TableSelType = iota
	// TableSelMultiRow is the multiple row selection mode
	TableSelMultiRow
)

type TableSortType

type TableSortType int

TableSortType is the type used to specify the sort method for a table column

const (
	TableSortNone TableSortType = iota
	TableSortString
	TableSortNumber
)

The various sorting types

type TableStatusStyle

type TableStatusStyle BasicStyle

TableStatusStyle describes the style of the table status line panel

type TableStyles

type TableStyles struct {
	Header    TableHeaderStyle
	RowEven   TableRowStyle
	RowOdd    TableRowStyle
	RowCursor TableRowStyle
	RowSel    TableRowStyle
	Status    TableStatusStyle
	Resizer   TableResizerStyle
}

TableStyles describes all styles of the table header and rows

type Tree

type Tree struct {
	List // Embedded list panel
	// contains filtered or unexported fields
}

Tree is the tree structure GUI element.

func NewTree

func NewTree(width, height float32) *Tree

NewTree creates and returns a pointer to a new tree widget.

func (*Tree) Add

func (t *Tree) Add(ichild IPanel)

Add child panel to the end tree.

func (*Tree) AddNode

func (t *Tree) AddNode(text string) *TreeNode

AddNode adds a new tree node with the specified text at the end of this tree and returns a pointer to the new node.

func (*Tree) FindChild

func (t *Tree) FindChild(child IPanel) (*TreeNode, int)

FindChild searches for the specified child in the tree and all its children. If found, returns the parent node and its position relative to the parent. If the parent is the tree returns nil as the parent If not found returns nil and -1

func (*Tree) Initialize

func (t *Tree) Initialize(width, height float32)

Initialize initializes the tree with the specified initial width and height It is normally used when the folder is embedded in another object.

func (*Tree) InsertAt

func (t *Tree) InsertAt(pos int, child IPanel)

InsertAt inserts a child panel at the specified position in the tree.

func (*Tree) InsertNodeAt

func (t *Tree) InsertNodeAt(pos int, text string) *TreeNode

InsertNodeAt inserts at the specified position a new tree node with the specified text at the end of this tree and returns pointer to the new node.

func (*Tree) Remove

func (t *Tree) Remove(child IPanel)

Remove removes the specified child from the tree or any of its children nodes.

func (*Tree) Selected

func (t *Tree) Selected() IPanel

Selected returns the currently selected element or nil

func (*Tree) SetStyles

func (t *Tree) SetStyles(s *TreeStyles)

SetStyles sets the tree styles overriding the default style.

type TreeNode

type TreeNode struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

TreeNode is a tree node.

func (*TreeNode) Add

func (n *TreeNode) Add(child IPanel)

Add adds a child panel to this node

func (*TreeNode) AddNode

func (n *TreeNode) AddNode(text string) *TreeNode

AddNode adds a new node to this one and return its pointer

func (*TreeNode) FindChild

func (n *TreeNode) FindChild(child IPanel) (*TreeNode, int)

FindChild searches for the specified child in this node and all its children. If found, returns the parent node and its position relative to the parent. If not found returns nil and -1

func (*TreeNode) InsertAt

func (n *TreeNode) InsertAt(pos int, child IPanel)

InsertAt inserts a child panel at the specified position in this node If the position is invalid, the function panics

func (*TreeNode) InsertNodeAt

func (n *TreeNode) InsertNodeAt(pos int, text string) *TreeNode

InsertNodeAt inserts a new node at the specified position in this node If the position is invalid, the function panics

func (*TreeNode) Len

func (n *TreeNode) Len() int

Len returns the number of immediate children of this node

func (*TreeNode) Remove

func (n *TreeNode) Remove(child IPanel)

Remove removes the specified child from this node or any of its children nodes

func (*TreeNode) SetExpanded

func (n *TreeNode) SetExpanded(state bool)

SetExpanded sets the expanded state of this node

type TreeNodeStyle

type TreeNodeStyle struct {
	PanelStyle
	FgColor math32.Color4
	Icons   [2]string
}

TreeNodeStyle contains the styling of a TreeNode.

type TreeNodeStyles

type TreeNodeStyles struct {
	Normal TreeNodeStyle
}

TreeNodeStyles contains a TreeNodeStyle for each valid GUI state.

type TreeStyles

type TreeStyles struct {
	List     *ListStyles     // Styles for the embedded list
	Node     *TreeNodeStyles // Styles for the node panel
	Padlevel float32         // Left padding indentation
}

TreeStyles contains the styling of all tree components for each valid GUI state.

type VBoxLayout

type VBoxLayout struct {
	// contains filtered or unexported fields
}

VBoxLayout implements a panel layout which arranges the panel children vertically. The children can be separated by a space in pixels set by SetSpacing(). The whole group of children can be aligned vertically by SetAlignV() which can accept the following types of alignment:

AlignTop: Try to align the group of children to the top if the panel height is
greater the the sum of the children heights + spacing.

AlignBottom: Try to align the group of children to the bottoom if the panel height is
greater the the sum of the children heights + spacing.

AlignCenter: Try to align the group of children in the center if the panel height is
greater the the sum of the children heights + spacing.

AlignHeight: Try to align the individual children vertically with the same same space between each other.
Each individual child can be aligned horizontally by SetLayoutParameters()

If the layout method SetAutoHeight(true) is called, the panel minimum content height will be the sum of its children's heights plus the spacing.

If the layout method SetAutoWidth(true) is called, the panel minimum content width will be the width of the widest child.

func NewVBoxLayout

func NewVBoxLayout() *VBoxLayout

NewVBoxLayout creates and returns a pointer to a new horizontal box layout

func (*VBoxLayout) Recalc

func (bl *VBoxLayout) Recalc(ipan IPanel)

Recalc recalculates and sets the position and sizes of all children

func (*VBoxLayout) SetAlignV

func (bl *VBoxLayout) SetAlignV(align Align)

SetAlignV sets the vertical alignment of the whole group of items inside the parent panel and updates the layout if possible. This only has any effect if there are no expanded items.

func (*VBoxLayout) SetAutoHeight

func (bl *VBoxLayout) SetAutoHeight(state bool)

SetAutoHeight sets if the panel minimum height should be the height of the largest of its children's height.

func (*VBoxLayout) SetAutoWidth

func (bl *VBoxLayout) SetAutoWidth(state bool)

SetAutoWidth sets if the panel minimum width should be sum of its children's width plus the spacing

func (*VBoxLayout) SetSpacing

func (bl *VBoxLayout) SetSpacing(spacing float32)

SetSpacing sets the horizontal spacing between the items in pixels and updates the layout if possible

type VBoxLayoutParams

type VBoxLayoutParams struct {
	Expand float32 // item expand vertically factor (0 - no expand)
	AlignH Align   // item horizontal alignment
}

VBoxLayoutParams specify the horizontal alignment of each individual child.

type Window

type Window struct {
	Panel // Embedded Panel
	// contains filtered or unexported fields
}

Window represents a window GUI element

func NewWindow

func NewWindow(width, height float32) *Window

NewWindow creates and returns a pointer to a new window with the specified dimensions

func (*Window) Add

func (w *Window) Add(ichild IPanel) *Window

Add adds a child panel to the client area of this window

func (*Window) SetCloseButton

func (w *Window) SetCloseButton(state bool)

SetCloseButton sets whether the window has a close button on the top right.

func (*Window) SetLayout

func (w *Window) SetLayout(layout ILayout)

SetLayout sets the layout of the client panel.

func (*Window) SetResizable

func (w *Window) SetResizable(state bool)

SetResizable sets whether the window is resizable.

func (*Window) SetTitle

func (w *Window) SetTitle(text string)

SetTitle sets the title of the window.

type WindowStyle

type WindowStyle struct {
	PanelStyle
	TitleStyle WindowTitleStyle
}

WindowStyle contains the styling of a Window

type WindowStyles

type WindowStyles struct {
	Normal   WindowStyle
	Over     WindowStyle
	Focus    WindowStyle
	Disabled WindowStyle
}

WindowStyles contains a WindowStyle for each valid GUI state

type WindowTitle

type WindowTitle struct {
	Panel // Embedded panel
	// contains filtered or unexported fields
}

WindowTitle represents the title bar of a Window

type WindowTitleStyle

type WindowTitleStyle struct {
	PanelStyle
	FgColor math32.Color4
}

WindowTitleStyle contains the styling for a window title.

Directories

Path Synopsis
Code generated by go-bindata.
Code generated by go-bindata.

Jump to

Keyboard shortcuts

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