Simutrans-Squirrel-API OTRP v63_4
Loading...
Searching...
No Matches
gui_component_x Class Reference
Collaboration diagram for gui_component_x:

Public Attributes

integer id
string role
bool visible
bool focusable
bool focused
gui_bounds_x bounds
gui_bounds_x screen_bounds
string text
array< gui_component_x > children
integer scroll_x
integer scroll_y

Detailed Description

Snapshot of a GUI component returned by gui::get_window_components.

Definition at line 63 of file api_gui.cc.

Member Data Documentation

◆ bounds

gui_bounds_x gui_component_x::bounds

Bounds relative to the parent component.

Definition at line 88 of file api_gui.cc.

◆ children

array<gui_component_x> gui_component_x::children

Child component snapshots.

Definition at line 100 of file api_gui.cc.

◆ focusable

bool gui_component_x::focusable

True if the component can receive focus.

Definition at line 80 of file api_gui.cc.

◆ focused

bool gui_component_x::focused

True if the component currently has focus.

Definition at line 84 of file api_gui.cc.

◆ id

integer gui_component_x::id

Component id, unique within one component snapshot.

Definition at line 68 of file api_gui.cc.

◆ role

string gui_component_x::role

Component role, such as "button", "label", "textinput", "container", or "scrollpane".

Definition at line 72 of file api_gui.cc.

◆ screen_bounds

gui_bounds_x gui_component_x::screen_bounds

Bounds in screen pixels.

Definition at line 92 of file api_gui.cc.

◆ scroll_x

integer gui_component_x::scroll_x

Horizontal scroll position. Only present on scrollpane components.

Definition at line 104 of file api_gui.cc.

◆ scroll_y

integer gui_component_x::scroll_y

Vertical scroll position. Only present on scrollpane components.

Definition at line 108 of file api_gui.cc.

◆ text

string gui_component_x::text

Text exposed by the component. Only present when the component has text.

Definition at line 96 of file api_gui.cc.

◆ visible

bool gui_component_x::visible

True if the component is visible.

Definition at line 76 of file api_gui.cc.


The documentation for this class was generated from the following file: