newspeoplefor developersdocumentationdownloads

nGuiWidget Script Interface

nguiwidget:

Super Class:

Subclasses:

C++ Class:

Info

Ancestor of all gui widgets.

Commands:


show

Command Input:
v
Command Output:
v
Command Description:
Make the widget visible.

hide

Command Input:
v
Command Output:
v
Command Description:
Make the widget invisible.

isshown

Command Input:
v
Command Output:
b(ShownFlag)
Command Description:
Return true if widget is currently shown.

enable

Command Input:
v
Command Output:
v
Command Description:
Enable the widget for user interaction.

disable

Command Input:
v
Command Output:
v
Command Description:
Disable the widget.

isenabled

Command Input:
v
Command Output:
b(EnabledFlag)
Command Description:
Return true if widget is currently enabled.

setcommand

Command Input:
s(Command)
Command Output:
v
Command Description:
Set command to be executed as the widget's action.

getcommand

Command Input:
v
Command Output:
s(Command)
Command Description:
Get command to be executed as the widget's action.

setshowcommand

Command Input:
s(ShowCommand)
Command Output:
v
Command Description:
Set command to be executed when widget is shown.

getshowcommand

Command Input:
v
Command Output:
s(ShowCommand)
Command Description:
Get command to be executed when widget is shown.

sethidecommand

Command Input:
s(HideCommand)
Command Output:
v
Command Description:
Set command to be executed when widget is hidden.

gethidecommand

Command Input:
v
Command Output:
s(HideCommand)
Command Description:
Get command to be executed when widget is hidden.

setframecommand

Command Input:
s(FrameCommand)
Command Output:
v
Command Description:
Set command to be executed per frame while widget is visible.

getframecommand

Command Input:
v
Command Output:
s(FrameCommand)
Command Description:
Get command to be executed per frame while widget is visible.

setbuttondowncommand

Command Input:
s
Command Output:
v
Command Description:
Set optional command to be executed on button down.

getbuttondowncommand

Command Input:
v
Command Output:
s
Command Description:
Get optional command to be executed on button down.

setrect

Command Input:
f(x0), f(x1), f(y0), f(y1)
Command Output:
v
Command Description:
Set screen space rectangle.

getrect

Command Input:
v
Command Output:
f(x0), f(x1), f(y0), f(y1)
Command Description:
Get screen space rectangle.

settooltip

Command Input:
s(TooltipString)
Command Output:
v
Command Description:
Set an optional tooltip string.

gettooltip

Command Input:
v
Command Output:
s(TooltipString)
Command Description:
Get tooltip string.

setblinking

Command Input:
b(BlinkingState), f(TimeOut)
Command Output:
v
Command Description:
Set blinking state of widget (only implemented by some widget classes). If blinking is turned on, it will turn off automatically after TimeOut time has elapsed. Set TimeOut to 0 for infinite blinking.

setblinkrate

Command Input:
f(BlinkRate)
Command Output:
v
Command Description:
Sets the number of seconds for a complete blink cycle (on & off once). Only implemented by some widget classes.

getblinking

Command Input:
v
Command Output:
b(BlinkingState)
Command Description:
Get blinking state of widget (only implemented by some widget classes).

setdefaultbrush

Command Input:
s(DefaultBrushName)
Command Output:
v
Command Description:
Set default brush name.

getdefaultbrush

Command Input:
v
Command Output:
s(DefaultBrushName)
Command Description:
Get default brush name.

setpressedbrush

Command Input:
s(PressedBrushName)
Command Output:
v
Command Description:
Set pressed brush name.

getpressedbrush

Command Input:
v
Command Output:
s(PressedBrushName)
Command Description:
Get pressed brush name.

sethighlightbrush

Command Input:
s(HighlightBrushName)
Command Output:
v
Command Description:
Set pressed brush name.

gethighlightbrush

Command Input:
v
Command Output:
s(HighlightBrushName)
Command Description:
Get highlight brush name.

setdisabledbrush

Command Input:
s(DisabledBrushName)
Command Output:
v
Command Description:
Set brush for rendering in disabled state.

getdisabledbrush

Command Input:
v
Command Output:
s(DisabledBrushName)
Command Description:
Get disabled brush name.

hasfocus

Command Input:
v
Command Output:
b(Focus)
Command Description:
Return true if widget has focus.

Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.