package
0.2.0
Repository: https://github.com/g3n/engine.git
Documentation: pkg.go.dev

# Packages

Code generated by go-bindata.

# Functions

AttribCheckAlign checks and converts layout align* attribute.
AttribCheckBool checks and convert attribute to bool.
AttribCheckBorderSizes checks and convert attribute with border sizes.
AttribCheckColor checks and converts attribute with color name or color component values.
AttribCheckEdge checks and converts attribute with name of layout edge.
AttribCheckFloat checks and convert attribute to float32.
AttribCheckIcons checks and converts attribute with a list of icon names or codepoints.
AttribCheckInt checks and convert attribute to int.
AttribCheckInterface accepts any attribute value.
AttribCheckLayout checks and converts layout attribute.
AttribCheckListMap checks and converts attribute to []map[string]interface{}.
AttribCheckMap checks and converts attribute to map[string]interface{}.
AttribCheckMenuShortcut checks and converts attribute describing menu shortcut key.
AttribCheckPosition checks and convert attribute with x and y position.
AttribCheckResizeBorders checks and converts attribute with list of window resizable borders.
AttribCheckString checks and convert attribute to string.
AttribCheckStringLower checks and convert string attribute to lower case.
AttribCheckTableSortType checks and converts attribute table column sort type.
Manager returns the GUI manager singleton (creating it the first time).
NewBuilder creates and returns a pointer to a new gui Builder object.
NewButton creates and returns a pointer to a new button widget with the specified text for the button label.
NewChart creates and returns a new chart panel with the specified dimensions in pixels.
NewCheckBox creates and returns a pointer to a new CheckBox widget with the specified text.
NewControlFolder creates and returns a pointer to a new control folder widget with the specified text and initial width.
NewDarkStyle creates and returns a pointer to the a new "dark" style.
NewDockLayout returns a pointer to a new DockLayout.
NewDropDown creates and returns a pointer to a new drop down widget with the specified width.
NewEdit creates and returns a pointer to a new edit widget.
NewFillLayout creates and returns a pointer of a new fill layout.
NewFolder creates and returns a pointer to a new folder widget with the specified text and initial width.
NewGridLayout creates and returns a pointer of a new grid layout.
NewHBoxLayout creates and returns a pointer to a new horizontal box layout.
NewHList creates and returns a pointer to a new horizontal list panel with the specified dimensions.
NewHScrollBar creates and returns a pointer to a new horizontal scroll bar with the specified dimensions.
NewHScroller creates and returns a pointer to a new horizontal scroller panel with the specified dimensions.
NewHSlider creates and returns a pointer to a new horizontal slider with the specified initial dimensions.
NewHSplitter creates and returns a pointer to a new horizontal splitter widget with the specified initial dimensions.
NewIcon creates and returns a label panel with the specified text drawn using the default icon font.
NewImage creates and returns an image panel with the image from the specified image used as a texture.
NewImageButton creates and returns a pointer to a new ImageButton widget with the specified image.
NewImageFromRGBA creates and returns an image panel from the specified image.
NewImageFromTex creates and returns an image panel from the specified texture2D.
NewImageLabel creates and returns a pointer to a new image label widget with the specified text for the label and no image/icon.
NewLabel creates and returns a label panel with the specified text drawn using the default text font.
NewLabelWithFont creates and returns a label panel with the specified text drawn using the specified font.
NewLightStyle creates and returns a pointer to the a new "light" style.
NewMenu creates and returns a pointer to a new empty vertical menu.
NewMenuBar creates and returns a pointer to a new empty menu bar.
NewPanel creates and returns a pointer to a new panel with the specified dimensions in pixels and a default quad geometry.
NewRadioButton creates and returns a pointer to a new RadioButton widget with the specified text.
NewScroller creates and returns a pointer to a new Scroller with the specified target IPanel and ScrollMode.
NewTabBar creates and returns a pointer to a new TabBar widget with the specified width and height.
NewTable creates and returns a pointer to a new Table with the specified width, height and columns.
NewTree creates and returns a pointer to a new tree widget.
NewVBoxLayout creates and returns a pointer to a new horizontal box layout.
NewVList creates and returns a pointer to a new vertical list panel with the specified dimensions.
NewVScrollBar creates and returns a pointer to a new vertical scroll bar with the specified dimensions.
NewVScroller creates and returns a pointer to a new vertical scroller panel with the specified dimensions.
NewVSlider creates and returns a pointer to a new vertical slider with the specified initial dimensions.
NewVSplitter creates and returns a pointer to a new vertical splitter widget with the specified initial dimensions.
NewWindow creates and returns a pointer to a new window with the specified dimensions.
SetStyleDefault sets the default style.
StyleDefault returns a pointer to the current default style.

# Constants

