GearBlocks
The GearBlocks Lua scripting API
Public Member Functions | List of all members
SmashHammer.UI.Window Class Reference

A UI window. More...

Inheritance diagram for SmashHammer.UI.Window:
SmashHammer.UI.Showable SmashHammer.UI.IWindow SmashHammer.UI.IElementFactory SmashHammer.UI.ISizeable SmashHammer.UI.IShowable

Public Member Functions

void BringToFront ()
 Bring the window in front of other windows.
 
- Public Member Functions inherited from SmashHammer.UI.Showable
virtual void Show (bool show)
 Show or hide the showable.
 
void Show (bool show)
 Show or hide the showable.
 
void BringToFront ()
 Bring the window in front of other windows.
 
IElement CreateHorizontalScrollView ()
 Create a horizontal ScrollView element.
 
IElement CreateVerticalScrollView ()
 Create a vertical ScrollView element.
 
IElement CreateLabel ()
 Create a Label element.
 
IElement CreateImage ()
 Create an Image element.
 
IElement CreateTextButton ()
 Create a ButtonText element.
 
IElement CreateImageButton ()
 Create a ButtonImage element.
 
IElement CreateSlider ()
 Create a Slider element.
 
IElement CreateInputField ()
 Create an InputField element.
 
IElement CreateNumberField ()
 Create an NumberField element.
 
IElement CreateDropdown ()
 Create a Dropdown element.
 
IElement CreateLabelledToggle ()
 Create a LabelledToggle element.
 
IElement CreateLabelledSlider ()
 Create a LabelledSlider element.
 
IElement CreateLabelledInputField ()
 Create a LabelledInputField element.
 
IElement CreateLabelledNumberField ()
 Create a LabelledNumberField element.
 
IElement CreateLabelledDropdown ()
 Create a LabelledDropdown element.
 
IElement CreateShapes ()
 Create a Shapes element.
 
IElement CreateTimeSeriesGraph ()
 Create a TimeSeriesGraph element.
 
void DestroyElement (IElement element)
 Destroy a previously created UI element.
 
void SetAlignment (Align align, float paramA, float paramB)
 Set the element's alignment.
 

Additional Inherited Members

- Public Types inherited from SmashHammer.UI.ISizeable
enum  Align : byte {
  LeftEdge , RightEdge , TopEdge , BottomEdge ,
  HorizEdges , VertEdges , HorizCentre , VertCentre
}
 UI element alignment mode. More...
 
- Properties inherited from SmashHammer.UI.Showable
virtual bool IsShowing [get]
 Is the showable showing?
 
float ScaleFactor [get]
 The size of this showable (and it's contents) is multiplied by this factor to get the actual on screen pixel size.
 
- Properties inherited from SmashHammer.UI.IShowable
bool IsShowing [get]
 Is the showable showing?
 
float ScaleFactor [get]
 The size of this showable (and it's contents) is multiplied by this factor to get the actual on screen pixel size.
 
- Properties inherited from SmashHammer.UI.IWindow
bool IsMovable [get, set]
 Is the window movable?
 
bool IsResizable [get, set]
 Is the window resizable?
 
float MinResizeWidth [get, set]
 Minimum resize width of the window.
 
float MinResizeHeight [get, set]
 Minimum resize height of the window.
 
bool IsCollapsible [get, set]
 Is the window collapsible?
 
bool IsCloseable [get, set]
 Is the window closeable?
 
string Title [get, set]
 The window title.
 
bool IsCollapsed [get, set]
 Is the window collapsed?
 
RectProxy ContentRect [get]
 The calculated rect of the window content area.
 
- Events inherited from SmashHammer.UI.IWindow
ValueChangedHandler OnClose
 Event that is raised when the window is closed.
 
ValueChangedHandler OnResize
 Event that is raised when the window is resized.
 

Detailed Description

A UI window.