Lua:Class:WinControl
Revision as of 01:41, 11 March 2017 by TheyCallMeTim13 (talk | contribs)
Control class: (Inheritance: Control->Component->Object)
Base class for windows aware controls.
Properties
- DoubleBuffered : boolean
- Graphical updates will go to a off screen bitmap which will then be shown on the screen instead of directly to the screen.
- May reduce flickering.
- ControlCount : integer
- The number of child controls of this WinControl.
- Control[index] : Control
- Array to access a child control.
- OnEnter : function
- Function to be called when the WinControl gains focus.
- OnExit : function
- Function to be called when the WinControl loses focus.
Methods
- getControlCount() : integer
- Returns the number of Controls attached to this class
- getControl(index) : control
- Returns a WinControl class object
- getControlAtPos(x, y) : (integer, integer)
- Gets the control at the given x,y position relative to the WinControl's position
- canFocus() : boolean
- returns true if the object can be focused
- focused() : boolean
- returns boolean true when focused
- setFocus()
- tries to set keyboard focus to the object.
- setShape(region)
- Sets the region object as the new shape for this WinControl
- setShape(bitmap)
- Sets the Bitmap object as the new shape for this WinControl
- setOnEnter(function)
- Sets an 'onEnter' event. (Triggered on focus enter)
- getOnEnter() : function
- Returns the 'onEnter' event.
- setOnExit(function)
- Sets an 'onExit' event. (Triggered on lost focus)
- getOnExit() : function
- Returns the 'onExit' event.