Align vertically at the cnter.
Align horizontally/vertically at the center.
Align vertically using all height.
Align horizontally at left.
No alignment.
Align horizontally at right.
Align vertically at the top.
Align horizontally using all width.
Align.
Align.
float32.
float32.
bool.
bool.
Color4.
Color4.
RectBounds.
bool.
Color4.
int GridLayout.
int GridLayout.
[]map[string]interface{} Table.
map[string]interface{} Table.
float32.
int.
bool.
float32.
bool.
bool.
float32.
Color4.
float32.
float32.
string.
string.
string.
float32.
bool Table.
string.
string.
string.
[]map[string]interface{}.
[]map[string]interface{}.
map[string]interface{}.
map[string]interface{}.
int.
float32.
float32.
RectBounds.
float32 Table.
string.
RectBounds.
map[string]interface{}.
map[string]interface{}.
string (internal attribute).
bool.
string.
[]float32.
bool.
float32.
float32.
bool.
bool Table.
Resizable.
float32.
map[string]interface{}.
map[string]interface{}.
[]int.
bool.
TableSortType Table.
float32.
float32.
float32.
string.
string.
string.
interface{}.
float32.
bool.
float32.
The possible button states.
The possible button states.
The possible button states.
The possible button states.
The different types of docking.
The different types of docking.
The different types of docking.
The different types of docking.
The different types of docking.
IgnoreSuffix specifies the suffix of ignored keys.
Value was changed.
A unicode key is pressed.
Widget clicked by mouse left button or via key press.
Cursor is over the panel.
Cursor entered the panel or a descendant.
Cursor left the panel or a descendant.
Panel enabled/disabled (no parameters).
All keyboard events will be exclusively sent to the receiving IDispatcher.
Keyboard events will stop being sent to the receiving IDispatcher.
A key is pressed.
A key was pressed and is now automatically repeating.
A key is released.
OnListItemResize is the identifier of the event dispatched when a ListItem's child panel is resized.
Any mouse button is pressed.
Any mouse button is pressed.
Any mouse button is released.
Any mouse button is released.
Radio button within a group changed state.
Panel size changed (no parameters).
Scrolling mouse wheel.
OnTableClick is the event generated when the table is right or left clicked Parameter is TableClickEvent.
OnTableRowCount is the event generated when the table row count changes (no parameters).
Scrollbar is positioned on the bottom of the scroller.
Horizontal scrollbar takes precedence.
No scrollbar interlocking.
Vertical scrollbar takes precedence.
Scrollbar is positioned on the left of the scroller.
Scrollbar is positioned on the right of the scroller.
Scrollbar is positioned on the top of the scroller.
Both vertical and horizontal scrolling allowed.
Horizontal scrolling allowed.
ScrollModifierKey is the ModifierKey that changes the scrolling direction from vertical to horizontal when pressed.
No scrolling allowed.
Vertical scrolling allowed.
States that a GUI element can be in.
States that a GUI element can be in.
States that a GUI element can be in.
States that a GUI element can be in.
States that a GUI element can be in.
TableSelMultiRow is the multiple row selection mode.
TableSelSingleRow is the single row selection mode (default).
The various sorting types.
The various sorting types.
The various sorting types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.
Panel and layout types.

# Structs

