Window
Members
callbacks
desc: The array of GridGUI.GuiCallbacks that the class instance was created with.
type: array|false
default: false
meta: [object]
hwnd
desc: The hwnd of the associated window.
type: hwnd
Methods
__DetectHidden
__DetectHidden()
Enables the detection of hidden windows using other ahk commands.
return value
desc: The previous detect hidden windows state. Either "On" or "Off".
type: string
__New
__New(hwnd, callbacks := false)
Constructor.
parameters
name: hwnd
desc: The hwnd of the window that the class instance should work on.
type: hwnd
return value
desc: A new GridGUI.Window instance.
type: GridGUI.Window
__Setup
__Setup()
Sets up the GridGUI.GuiCallbacks that where passed to the constructor. They are set up using OnMessage
ControlGetFocus
ControlGetFocus()
Retrieves the hwnd of the control with input focus in the window if any.
return value
desc: The hwnd of the control with input focus or an empty string if non where found.
type: hwnd|""
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 window.
type: string
WinActive
WinActive()
A thin method wrapper for WinActive.
return value
desc: The hwnd of the window associated with this class instance if it is the active window otherwise false.
type: hwnd|false
link: link
WinExist
WinExist()
A thin method wrapper for WinExist.
return value
desc: The hwnd of the window associated with this class instance if it exists otherwise false.
type: hwnd|false
link: link
WinGet
WinGet(SubCommand)
A thin method wrapper for WinGet.
parameters
name: SubCommand
desc: The subcommand to retrive from the window. See the link for available subcommands.
type: string
link: link
return value
desc: The retrieved value.
type: any
link: link
WinGetPos
WinGetPos()
A thin method wrapper for WinGetPos, except that it returns a GridGUI.Position instance.
return value
desc: The position and size of the window.
type: GridGUI.Position
link: link
WinMove
WinMove(x := "", y := "", w := "", h := "")
A thin method wrapper for WinMove.
parameters
name: x
desc: The x coordinate that the top left corner of the window will be moved to. If left empty the x coordinate of the top left corner won't change.
type: string
default: ""
name: y
desc: The y coordinate that the top left corner of the window will be moved to. If left empty the y coordinate of the top left corner won't change.
type: string
default: ""
name: w
desc: The width the window should be resized to. If left empty the width won't change.
type: string
default: ""
name: h
desc: The height the window should be resized to. If left empty the height won't change.
type: string
default: ""
link: link
WinSet
WinSet(SubCommand, value)
A thin method wrapper for WinSet, except it works even if the window is hidden.
parameters
name: SubCommand
desc: The subCommand to set for the window. 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