ControlClass
Members
hwnd
desc: The hwnd of the associated control.
type: hwnd
minHeight
desc: Whether or not the control has had its height set using GridGUI.ControlClass.__ParseOptions.
type: bool
default: false
minHeightVal
desc: The height value set using GridGUI.ControlClass.__ParseOptions.
type: number|false
default: false
minWidth
desc: Whether or not the control has had its width set using GridGUI.ControlClass.__ParseOptions.
type: bool
default: false
minWidthVal
desc: The width value set using GridGUI.ControlClass.__ParseOptions.
type: number|false
default: false
Methods
__New
__New(hwnd)
Constructor.
parameters
name: hwnd
desc: The hwnd of the control.
type: hwnd
return value
desc: A new GridGUI.ControlClass instance.
type: GridGUI.ControlClass
__ParseOptions
__ParseOptions(options)
Parses option strings for values that are used by the class and updated the instance based on the values.
parameters
name: options
desc: The options that will be parsed, values handled by the lib will be acted on and removed.
type: string
return value
desc: The option string without the parts that the class handles.
type: string
Control
Control(subCommand, value)
A thin function wrapper for Control.
parameters
name: subCommand
desc: The subcommand to set for the control. See link for available subcommands.
type: string
link: link
name: value
desc: The value to apply to the subcommand. See link for values used in the subcommands.
type: string|number
link: link
link: link
ControlClick
ControlClick(pos := "", WhichButton := LEFT, ClickCount := 1, Options := "")
A thin function wrapper for ControlClick.
parameters
name: pos
desc: The position to click at in the control, see link for the coordinate format.
type: string
default: ""
link: link
name: WhichButton
desc: Which mouse button to click, see link for supported values.
type: string
default: LEFT
link: link
name: ClickCount
desc: The number of click to perform.
type: number
default: 1
name: Options
desc: A option string to change how the click are performed, see link for supported options.
type: string
default: ""
link: link
link: link
ControlGet
ControlGet(subCommand := "", value := "")
A thin function wrapper for ControlGet.
parameters
name: subCommand
desc: The subcommand to retrieve from the control. See link for available subcommands.
type: string
default: ""
link: link
name: value
desc: Used to specify what to retrieve when the subcommand is not specific enough.
type: string
default: ""
link: link
return value
desc: The retrieved value.
type: any
link: link
ControlGetPos
ControlGetPos()
A thin function wrapper for ControlGetPos, except that it returns a GridGUI.Position instance.
return value
desc: The position and size of the control.
type: GridGUI.Position
link: link
ControlGetText
ControlGetText()
A thin function wrapper for ControlGetText.
return value
desc: The text of the control.
type: string
link: link
ControlMove
ControlMove(pos)
A thin function wrapper for ControlMove, except that it takes a GridGUI.Position instance as argument.
parameters
name: pos
desc: The position and size that the control should be moved and resized to.
type: GridGUI.Position
link: link
ControlSend
ControlSend(keys)
A thin function wrapper for ControlSend.
parameters
name: keys
desc: The sequence of keys to send, use {keyname} for non printable keys.
type: string
link: link
link: link
ControlSetText
ControlSetText(NewText)
A thin function wrapper for ControlSetText.
parameters
link: link
Options
Options(options)
Applies styles to the control using Control, Style.
parameters
name: options
desc: The style number string to apply. See link for available styles.
type: string
link: link
link: link
ToStr
ToStr(indent := "")
Converts the object to a string.
parameters
name: indent
desc: The amount of indentation to add on each line.
type: string
default: ""
return value
desc: A string representing this GridGUI.ControlClass.
type: string