Revision as of 17:04, 15 March 2009

This article is information on a script object - a pre-defined type of variable with its own set of static variables and functions. It is intended for use with the GS2 scripting language.

Inherits from TGraalVar.

Description

GuiControl is the base control, therefore general functions listed here are available to all GUI controls. Most of the time it is used as container for positioning groups of other controls. It can either have a border (border=1..5) or just be plain transparent, and just display its child controls.

Variables

Name	Type	Description
active	boolean
awake	boolean (read only)
canmove	boolean
canresize	boolean
controls	object (read only; see addControl())	array of GuiControl (subcontrols)
editing	boolean
extent	string	Can be used instead of width and height. Used like this: "123 456", where 123 is width and 456 is height. There is some syntactic sugar that allows you to treat it like an array, but that illusion breaks when you try to assign to extent[0].
flickering	boolean	Allows the control to periodically show/hide itself.
flickertime	integer	The time between the show and hides in flickering.
height	integer	can be used instead of extent
hint	string
horizsizing	string
layer	integer (read only)
minextent	string
minsize	string	the same like "minExtent"
parent	object (read only)	a GuiControl
position	string	Can be used instead of x and y. Used like this: "123 456", where 123 is x and 456 is y. There is some syntactic sugar that allows you to treat it like an array, but that illusion breaks when you try to assign to position[0].
profile	object	see GuiControlProfile
resizeheight	boolean
resizewidth	boolean
scrolllinex	integer
scrollliney	integer
showhint	boolean
useownprofile	boolean
vertsizing	string
visible	boolean
width	integer	can be used instead of extent
x	integer	can be used instead of position
y	integer	can be used instead of position

Functions

Name	Return Type	Description
addcontrol(obj)
bringtofront()
clearControls()		Removes all controls at once
destroy()
getparent()	object
globaltolocalcoord({x,y})	{x,y}	converts global screen coordinates to a position relative to the controls origin (0,0), can be used to know where exactly the user has clicked inside a control
hide()		Hide the control
isfirstresponder()	boolean	Returns whether or not this control is the first responder
localtoglobalcoord({x,y})	{x,y}	converts a position relative to the controls origin (0,0) to global screen coordinates, can be used to know where on the screen a control is displayed in case it is a child of another control (e.g. GuiWindowCtrl or GuiScrollCtrl)
makefirstresponder(bool)
pushtoback()
resize(int x, int y, int width, int height)		Resize the control
show()		Show the control
showtop()		calls show(), tabfirst() and bringtofront()
tabfirst()	object

Events

onAdd() - is invoked when the control is added to another control (addcontrol)

onRemove() - is invoked when the control is removed from its parent

onShow() - is invoked when the control is shown or gets awakened while being 'visible'

onHide() - is invoked when the control is made hidden

onWake() - is invoked when the control is awakened and becomes visible on the screen

onSleep() - is invoked for windows when a dialog window is removed from the screen

onMove(newx,newy) - is invoked when the control is moved

onResize(newwidth,newheight) - is invoked when the control is resized

onAction() - is invoked when a button control is pressed, you press the enter-key in a text edit control, or move a slider control,

onDialogPush() - is invoked when a dialog control is placed on the screen (using pushDialog(control))

onDialogPop() - is invoked when a dialog control is removed from the screen again (using popDialog())

onKeyDown(keycode,keystring,scancode) - a key has been pressed while the control had the input focus (makeFirstResponder())

onKeyUp(keycode,keystring,scancode) - the key has been released

onMouseYawPitch(xaxis,yaxis) - mouse event in Graal3D when the mouse has been turned off

onMouseDown(keymodifier,mousescreenx,mousescreeny,clickcount) - the left mouse button has been pressed inside this control

onMouseUp(keymodifier,mousescreenx,mousescreeny) - the left mouse button has been released

onMouseEnter(keymodifier,mousescreenx,mousescreeny) - the mouse moved inside this control

onMouseLeave(keymodifier,mousescreenx,mousescreeny) - the mouse left the control

onMouseDragged(keymodifier,mousescreenx,mousescreeny) - the mouse is moved while the left mouse button is pressed

onMouseMove(keymodifier,mousescreenx,mousescreeny) - the mouse has been moved

onRightMouseDown(keymodifier,mousescreenx,mousescreeny,clickcount) - the right mouse button has been pressed

onRightMouseUp(keymodifier,mousescreenx,mousescreeny) - the right mouse button has been released

onRightMouseDragged(keymodifier,mousescreenx,mousescreeny) - the mouse has been moved while the right mouse button is pressed

onMouseWheelUp(keymodifier) - the mouse wheel has been scrolled up

onMouseWheelDown(keymodifier) - the mouse wheel has been scrolled down

Example

 new GuiControl("Test_Back") {
   useownprofile = true;
   profile.border = 3;
   x = 10;
   y = 10;
   width = 160;
   height = 80;
 }

Object Navigation

TGraalVar

@@ Line 42: / Line 42: @@
 | extent
 | string
-| can be used instead of width and height
+| Can be used instead of width and height. Used like this: "123 456", where 123 is width and 456 is height. There is some syntactic sugar that allows you to treat it like an array, but that illusion breaks when you try to assign to extent[0].
 |-
 | flickering
@@ Line 82: / Line 82: @@
 | position
 | string
-| can be used instead of x and y
+| Can be used instead of x and y. Used like this: "123 456", where 123 is x and 456 is y. There is some syntactic sugar that allows you to treat it like an array, but that illusion breaks when you try to assign to position[0].
 |-
 | profile

Creation/Dev/Script/Client/GuiControl: Difference between revisions