Difference between revisions of "Lua:Class:WinControl"

From Cheat Engine
Jump to navigation Jump to search
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
'''WinControl Class''': (Inheritance: [[Control]]->[[Component]]->[[Object]])
+
[[Category:Lua]]
−
Base class for windows aware controls
+
Control '''class''': ('''Inheritance''': ''[[Control]]''->''[[Component]]''->''[[Object]]'')
  
−
===Properties===
+
Base class for windows aware controls.
−
  DoubleBuffered: boolean - Graphical updates will go to a offscreen 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[] : 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===
+
== Properties ==
−
  getControlCount() Returns the number of Controls attached to this class
+
 
−
  getControl(index) : Returns a WinControl class object
+
; DoubleBuffered : boolean
−
  getControlAtPos(x,y): Gets the control at the given x,y position relative to the wincontrol's position
+
: Graphical updates will go to a off screen bitmap which will then be shown on the screen instead of directly to the screen.
−
  canFocus(): returns true if the object can be focused
+
: May reduce flickering.
−
  focused(): returns boolean true when focused
+
 
−
  setFocus(): tries to set keyboard focus the object
+
; ControlCount : integer
−
  setShape(Region): Sets the region object as the new shape for this wincontrol
+
: The number of child controls of this WinControl.
−
  setShape(Bitmap):
+
 
−
  setOnEnter(function) : Sets an onEnter event. (Triggered on focus enter)
+
; Control[''index''] : Control
−
  getOnEnter()
+
: Array to access a child [[Control]].
−
  setOnExit(function) : Sets an onExit event. (Triggered on lost focus)
+
 
−
  getOnExit()
+
; 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.
 +
 
 +
== See also ==
 +
* [[Lua]]
 +
* [[Help_File:Script engine|Script engine]]
 +
 
 +
=== Related Functions ===
 +
* [[createClass]]
 +
* [[inheritsFromObject]]
 +
* [[inheritsFromComponent]]
 +
* [[inheritsFromControl]]
 +
* [[inheritsFromWinControl]]
 +
 
 +
=== Related Classes ===
 +
* [[Object]]
 +
* [[Control]]
 +
* [[Component]]
 +
* [[Application]]
 +
* [[Form]]

Latest revision as of 01:15, 25 January 2018

Control class: (Inheritance: Control->Component->Object)

Base class for windows aware controls.

Properties[edit]

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[edit]

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.

See also[edit]

Related Functions[edit]

Related Classes[edit]



Retrieved from "https://wiki.cheatengine.org/index.php?title=Lua:Class:WinControl&oldid=5606"