BasicStyle extends PanelStyle by adding a foreground color.
Builder builds GUI objects from a declarative description in YAML format.
BuilderLayoutDock is builder for Dock layout .
BuilderLayoutGrid is builder for Grid layout .
BuilderLayoutHBox is builder for HBox layout .
BuilderLayoutVBox is builder for VBox layout .
Button represents a button GUI element.
ButtonStyles contains one ButtonStyle for each possible button state.
Chart implements a panel which can contain a title, an x scale, an y scale and several graphs .
CheckRadio is a GUI element that can be either a checkbox or a radio button.
CheckRadioStyles contains an CheckRadioStyle for each valid GUI state.
ColorStyle defines the main colors used.
ControlFolder represents a folder with controls.
ControlFolderGroup represents a group of controls in the control folder.
ControlFolderStyles contains the styling for the valid GUI states of the components of a ControlFolder.
DockLayout is the layout for docking panels to the internal edges of their parent.
DockLayoutParams specifies the edge to dock to.
DropDown represents a dropdown GUI element.
DropDownStyles contains a DropDownStyle for each valid GUI state.
Edit represents a text edit box GUI element.
EditStyle contains the styling of an Edit.
EditStyles contains an EditStyle for each valid GUI state.
FillLayout is the simple layout where the assigned panel "fills" its parent in the specified dimension(s).
Folder represents a folder GUI element.
FolderStyle contains the styling of a Folder.
FolderStyles contains a FolderStyle for each valid GUI state.
Graph is the GUI element that represents a single plotted function.
GridLayout is a panel layout which arranges its children in a rectangular grid.
GridLayoutParams describes layout parameter for an specific child.
HBoxLayout implements a panel layout which arranges the panel children horizontally.
HBoxLayoutParams specify the vertical alignment of each individual child.
Image is a Panel which contains a single Image.
ImageButton represents an image button GUI element.
ImageButtonStyles contains one ImageButtonStyle for each possible ImageButton state.
ImageLabel is a panel which can contain an Image or Icon plus a Label side by side.
ItemScroller is the GUI element that allows scrolling of IPanels.
ItemScrollerStyles contains a ItemScrollerStyle for each valid GUI state.
Label is a panel which contains a texture with text.
LabelStyle contains all the styling attributes of a Label.
List represents a list GUI element.
ListItem encapsulates each item inserted into the list.
ListItemStyles contains one ListItemStyle for each possible item state.
ListStyles encapsulates a set of styles for the list and item.
Menu is the menu GUI element.
MenuBodyStyles describes all styles of the menu body.
MenuItem is an option of a Menu.
MenuItemStyle describes the style of a menu item.
MenuItemStyles describes all the menu item styles.
MenuStyles describes all styles of the menu body and menu item.
Panel is 2D rectangular graphic which by default has a quad (2 triangles) geometry.
PanelStyle contains all the styling attributes of a Panel.
Rect represents a rectangle.
RectBounds specifies the size of the boundaries of a rectangle.
ScrollBar is the scrollbar GUI element.
ScrollBarStyle contains the styling of a ScrollBar.
ScrollBarStyles contains a ScrollBarStyle for each valid GUI state.
Scroller is the GUI element that allows scrolling of a target IPanel.
ScrollerScrollbarStyle is the set of style options for a scrollbar that is part of a scroller.
ScrollerStyle contains the styling of a Scroller.
Slider is the GUI element for sliders and progress bars.
SliderStyles contains a SliderStyle for each valid GUI state.
Splitter is a GUI element that splits two panels and can be adjusted.
SplitterStyle contains the styling of a Splitter.
SplitterStyles contains a SplitterStyle for each valid GUI state.
Style contains the styles for all GUI elements.
Tab describes an individual tab of the TabBar .
TabBar is a panel which can contain other panels arranged in horizontal Tabs.
TabBarStyles describes all the TabBarStyles.
Table implements a panel which can contains child panels organized in rows and columns.
TableCell describes a table cell.
TableClickEvent describes a mouse click event over a table It contains the original mouse event plus additional information.
TableColumn describes a table column.
TableResizerStyle describes the style of the table resizer panel.
TableStyles describes all styles of the table header and rows.
TabStyles describes all Tab styles.
Tree is the tree structure GUI element.
TreeNode is a tree node.
TreeNodeStyle contains the styling of a TreeNode.
TreeNodeStyles contains a TreeNodeStyle for each valid GUI state.
TreeStyles contains the styling of all tree components for each valid GUI state.
VBoxLayout implements a panel layout which arranges the panel children vertically.
VBoxLayoutParams specify the horizontal alignment of each individual child.
Window represents a window GUI element.
WindowStyle contains the styling of a Window.
WindowStyles contains a WindowStyle for each valid GUI state.
WindowTitle represents the title bar of a Window.
WindowTitleStyle contains the styling for a window title.

# Interfaces

IBuilderLayout is the interface for all layout builders.
ILayout is the interface for layouts.
IPanel is the interface for all panel types.

# Type aliases

Align specifies the alignment of an object inside another.
AttribCheckFunc is the type for all attribute check functions.
BuilderFunc is type for functions which build a gui object from an attribute map.
ButtonState specifies a button state.
ButtonStyle contains the styling of a Button.
CheckRadioStyle contains the styling of a CheckRadio.
DropDownStyle contains the styling of a DropDown.
ImageButtonStyle contains the styling of an ImageButton.
ImageLabelStyle contains the styling of an ImageLabel.
ItemScrollerStyle contains the styling of a ItemScroller.
ListItemStyle contains the styling of a list item.
MenuBodyStyle describes the style of the menu body.
ScrollbarInterlocking specifies what happens where the vertical and horizontal scrollbars meet.
ScrollbarPosition specifies where the scrollbar is located.
ScrollMode specifies which scroll directions are allowed.
SliderStyle contains the styling of a Slider.
TabBarStyle describes the style of the TabBar.
TableFormatFunc is the type for formatting functions.
TableHeaderStyle describes the style of the table header.
TableRowStyle describes the style of the table row.
TableSelType is the type used to specify the table row selection.
TableSortType is the type used to specify the sort method for a table column.
TableStatusStyle describes the style of the table status line panel.
TabStyle describes the style of the individual Tabs header.