UserInterface
Description
The User Interface code is used to create Graphical User Interface components in SwinGame
Activate Panel
Activate the passed in panel. If shown, the panel will be clickable. This is the default state of a panel.
Active Radio Button
Takes a radiogroup and returns the active button
- Active Radio Button (grp) : Region [show]
Takes a radiogroup and returns the active button
- Parameters:
-
- grp : GUIRadioGroup
- Returns:
- Region :
- Signatures by Language:
- C/C++: region active_radio_button(guiradio_group grp);
- Pascal: function ActiveRadioButton(grp: GUIRadioGroup): Region;
- Active Radio Button (id) : Region [show]
Takes an ID and returns the active button
- Parameters:
-
- id : String
- Returns:
- Region :
- Signatures by Language:
- C/C++: region active_radio_button_with_id(const char *id);
- C++: region active_radio_button(const char *id);
- Pascal: function ActiveRadioButton(id: String): Region;
- source code
- lib name: ActiveRadioButtonWithID
- Active Radio Button (pnl, id) : Region [show]
Takes a panel and an ID and returns the active button
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- Region :
- Signatures by Language:
- C/C++: region active_radio_button_on_panel_with_id(panel pnl, const char *id);
- C++: region active_radio_button(panel pnl, const char *id);
- Pascal: function ActiveRadioButton(pnl: Panel; id: String): Region;
- source code
- lib name: ActiveRadioButtonOnPanelWithId
Active Radio Button Index
Takes a radiogroup and returns the active button's index.
- Active Radio Button Index (RadioGroup) : Longint [show]
Takes a radiogroup and returns the active button's index.
- Parameters:
-
- RadioGroup : GUIRadioGroup
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t active_radio_button_index(guiradio_group RadioGroup);
- Pascal: function ActiveRadioButtonIndex(RadioGroup: GUIRadioGroup): Longint;
- Active Radio Button Index (id) : Longint [show]
Takes a radiogroup and returns the active button's index.
- Parameters:
-
- id : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t active_radio_button_index_from_id(const char *id);
- C++: int32_t active_radio_button_index(const char *id);
- Pascal: function ActiveRadioButtonIndex(id: String): Longint;
- source code
- lib name: ActiveRadioButtonIndexFromID
- Active Radio Button Index (pnl, id) : Longint [show]
Takes a radiogroup and returns the active button's index.
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t active_radio_button_index_on_panel(panel pnl, const char *id);
- C++: int32_t active_radio_button_index(panel pnl, const char *id);
- Pascal: function ActiveRadioButtonIndex(pnl: Panel; id: String): Longint;
- source code
- lib name: ActiveRadioButtonIndexOnPanel
Active Text Box Parent
Returns the parent panel of the active textbox
Active Text Index
Returns the index of the active textbox's region.
- Active Text Index () : Longint [show]
Returns the index of the active textbox's region.
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t active_text_index();
- Pascal: function ActiveTextIndex(): Longint;
Button Clicked
Returns true when the region has been clicked.
- Button Clicked (name) : Boolean [show]
Returns true when the region has been clicked.
- Parameters:
-
- name : String
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool button_named_clicked(const char *name);
- C++: bool button_clicked(const char *name);
- Pascal: function ButtonClicked(name: String): Boolean;
- source code
- lib name: ButtonNamedClicked
- Button Clicked (r) : Boolean [show]
Returns true when the region has been clicked.
- Parameters:
-
- r : Region
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool button_clicked(region r);
- Pascal: function ButtonClicked(r: Region): Boolean;
Checkbox From Region
Takes a region and returns the checkbox of that region
- Checkbox From Region (r) : GUICheckbox [show]
Takes a region and returns the checkbox of that region
- Parameters:
-
- r : Region
- Returns:
- GUICheckbox :
- Signatures by Language:
- C/C++: guicheckbox checkbox_from_region(region r);
- Pascal: function CheckboxFromRegion(r: Region): GUICheckbox;
Checkbox Set State
Sets the checkbox state to val.
- Checkbox Set State (chk, val) [show]
Sets the checkbox state to val.
- Parameters:
-
- chk : GUICheckbox
- val : Boolean
- Signatures by Language:
- C/C++: void checkbox_set_state(guicheckbox chk, bool val);
- Pascal: procedure CheckboxSetState(chk: GUICheckbox; val: Boolean);
- Checkbox Set State (id, val) [show]
Sets the checkbox state to val given the ID.
- Parameters:
-
- id : String
- val : Boolean
- Signatures by Language:
- C/C++: void check_box_set_state_with_id(const char *id, bool val);
- C++: void checkbox_set_state(const char *id, bool val);
- Pascal: procedure CheckboxSetState(id: String; val: Boolean);
- source code
- lib name: CheckBoxSetStateWithId
- Checkbox Set State (r, val) [show]
Sets the checkbox state to val.
- Parameters:
-
- r : Region
- val : Boolean
- Signatures by Language:
- C/C++: void checkbox_set_state_from_region(region r, bool val);
- C++: void checkbox_set_state(region r, bool val);
- Pascal: procedure CheckboxSetState(r: Region; val: Boolean);
- source code
- lib name: CheckboxSetStateFromRegion
- Checkbox Set State (pnl, id, val) [show]
Sets the checkbox state to val.
- Parameters:
-
- pnl : Panel
- id : String
- val : Boolean
- Signatures by Language:
- C/C++: void checkbox_set_state_on_panel(panel pnl, const char *id, bool val);
- C++: void checkbox_set_state(panel pnl, const char *id, bool val);
- Pascal: procedure CheckboxSetState(pnl: Panel; id: String; val: Boolean);
- source code
- lib name: CheckboxSetStateOnPanel
Checkbox State
Returns checkbox state of the checkbox with ID from string
- Checkbox State (r) : Boolean [show]
Returns checkbox state of the checkbox with ID from string
- Parameters:
-
- r : Region
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool checkbox_state_from_region(region r);
- C++: bool checkbox_state(region r);
- Pascal: function CheckboxState(r: Region): Boolean;
- source code
- lib name: CheckboxStateFromRegion
- Checkbox State (s) : Boolean [show]
Returns checkbox state of the checkbox with ID from string
- Parameters:
-
- s : String
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool checkbox_state(const char *s);
- Pascal: function CheckboxState(s: String): Boolean;
- Checkbox State (chk) : Boolean [show]
Returns checkbox state of the given checkbox
- Parameters:
-
- chk : GUICheckbox
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool checkbox_state_from_checkbox(guicheckbox chk);
- C++: bool checkbox_state(guicheckbox chk);
- Pascal: function CheckboxState(chk: GUICheckbox): Boolean;
- source code
- lib name: CheckboxStateFromCheckbox
- Checkbox State (p, s) : Boolean [show]
Returns checkbox state of the checkbox with ID in a given Panel
- Parameters:
-
- p : Panel
- s : String
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool checkbox_state_on_panel(panel p, const char *s);
- C++: bool checkbox_state(panel p, const char *s);
- Pascal: function CheckboxState(p: Panel; s: String): Boolean;
- source code
- lib name: CheckboxStateOnPanel
Deactivate Panel
Deactivate the panel. The panel will become unclickable, it will remain visible if it was already.
Deactivate Text Box
Deactivates the active textbox
- Deactivate Text Box () [show]
Deactivates the active textbox
Dialog Cancelled
Gets if the dialog has been cancelled
- Dialog Cancelled () : Boolean [show]
Gets if the dialog has been cancelled
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool dialog_cancelled();
- Pascal: function DialogCancelled(): Boolean;
Dialog Complete
Gets if the dialog has been Completed
- Dialog Complete () : Boolean [show]
Gets if the dialog has been Completed
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool dialog_complete();
- Pascal: function DialogComplete(): Boolean;
Dialog Path
Gets the path of the dialog
- Dialog Path () : String [show]
Gets the path of the dialog
- Returns:
- String :
- Signatures by Language:
- C/C++: void dialog_path(char *result);
- Pascal: function DialogPath(): String;
Dialog Set Path
Sets the path of the dialog
- Dialog Set Path (fullname) [show]
Sets the path of the dialog
- Parameters:
-
- fullname : String
- Signatures by Language:
- C/C++: void dialog_set_path(const char *fullname);
- Pascal: procedure DialogSetPath(fullname: String);
Draw GUIAs Vectors
Sets the GUI whether or not to use Vector Drawing
- Draw GUIAs Vectors (b) [show]
Sets the GUI whether or not to use Vector Drawing
- Parameters:
-
- b : Boolean
- Signatures by Language:
- C/C++: void draw_guias_vectors(bool b);
- Pascal: procedure DrawGUIAsVectors(b: Boolean);
Draw Interface
Draw the currently visible panels (For use in the main loop)
- Draw Interface () [show]
Draw the currently visible panels (For use in the main loop)
Finish Reading Text
Finishes reading text and stores in the active textbox
- Finish Reading Text () [show]
Finishes reading text and stores in the active textbox
Free Panel
Disposes of the panel by panel
GUIClicked
Returns true if any of the panels in the user interface have been clicked.
- GUIClicked () : Boolean [show]
Returns true if any of the panels in the user interface have been clicked.
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool guiclicked();
- Pascal: function GUIClicked(): Boolean;
GUISet Active Textbox
Sets the active textbox from region
- GUISet Active Textbox (r) [show]
Sets the active textbox from region
- Parameters:
-
- r : Region
- Signatures by Language:
- C/C++: void guiset_active_textbox_from_region(region r);
- C++: void guiset_active_textbox(region r);
- Pascal: procedure GUISetActiveTextbox(r: Region);
- source code
- lib name: GUISetActiveTextboxFromRegion
- GUISet Active Textbox (name) [show]
Sets the active textbox to the one with the indicated name.
- Parameters:
-
- name : String
- Signatures by Language:
- C/C++: void guiset_active_textbox_named(const char *name);
- C++: void guiset_active_textbox(const char *name);
- Pascal: procedure GUISetActiveTextbox(name: String);
- source code
- lib name: GUISetActiveTextboxNamed
- GUISet Active Textbox (t) [show]
Sets the active textbox
- Parameters:
-
- t : GUITextbox
- Signatures by Language:
- C/C++: void guiset_active_textbox(guitextbox t);
- Pascal: procedure GUISetActiveTextbox(t: GUITextbox);
GUISet Background Color
Sets the Background color of the GUI
GUISet Background Color Inactive
Sets the inactive ForeGround color of the GUI
GUISet Foreground Color
Sets the ForeGround color of the GUI
GUISet Foreground Color Inactive
Sets the inactive ForeGround color of the GUI
GUIText Box Of Text Entered
Returns the textbox in which text was changed/added into most recently.
- GUIText Box Of Text Entered () : GUITextbox [show]
Returns the textbox in which text was changed/added into most recently.
- Returns:
- GUITextbox :
- Signatures by Language:
- C/C++: guitextbox guitext_box_of_text_entered();
- Pascal: function GUITextBoxOfTextEntered(): GUITextbox;
GUIText Entry Complete
Checks if TextEntry finished, returns true/false
- GUIText Entry Complete () : Boolean [show]
Checks if TextEntry finished, returns true/false
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool guitext_entry_complete();
- Pascal: function GUITextEntryComplete(): Boolean;
Has Panel
Returns if panel is in Index Collection
- Has Panel (name) : Boolean [show]
Returns if panel is in Index Collection
- Parameters:
-
- name : String
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool has_panel(const char *name);
- Pascal: function HasPanel(name: String): Boolean;
Hide Panel
Hide the panel, stop drawing it. Panels which are not being draw can not be interacted with by the user.
- Hide Panel (name) [show]
Hide the panel, stop drawing it. Panels which are not being draw can not be interacted with by the user.
- Parameters:
-
- name : String
- Signatures by Language:
- C/C++: void hide_panel_named(const char *name);
- C++: void hide_panel(const char *name);
- Pascal: procedure HidePanel(name: String);
- source code
- lib name: HidePanelNamed
- Hide Panel (p) [show]
Hide the panel, stop drawing it. Panels which are not being draw can not be interacted with by the user.
- Parameters:
-
- p : Panel
- Signatures by Language:
- C/C++: void hide_panel(panel p);
- Pascal: procedure HidePanel(p: Panel);
Index Of Last Updated Text Box
Returns the index of the region of the textbox in which text was changed/added into most recently.
- Index Of Last Updated Text Box () : Longint [show]
Returns the index of the region of the textbox in which text was changed/added into most recently.
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t index_of_last_updated_text_box();
- Pascal: function IndexOfLastUpdatedTextBox(): Longint;
Is Dragging
Returns if anything is currently being dragged
- Is Dragging () : Boolean [show]
Returns if anything is currently being dragged
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool is_dragging();
- Pascal: function IsDragging(): Boolean;
- Is Dragging (pnl) : Boolean [show]
Returns if panel is currently being dragged
- Parameters:
-
- pnl : Panel
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool panel_is_dragging(panel pnl);
- C++: bool is_dragging(panel pnl);
- Pascal: function IsDragging(pnl: Panel): Boolean;
- source code
- lib name: PanelIsDragging
Label Alignment
Returns FontAlignment from label given region
- Label Alignment (r) : FontAlignment [show]
Returns FontAlignment from label given region
- Parameters:
-
- r : Region
- Returns:
- FontAlignment :
- Signatures by Language:
- C/C++: font_alignment label_alignement_from_region(region r);
- C++: font_alignment label_alignment(region r);
- Pascal: function LabelAlignment(r: Region): FontAlignment;
- source code
- lib name: LabelAlignementFromRegion
- Label Alignment (lbl) : FontAlignment [show]
Returns FontAlignment from label given region
- Parameters:
-
- lbl : GUILabel
- Returns:
- FontAlignment :
- Signatures by Language:
- C/C++: font_alignment label_alignment(guilabel lbl);
- Pascal: function LabelAlignment(lbl: GUILabel): FontAlignment;
Label Font
Get Font From Label
- Label Font (r) : Font [show]
Get Font From Label
- Parameters:
-
- r : Region
- Returns:
- Font :
- Signatures by Language:
- C/C++: font label_from_region_get_font(region r);
- C++: font label_font(region r);
- Pascal: function LabelFont(r: Region): Font;
- source code
- lib name: LabelFromRegionGetFont
- Label Font (l) : Font [show]
Get Font From Label
Label From Region
returns a GUILabel From given region
Label Set Alignment
Sets FontAlignment for label given region
- Label Set Alignment (r, align) [show]
Sets FontAlignment for label given region
- Parameters:
-
- r : Region
- align : FontAlignment
- Signatures by Language:
- C/C++: void set_label_alignment_from_region(region r, font_alignment align);
- C++: void label_set_alignment(region r, font_alignment align);
- Pascal: procedure LabelSetAlignment(r: Region; align: FontAlignment);
- source code
- lib name: SetLabelAlignmentFromRegion
- Label Set Alignment (tb, align) [show]
Sets FontAlignment for label given region
- Parameters:
-
- tb : GUILabel
- align : FontAlignment
- Signatures by Language:
- C/C++: void set_label_alignment(guilabel tb, font_alignment align);
- C++: void label_set_alignment(guilabel tb, font_alignment align);
- Pascal: procedure LabelSetAlignment(tb: GUILabel; align: FontAlignment);
- source code
- lib name: SetLabelAlignment
Label Set Font
Set Font For Label
Label Set Text
Set text for Label
- Label Set Text (lb, newString) [show]
Set text for Label
- Parameters:
-
- lb : GUILabel
- newString : String
- Signatures by Language:
- C/C++: void label_set_text(guilabel lb, const char *newString);
- Pascal: procedure LabelSetText(lb: GUILabel; newString: String);
- Label Set Text (r, newString) [show]
Set text for Label
- Parameters:
-
- r : Region
- newString : String
- Signatures by Language:
- C/C++: void label_from_region_set_text(region r, const char *newString);
- C++: void label_set_text(region r, const char *newString);
- Pascal: procedure LabelSetText(r: Region; newString: String);
- source code
- lib name: LabelFromRegionSetText
- Label Set Text (id, newString) [show]
Set text for Label
- Parameters:
-
- id : String
- newString : String
- Signatures by Language:
- C/C++: void label_with_id_set_text(const char *id, const char *newString);
- C++: void label_set_text(const char *id, const char *newString);
- Pascal: procedure LabelSetText(id: String; newString: String);
- source code
- lib name: LabelWithIdSetText
- Label Set Text (pnl, id, newString) [show]
Set text for Label
- Parameters:
-
- pnl : Panel
- id : String
- newString : String
- Signatures by Language:
- C/C++: void label_on_panel_with_id_set_text(panel pnl, const char *id, const char *newString);
- C++: void label_set_text(panel pnl, const char *id, const char *newString);
- Pascal: procedure LabelSetText(pnl: Panel; id: String; newString: String);
- source code
- lib name: LabelOnPanelWithIdSetText
Label Text
Get text From Label
- Label Text (r) : String [show]
Get text From Label
- Parameters:
-
- r : Region
- Returns:
- String :
- Signatures by Language:
- C/C++: void label_text_from_region(region r, char *result);
- C++: void label_text(region r, char *result);
- Pascal: function LabelText(r: Region): String;
- source code
- lib name: LabelTextFromRegion
- Label Text (lb) : String [show]
Get text From Label
- Parameters:
-
- lb : GUILabel
- Returns:
- String :
- Signatures by Language:
- C/C++: void label_text(guilabel lb, char *result);
- Pascal: function LabelText(lb: GUILabel): String;
- Label Text (id) : String [show]
Get text From Label
- Parameters:
-
- id : String
- Returns:
- String :
- Signatures by Language:
- C/C++: void label_text_with_id(const char *id, char *result);
- C++: void label_text(const char *id, char *result);
- Pascal: function LabelText(id: String): String;
- source code
- lib name: LabelTextWithId
- Label Text (pnl, id) : String [show]
Get text From Label
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- String :
- Signatures by Language:
- C/C++: void label_text_on_panel_with_id(panel pnl, const char *id, char *result);
- C++: void label_text(panel pnl, const char *id, char *result);
- Pascal: function LabelText(pnl: Panel; id: String): String;
- source code
- lib name: LabelTextOnPanelWithId
List Active Item Index
Returns active item's index from the list
- List Active Item Index (lst) : Longint [show]
Returns active item's index from the list
- Parameters:
-
- lst : GUIList
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_active_item_index(guilist lst);
- Pascal: function ListActiveItemIndex(lst: GUIList): Longint;
- List Active Item Index (id) : Longint [show]
Returns active item's index from the list
- Parameters:
-
- id : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_active_item_index_with_id(const char *id);
- C++: int32_t list_active_item_index(const char *id);
- Pascal: function ListActiveItemIndex(id: String): Longint;
- source code
- lib name: ListActiveItemIndexWithId
- List Active Item Index (r) : Longint [show]
Returns active item's index from the list of the region
- Parameters:
-
- r : Region
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_active_item_index_from_region(region r);
- C++: int32_t list_active_item_index(region r);
- Pascal: function ListActiveItemIndex(r: Region): Longint;
- source code
- lib name: ListActiveItemIndexFromRegion
- List Active Item Index (pnl, id) : Longint [show]
Returns active item's index from the list
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_active_item_index_on_panel_with_id(panel pnl, const char *id);
- C++: int32_t list_active_item_index(panel pnl, const char *id);
- Pascal: function ListActiveItemIndex(pnl: Panel; id: String): Longint;
- source code
- lib name: ListActiveItemIndexOnPanelWithId
List Active Item Text
Returns the text of the active item in the list of the region
- List Active Item Text (list) : String [show]
Returns the text of the active item in the list of the region
- Parameters:
-
- list : GUIList
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_active_item_text(guilist list, char *result);
- Pascal: function ListActiveItemText(list: GUIList): String;
- List Active Item Text (r) : String [show]
Returns the text of the active item in the list of the region
- Parameters:
-
- r : Region
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_active_item_text_from_region(region r, char *result);
- C++: void list_active_item_text(region r, char *result);
- Pascal: function ListActiveItemText(r: Region): String;
- source code
- lib name: ListActiveItemTextFromRegion
- List Active Item Text (ID) : String [show]
Returns the active item text of the List in with ID
- Parameters:
-
- ID : String
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_with_id_active_item_text(const char *ID, char *result);
- C++: void list_active_item_text(const char *ID, char *result);
- Pascal: function ListActiveItemText(ID: String): String;
- source code
- lib name: ListWithIdActiveItemText
- List Active Item Text (pnl, ID) : String [show]
Returns the active item text of the List in panel, pnl- with ID, ID
- Parameters:
-
- pnl : Panel
- ID : String
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_active_item_text_on_panel_with_id(panel pnl, const char *ID, char *result);
- C++: void list_active_item_text(panel pnl, const char *ID, char *result);
- Pascal: function ListActiveItemText(pnl: Panel; ID: String): String;
- source code
- lib name: ListActiveItemTextOnPanelWithId
List Add Item
Adds an item to the list by bitmap
- List Add Item (lst, img) [show]
Adds an item to the list by bitmap
- Parameters:
- Signatures by Language:
- C/C++: void add_item_by_bitmap(guilist lst, bitmap img);
- C++: void list_add_item(guilist lst, bitmap img);
- Pascal: procedure ListAddItem(lst: GUIList; img: Bitmap);
- source code
- lib name: AddItemByBitmap
- List Add Item (id, img) [show]
Adds an item to the list by bitmap
- Parameters:
-
- id : String
- img : Bitmap
- Signatures by Language:
- C/C++: void add_item_with_id_by_bitmap(const char *id, bitmap img);
- C++: void list_add_item(const char *id, bitmap img);
- Pascal: procedure ListAddItem(id: String; img: Bitmap);
- source code
- lib name: AddItemWithIdByBitmap
- List Add Item (lst, const img) [show]
Adds an item to the list where the items shows a cell of a bitmap.
- Parameters:
-
- lst : GUIList
- img : BitmapCell
- Signatures by Language:
- C/C++: void list_add_item_with_cell(guilist lst, const bitmap_cell *img);
- C/C++: void list_add_item_with_cell_byval(guilist lst, const bitmap_cell img);
- C++: void list_add_item(guilist lst, const bitmap_cell &img);
- Pascal: procedure ListAddItem(lst: GUIList; const img: BitmapCell);
- source code
- lib name: ListAddItemWithCell
- List Add Item (lst, text) [show]
Adds an item to the list by text
- Parameters:
-
- lst : GUIList
- text : String
- Signatures by Language:
- C/C++: void add_item_by_text(guilist lst, const char *text);
- C++: void list_add_item(guilist lst, const char *text);
- Pascal: procedure ListAddItem(lst: GUIList; text: String);
- source code
- lib name: AddItemByText
- List Add Item (id, text) [show]
Adds an item to the list by text
- Parameters:
-
- id : String
- text : String
- Signatures by Language:
- C/C++: void add_item_with_id_by_text(const char *id, const char *text);
- C++: void list_add_item(const char *id, const char *text);
- Pascal: procedure ListAddItem(id: String; text: String);
- source code
- lib name: AddItemWithIdByText
- List Add Item (r, img) [show]
Adds an item to the list by bitmap
- Parameters:
- Signatures by Language:
- C/C++: void list_add_item_by_bitmap_from_region(region r, bitmap img);
- C++: void list_add_item(region r, bitmap img);
- Pascal: procedure ListAddItem(r: Region; img: Bitmap);
- source code
- lib name: ListAddItemByBitmapFromRegion
- List Add Item (r, const img) [show]
Adds an item to the list where the items shows a cell of a bitmap.
- Parameters:
-
- r : Region
- img : BitmapCell
- Signatures by Language:
- C/C++: void list_add_item_with_cell_from_region(region r, const bitmap_cell *img);
- C/C++: void list_add_item_with_cell_from_region_byval(region r, const bitmap_cell img);
- C++: void list_add_item(region r, const bitmap_cell &img);
- Pascal: procedure ListAddItem(r: Region; const img: BitmapCell);
- source code
- lib name: ListAddItemWithCellFromRegion
- List Add Item (id, const img) [show]
Adds an item to the list where the items shows a cell of a bitmap.
- Parameters:
-
- id : String
- img : BitmapCell
- Signatures by Language:
- C/C++: void list_with_id_add_item_with_cell(const char *id, const bitmap_cell *img);
- C/C++: void list_with_id_add_item_with_cell_byval(const char *id, const bitmap_cell img);
- C++: void list_add_item(const char *id, const bitmap_cell &img);
- Pascal: procedure ListAddItem(id: String; const img: BitmapCell);
- source code
- lib name: ListWithIdAddItemWithCell
- List Add Item (r, text) [show]
Adds an item to the list by text
- Parameters:
-
- r : Region
- text : String
- Signatures by Language:
- C/C++: void list_add_item_by_text_from_region(region r, const char *text);
- C++: void list_add_item(region r, const char *text);
- Pascal: procedure ListAddItem(r: Region; text: String);
- source code
- lib name: ListAddItemByTextFromRegion
- List Add Item (pnl, id, img) [show]
Adds an item to the list by bitmap
- Parameters:
- Signatures by Language:
- C/C++: void list_add_item_bitmap(panel pnl, const char *id, bitmap img);
- C++: void list_add_item(panel pnl, const char *id, bitmap img);
- Pascal: procedure ListAddItem(pnl: Panel; id: String; img: Bitmap);
- source code
- lib name: ListAddItemBitmap
- List Add Item (r, const img, text) [show]
Adds an item to the list where the items shows a cell of a bitmap and some text.
- Parameters:
-
- r : Region
- img : BitmapCell
- text : String
- Signatures by Language:
- C/C++: void list_add_item_with_cell_and_text_from_region(region r, const bitmap_cell *img, const char *text);
- C/C++: void list_add_item_with_cell_and_text_from_region_byval(region r, const bitmap_cell img, const char *text);
- C++: void list_add_item(region r, const bitmap_cell &img, const char *text);
- Pascal: procedure ListAddItem(r: Region; const img: BitmapCell; text: String);
- source code
- lib name: ListAddItemWithCellAndTextFromRegion
- List Add Item (lst, img, text) [show]
Adds an item to the list by text and Bitmap
- Parameters:
- Signatures by Language:
- C/C++: void list_add_bitmap_and_text_item(guilist lst, bitmap img, const char *text);
- C++: void list_add_item(guilist lst, bitmap img, const char *text);
- Pascal: procedure ListAddItem(lst: GUIList; img: Bitmap; text: String);
- source code
- lib name: ListAddBitmapAndTextItem
- List Add Item (pnl, id, const img) [show]
Adds an item to the list where the items shows a cell of a bitmap.
- Parameters:
-
- pnl : Panel
- id : String
- img : BitmapCell
- Signatures by Language:
- C/C++: void list_on_panel_with_id_add_item_with_cell(panel pnl, const char *id, const bitmap_cell *img);
- C/C++: void list_on_panel_with_id_add_item_with_cell_byval(panel pnl, const char *id, const bitmap_cell img);
- C++: void list_add_item(panel pnl, const char *id, const bitmap_cell &img);
- Pascal: procedure ListAddItem(pnl: Panel; id: String; const img: BitmapCell);
- source code
- lib name: ListOnPanelWithIdAddItemWithCell
- List Add Item (id, img, text) [show]
Adds an item to the list by text and Bitmap
- Parameters:
-
- id : String
- img : Bitmap
- text : String
- Signatures by Language:
- C/C++: void list_with_idadd_bitmap_with_text_item(const char *id, bitmap img, const char *text);
- C++: void list_add_item(const char *id, bitmap img, const char *text);
- Pascal: procedure ListAddItem(id: String; img: Bitmap; text: String);
- source code
- lib name: ListWithIDAddBitmapWithTextItem
- List Add Item (r, img, text) [show]
Adds an item to the list
- Parameters:
- Signatures by Language:
- C/C++: void list_add_bitmap_and_text_item_from_region(region r, bitmap img, const char *text);
- C++: void list_add_item(region r, bitmap img, const char *text);
- Pascal: procedure ListAddItem(r: Region; img: Bitmap; text: String);
- source code
- lib name: ListAddBitmapAndTextItemFromRegion
- List Add Item (lst, const img, text) [show]
Adds an item to the list where the items shows a cell of a bitmap and some text.
- Parameters:
-
- lst : GUIList
- img : BitmapCell
- text : String
- Signatures by Language:
- C/C++: void list_add_item_with_cell_and_text(guilist lst, const bitmap_cell *img, const char *text);
- C/C++: void list_add_item_with_cell_and_text_byval(guilist lst, const bitmap_cell img, const char *text);
- C++: void list_add_item(guilist lst, const bitmap_cell &img, const char *text);
- Pascal: procedure ListAddItem(lst: GUIList; const img: BitmapCell; text: String);
- source code
- lib name: ListAddItemWithCellAndText
- List Add Item (pnl, id, text) [show]
Adds an item to the list by text
- Parameters:
-
- pnl : Panel
- id : String
- text : String
- Signatures by Language:
- C/C++: void add_item_on_panel_with_id_by_text(panel pnl, const char *id, const char *text);
- C++: void list_add_item(panel pnl, const char *id, const char *text);
- Pascal: procedure ListAddItem(pnl: Panel; id: String; text: String);
- source code
- lib name: AddItemOnPanelWithIdByText
- List Add Item (id, const img, text) [show]
Adds an item to the list where the items shows a cell of a bitmap and some text.
- Parameters:
-
- id : String
- img : BitmapCell
- text : String
- Signatures by Language:
- C/C++: void list_with_id_add_item_with_cell_and_text(const char *id, const bitmap_cell *img, const char *text);
- C/C++: void list_with_id_add_item_with_cell_and_text_byval(const char *id, const bitmap_cell img, const char *text);
- C++: void list_add_item(const char *id, const bitmap_cell &img, const char *text);
- Pascal: procedure ListAddItem(id: String; const img: BitmapCell; text: String);
- source code
- lib name: ListWithIdAddItemWithCellAndText
- List Add Item (pnl, id, const img, text) [show]
Adds an item to the list where the items shows a cell of a bitmap and some text.
- Parameters:
-
- pnl : Panel
- id : String
- img : BitmapCell
- text : String
- Signatures by Language:
- C/C++: void list_on_panel_with_id_add_item_with_cell_and_text(panel pnl, const char *id, const bitmap_cell *img, const char *text);
- C/C++: void list_on_panel_with_id_add_item_with_cell_and_text_byval(panel pnl, const char *id, const bitmap_cell img, const char *text);
- C++: void list_add_item(panel pnl, const char *id, const bitmap_cell &img, const char *text);
- Pascal: procedure ListAddItem(pnl: Panel; id: String; const img: BitmapCell; text: String);
- source code
- lib name: ListOnPanelWithIdAddItemWithCellAndText
- List Add Item (pnl, id, img, text) [show]
Adds an item to the list by text and Bitmap
- Parameters:
- Signatures by Language:
- C/C++: void list_on_panel_with_id_add_bitmap_with_text_item(panel pnl, const char *id, bitmap img, const char *text);
- C++: void list_add_item(panel pnl, const char *id, bitmap img, const char *text);
- Pascal: procedure ListAddItem(pnl: Panel; id: String; img: Bitmap; text: String);
- source code
- lib name: ListOnPanelWithIdAddBitmapWithTextItem
List Bitmap Index
Returns the index of the item with the bitmap, img
- List Bitmap Index (lst, img) : Longint [show]
Returns the index of the item with the bitmap, img
- List Bitmap Index (lst, const img) : Longint [show]
Returns the index of the item with the bitmap and cell.
- Parameters:
-
- lst : GUIList
- img : BitmapCell
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_bitmap_cell_index(guilist lst, const bitmap_cell *img);
- C/C++: int32_t list_bitmap_cell_index_byval(guilist lst, const bitmap_cell img);
- C++: int32_t list_bitmap_index(guilist lst, const bitmap_cell &img);
- Pascal: function ListBitmapIndex(lst: GUIList; const img: BitmapCell): Longint;
- source code
- lib name: ListBitmapCellIndex
List Clear Items
Removes all items from the list.
- List Clear Items (id) [show]
Removes all items from the list.
- Parameters:
-
- id : String
- Signatures by Language:
- C/C++: void listclear_items_with_id(const char *id);
- C++: void list_clear_items(const char *id);
- Pascal: procedure ListClearItems(id: String);
- source code
- lib name: ListclearItemsWithId
- List Clear Items (lst) [show]
Removes all items from the list.
- Parameters:
-
- lst : GUIList
- Signatures by Language:
- C/C++: void list_clear_items(guilist lst);
- Pascal: procedure ListClearItems(lst: GUIList);
- List Clear Items (r) [show]
Removes all items from the list of the region
- Parameters:
-
- r : Region
- Signatures by Language:
- C/C++: void list_clear_items_from_region(region r);
- C++: void list_clear_items(region r);
- Pascal: procedure ListClearItems(r: Region);
- source code
- lib name: ListClearItemsFromRegion
- List Clear Items (pnl, id) [show]
Removes all items from the list.
- Parameters:
-
- pnl : Panel
- id : String
- Signatures by Language:
- C/C++: void list_clear_items_given_panel_with_id(panel pnl, const char *id);
- C++: void list_clear_items(panel pnl, const char *id);
- Pascal: procedure ListClearItems(pnl: Panel; id: String);
- source code
- lib name: ListClearItemsGivenPanelWithId
List Font
Returns the font of the list
- List Font (lst) : Font [show]
Returns the font of the list
- List Font (r) : Font [show]
Returns the font of the list of the region
- Parameters:
-
- r : Region
- Returns:
- Font :
- Signatures by Language:
- C/C++: font list_font_from_region(region r);
- C++: font list_font(region r);
- Pascal: function ListFont(r: Region): Font;
- source code
- lib name: ListFontFromRegion
List Font Alignment
Returns the font alignment of a list
- List Font Alignment (lst) : FontAlignment [show]
Returns the font alignment of a list
- Parameters:
-
- lst : GUIList
- Returns:
- FontAlignment :
- Signatures by Language:
- C/C++: font_alignment list_font_alignment(guilist lst);
- Pascal: function ListFontAlignment(lst: GUIList): FontAlignment;
- List Font Alignment (r) : FontAlignment [show]
Returns the font alignment of a list from region
- Parameters:
-
- r : Region
- Returns:
- FontAlignment :
- Signatures by Language:
- C/C++: font_alignment list_font_alignment_from_region(region r);
- C++: font_alignment list_font_alignment(region r);
- Pascal: function ListFontAlignment(r: Region): FontAlignment;
- source code
- lib name: ListFontAlignmentFromRegion
List From Region
Returns Returns the list of the region r
List Item Count
Returns the number of items in the list
- List Item Count (lst) : Longint [show]
Returns the number of items in the list
- Parameters:
-
- lst : GUIList
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_item_count(guilist lst);
- Pascal: function ListItemCount(lst: GUIList): Longint;
- List Item Count (r) : Longint [show]
Returns the number of items in the list of the region
- Parameters:
-
- r : Region
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_item_count_from_region(region r);
- C++: int32_t list_item_count(region r);
- Pascal: function ListItemCount(r: Region): Longint;
- source code
- lib name: ListItemCountFromRegion
- List Item Count (id) : Longint [show]
Returns the number of items in the list
- Parameters:
-
- id : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_item_count_with_id(const char *id);
- C++: int32_t list_item_count(const char *id);
- Pascal: function ListItemCount(id: String): Longint;
- source code
- lib name: ListItemCountWithId
- List Item Count (pnl, id) : Longint [show]
Returns the number of items in the list
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_item_count_on_panel_with_id(panel pnl, const char *id);
- C++: int32_t list_item_count(panel pnl, const char *id);
- Pascal: function ListItemCount(pnl: Panel; id: String): Longint;
- source code
- lib name: ListItemCountOnPanelWithId
List Item Text
Returns the text of the item at index idx
- List Item Text (id, idx) : String [show]
Returns the text of the item at index idx
- Parameters:
-
- id : String
- idx : Longint
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_item_text_from_id(const char *id, int32_t idx, char *result);
- C++: void list_item_text(const char *id, int32_t idx, char *result);
- Pascal: function ListItemText(id: String; idx: Longint): String;
- source code
- lib name: ListItemTextFromId
- List Item Text (lst, idx) : String [show]
Returns the text of the item at index idx
- Parameters:
-
- lst : GUIList
- idx : Longint
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_item_text(guilist lst, int32_t idx, char *result);
- Pascal: function ListItemText(lst: GUIList; idx: Longint): String;
- List Item Text (r, idx) : String [show]
Returns the text of the item at index idx from the List of the Region
- Parameters:
-
- r : Region
- idx : Longint
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_item_text_from_region(region r, int32_t idx, char *result);
- C++: void list_item_text(region r, int32_t idx, char *result);
- Pascal: function ListItemText(r: Region; idx: Longint): String;
- source code
- lib name: ListItemTextFromRegion
- List Item Text (pnl, id, idx) : String [show]
Returns the text of the item at index idx
- Parameters:
-
- pnl : Panel
- id : String
- idx : Longint
- Returns:
- String :
- Signatures by Language:
- C/C++: void list_item_text_on_panel_with_id(panel pnl, const char *id, int32_t idx, char *result);
- C++: void list_item_text(panel pnl, const char *id, int32_t idx, char *result);
- Pascal: function ListItemText(pnl: Panel; id: String; idx: Longint): String;
- source code
- lib name: ListItemTextOnPanelWithId
List Largest Start Index
Returns the largest index that startingAt should be set to.
List Remove Active Item
Removes the active item from a list
- List Remove Active Item (r) [show]
Removes the active item from a list
- Parameters:
-
- r : Region
- Signatures by Language:
- C/C++: void list_remove_active_item_from_region(region r);
- C++: void list_remove_active_item(region r);
- Pascal: procedure ListRemoveActiveItem(r: Region);
- source code
- lib name: ListRemoveActiveItemFromRegion
- List Remove Active Item (id) [show]
Removes the active item from a list
- Parameters:
-
- id : String
- Signatures by Language:
- C/C++: void list_remove_active_item_from_id(const char *id);
- C++: void list_remove_active_item(const char *id);
- Pascal: procedure ListRemoveActiveItem(id: String);
- source code
- lib name: ListRemoveActiveItemFromId
- List Remove Active Item (pnl, id) [show]
Removes the active item from a list
- Parameters:
-
- pnl : Panel
- id : String
- Signatures by Language:
- C/C++: void list_remove_active_item_on_panel_with_id(panel pnl, const char *id);
- C++: void list_remove_active_item(panel pnl, const char *id);
- Pascal: procedure ListRemoveActiveItem(pnl: Panel; id: String);
- source code
- lib name: ListRemoveActiveItemOnPanelWithId
List Remove Item
Removes item at index idx from the list
- List Remove Item (id, idx) [show]
Removes item at index idx from the list
- Parameters:
-
- id : String
- idx : Longint
- Signatures by Language:
- C/C++: void list_remove_item_from_with_id(const char *id, int32_t idx);
- C++: void list_remove_item(const char *id, int32_t idx);
- Pascal: procedure ListRemoveItem(id: String; idx: Longint);
- source code
- lib name: ListRemoveItemFromWithId
- List Remove Item (lst, idx) [show]
Removes item at index idx from the list
- Parameters:
-
- lst : GUIList
- idx : Longint
- Signatures by Language:
- C/C++: void list_remove_item(guilist lst, int32_t idx);
- Pascal: procedure ListRemoveItem(lst: GUIList; idx: Longint);
- List Remove Item (pnl, id, idx) [show]
Removes item at index idx from the list
- Parameters:
-
- pnl : Panel
- id : String
- idx : Longint
- Signatures by Language:
- C/C++: void list_remove_item_on_panel_with_id(panel pnl, const char *id, int32_t idx);
- C++: void list_remove_item(panel pnl, const char *id, int32_t idx);
- Pascal: procedure ListRemoveItem(pnl: Panel; id: String; idx: Longint);
- source code
- lib name: ListRemoveItemOnPanelWithId
List Scroll Increment
Returns the largest index that startingAt should be set to.
List Set Active Item Index
Set the active item in the list to the item at index idx
- List Set Active Item Index (id, idx) [show]
Set the active item in the list to the item at index idx
- Parameters:
-
- id : String
- idx : Longint
- Signatures by Language:
- C/C++: void list_set_active_item_index_with_id(const char *id, int32_t idx);
- C++: void list_set_active_item_index(const char *id, int32_t idx);
- Pascal: procedure ListSetActiveItemIndex(id: String; idx: Longint);
- source code
- lib name: ListSetActiveItemIndexWithId
- List Set Active Item Index (lst, idx) [show]
Set the active item in the list to the item at index idx
- Parameters:
-
- lst : GUIList
- idx : Longint
- Signatures by Language:
- C/C++: void list_set_active_item_index(guilist lst, int32_t idx);
- Pascal: procedure ListSetActiveItemIndex(lst: GUIList; idx: Longint);
- List Set Active Item Index (pnl, id, idx) [show]
Set the active item in the list to the item at index idx
- Parameters:
-
- pnl : Panel
- id : String
- idx : Longint
- Signatures by Language:
- C/C++: void list_set(panel pnl, const char *id, int32_t idx);
- C++: void list_set_active_item_index(panel pnl, const char *id, int32_t idx);
- Pascal: procedure ListSetActiveItemIndex(pnl: Panel; id: String; idx: Longint);
- source code
- lib name: ListSet
List Set Font
Sets the font of the list to font f
List Set Font Alignment
Returns the font alignment of a list from region
- List Set Font Alignment (r, align) [show]
Returns the font alignment of a list from region
- Parameters:
-
- r : Region
- align : FontAlignment
- Signatures by Language:
- C/C++: void list_set_font_alignment_from_region(region r, font_alignment align);
- C++: void list_set_font_alignment(region r, font_alignment align);
- Pascal: procedure ListSetFontAlignment(r: Region; align: FontAlignment);
- source code
- lib name: ListSetFontAlignmentFromRegion
- List Set Font Alignment (lst, align) [show]
Returns the font alignment of a list
- Parameters:
-
- lst : GUIList
- align : FontAlignment
- Signatures by Language:
- C/C++: void list_set_font_alignment(guilist lst, font_alignment align);
- Pascal: procedure ListSetFontAlignment(lst: GUIList; align: FontAlignment);
List Set Start At
Sets the starting point for the list from region
- List Set Start At (r, idx) [show]
Sets the starting point for the list from region
- Parameters:
-
- r : Region
- idx : Longint
- Signatures by Language:
- C/C++: void list_set_starting_at_from_region(region r, int32_t idx);
- C++: void list_set_start_at(region r, int32_t idx);
- Pascal: procedure ListSetStartAt(r: Region; idx: Longint);
- source code
- lib name: ListSetStartingAtFromRegion
- List Set Start At (lst, idx) [show]
Sets the starting point for the list
- Parameters:
-
- lst : GUIList
- idx : Longint
- Signatures by Language:
- C/C++: void list_set_starting_at(guilist lst, int32_t idx);
- C++: void list_set_start_at(guilist lst, int32_t idx);
- Pascal: procedure ListSetStartAt(lst: GUIList; idx: Longint);
- source code
- lib name: ListSetStartingAt
List Start At
Returns the starting point for the list
- List Start At (lst) : Longint [show]
Returns the starting point for the list
- Parameters:
-
- lst : GUIList
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_start_at(guilist lst);
- Pascal: function ListStartAt(lst: GUIList): Longint;
- List Start At (r) : Longint [show]
Returns the starting point for the list from region
- Parameters:
-
- r : Region
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_starting_at_from_region(region r);
- C++: int32_t list_start_at(region r);
- Pascal: function ListStartAt(r: Region): Longint;
- source code
- lib name: ListStartingAtFromRegion
List Text Index
returns the id of a value in the list.
- List Text Index (lst, value) : Longint [show]
returns the id of a value in the list.
- Parameters:
-
- lst : GUIList
- value : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t list_text_index(guilist lst, const char *value);
- Pascal: function ListTextIndex(lst: GUIList; value: String): Longint;
Load Panel
Loads panel from panel directory with filename
Load Panel Named
maps panel to name in Hash Table.
- Load Panel Named (name, filename) : Panel [show]
maps panel to name in Hash Table.
- Parameters:
-
- name : String
- filename : String
- Returns:
- Panel :
- Signatures by Language:
- C/C++: panel load_panel_named(const char *name, const char *filename);
- Pascal: function LoadPanelNamed(name: String; filename: String): Panel;
New Panel
Creates a new panel
Panel Active
Returns whether panel is active
Panel At Point
Returns the panel at the point passed in. Returns nil if there is no panel.
Panel Clicked
Returns the last panel clicked.
- Panel Clicked () : Panel [show]
Returns the last panel clicked.
- Returns:
- Panel :
- Signatures by Language:
- C/C++: panel panel_clicked();
- Pascal: function PanelClicked(): Panel;
- Panel Clicked (pnl) : Boolean [show]
Returns true when the panel was clicked.
- Parameters:
-
- pnl : Panel
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool panel_was_clicked(panel pnl);
- C++: bool panel_clicked(panel pnl);
- Pascal: function PanelClicked(pnl: Panel): Boolean;
- source code
- lib name: PanelWasClicked
Panel Draggable
Returns whether or not the passed panel is currently draggable
Panel Filename
Returns panel filename
Panel Height
Returns panel h value
- Panel Height (p) : Longint [show]
Returns panel h value
- Parameters:
-
- p : Panel
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t panel_height(panel p);
- Pascal: function PanelHeight(p: Panel): Longint;
- Panel Height (name) : Longint [show]
Returns height of the panel
- Parameters:
-
- name : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t panel_named_height(const char *name);
- C++: int32_t panel_height(const char *name);
- Pascal: function PanelHeight(name: String): Longint;
- source code
- lib name: PanelNamedHeight
Panel Name
Returns the name of the panel
Panel Named
Returns panel with the name name
Panel Set Draggable
Sets panel's draggability to the passed Boolean
Panel Visible
Returns true if panel is currently visible.
Panel Width
Returns the panel's width
- Panel Width (name) : Longint [show]
Returns the panel's width
- Parameters:
-
- name : String
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t panel_named_width(const char *name);
- C++: int32_t panel_width(const char *name);
- Pascal: function PanelWidth(name: String): Longint;
- source code
- lib name: PanelNamedWidth
- Panel Width (p) : Longint [show]
Returns the panel's width
- Parameters:
-
- p : Panel
- Returns:
- Longint :
- Signatures by Language:
- C/C++: int32_t panel_width(panel p);
- Pascal: function PanelWidth(p: Panel): Longint;
Panel X
Returns panel x value
Panel Y
Returns panel y value
Point In Region
Returns true if point is in any region within the panel
- Point In Region (const pt, p) : Boolean [show]
Returns true if point is in any region within the panel
- Parameters:
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool point_in_region(const point2d *pt, panel p);
- C/C++: bool point_in_region_byval(const point2d pt, panel p);
- C++: bool point_in_region(const point2d &pt, panel p);
- Pascal: function PointInRegion(const pt: Point2D; p: Panel): Boolean;
- Point In Region (const pt, p, kind) : Boolean [show]
Returns true if point is in a region with the indicate index.php/api/kind of the panel index.php/api/p.
- Parameters:
-
- pt : Point2D
- p : Panel
- kind : GUIElementKind
- Returns:
- Boolean :
- Signatures by Language:
- C/C++: bool point_in_region_with_kind(const point2d *pt, panel p, guielement_kind kind);
- C/C++: bool point_in_region_with_kind_byval(const point2d pt, panel p, guielement_kind kind);
- C++: bool point_in_region(const point2d &pt, panel p, guielement_kind kind);
- Pascal: function PointInRegion(const pt: Point2D; p: Panel; kind: GUIElementKind): Boolean;
- source code
- lib name: PointInRegionWithKind
Radio Group From Id
Takes an ID and returns the RadioGroup.
- Radio Group From Id (id) : GUIRadioGroup [show]
Takes an ID and returns the RadioGroup.
- Parameters:
-
- id : String
- Returns:
- GUIRadioGroup :
- Signatures by Language:
- C/C++: guiradio_group radio_group_from_id(const char *id);
- Pascal: function RadioGroupFromId(id: String): GUIRadioGroup;
- Radio Group From Id (pnl, id) : GUIRadioGroup [show]
Takes panel and ID and returns the RadioGroup.
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- GUIRadioGroup :
- Signatures by Language:
- C/C++: guiradio_group radio_group_on_panel_width_id(panel pnl, const char *id);
- C++: guiradio_group radio_group_from_id(panel pnl, const char *id);
- Pascal: function RadioGroupFromId(pnl: Panel; id: String): GUIRadioGroup;
- source code
- lib name: RadioGroupOnPanelWidthId
Radio Group From Region
Takes region and returns the RadioGroup.
- Radio Group From Region (r) : GUIRadioGroup [show]
Takes region and returns the RadioGroup.
- Parameters:
-
- r : Region
- Returns:
- GUIRadioGroup :
- Signatures by Language:
- C/C++: guiradio_group radio_group_from_region(region r);
- Pascal: function RadioGroupFromRegion(r: Region): GUIRadioGroup;
Region Active
Returns true when the region is active.
Region At Point
Returns the region from the panel at the point
- Region At Point (p, const pt) : Region [show]
Returns the region from the panel at the point
- Parameters:
- Returns:
- Region :
- Signatures by Language:
- C/C++: region region_at_point(panel p, const point2d *pt);
- C/C++: region region_at_point_byval(panel p, const point2d pt);
- C++: region region_at_point(panel p, const point2d &pt);
- Pascal: function RegionAtPoint(p: Panel; const pt: Point2D): Region;
Region Clicked
Returns the last region clicked on by user.
Region Clicked ID
Returns the ID of the last region clicked on by user.
- Region Clicked ID () : String [show]
Returns the ID of the last region clicked on by user.
- Returns:
- String :
- Signatures by Language:
- C/C++: void region_clicked_id(char *result);
- Pascal: function RegionClickedID(): String;
Region Height
Returns the Region height value
Region ID
Returns the ID of the last region clicked on by user.
Region Of Last Updated Text Box
Returns the region of the textbox in which text was changed/added into most recently.
Region Panel
Returns the Region with the ID passed from the panel passed
Region Width
Returns the Region Wdith value
Region With ID
Returns the Region with the ID passed
- Region With ID (ID) : Region [show]
Returns the Region with the ID passed
- Parameters:
-
- ID : String
- Returns:
- Region :
- Signatures by Language:
- C/C++: region global_region_with_id(const char *ID);
- C++: region region_with_id(const char *ID);
- Pascal: function RegionWithID(ID: String): Region;
- source code
- lib name: GlobalRegionWithID
- Region With ID (pnl, ID) : Region [show]
Returns the Region with the ID passed from the panel passed
Region X
Returns the Region X value
Region Y
Returns the Region Y value
Register Event Callback
Registers the callback with the panel, when an event related to this region occurs the procedure registered will be called.
- Register Event Callback (r, callback) [show]
Registers the callback with the panel, when an event related to this region occurs the procedure registered will be called.
- Parameters:
-
- r : Region
- callback : GUIEventCallback
- Signatures by Language:
- C/C++: void register_event_callback(region r, guievent_callback callback);
- Pascal: procedure RegisterEventCallback(r: Region; callback: GUIEventCallback);
Release Panel
Disposes of the panel by name, removing it from the index collection, setting its dragging to nil, and hiding it first to avoid crashes.
- Release Panel (name) [show]
Disposes of the panel by name, removing it from the index collection, setting its dragging to nil, and hiding it first to avoid crashes.
- Parameters:
-
- name : String
- Signatures by Language:
- C/C++: void release_panel(const char *name);
- Pascal: procedure ReleasePanel(name: String);
Select Radio Button
Takes a region and an ID and selects the button
- Select Radio Button (r) [show]
Takes a region and an ID and selects the button
- Parameters:
-
- r : Region
- Signatures by Language:
- C/C++: void select_radio_button(region r);
- Pascal: procedure SelectRadioButton(r: Region);
- Select Radio Button (id) [show]
Takes an ID and returns the active button
- Parameters:
-
- id : String
- Signatures by Language:
- C/C++: void select_radio_button_with_id(const char *id);
- C++: void select_radio_button(const char *id);
- Pascal: procedure SelectRadioButton(id: String);
- source code
- lib name: SelectRadioButtonWithID
- Select Radio Button (rGroup, r) [show]
Takes a RadioGroup and Region and selects the button
- Parameters:
-
- rGroup : GUIRadioGroup
- r : Region
- Signatures by Language:
- C/C++: void select_radio_button_from_radio_group_and_region(guiradio_group rGroup, region r);
- C++: void select_radio_button(guiradio_group rGroup, region r);
- Pascal: procedure SelectRadioButton(rGroup: GUIRadioGroup; r: Region);
- source code
- lib name: SelectRadioButtonFromRadioGroupAndRegion
- Select Radio Button (pnl, id) [show]
Takes a panel and an ID and selects the button
- Parameters:
-
- pnl : Panel
- id : String
- Signatures by Language:
- C/C++: void select_radio_button_on_panel_with_id(panel pnl, const char *id);
- C++: void select_radio_button(panel pnl, const char *id);
- Pascal: procedure SelectRadioButton(pnl: Panel; id: String);
- source code
- lib name: SelectRadioButtonOnPanelWithId
- Select Radio Button (rGroup, idx) [show]
Takes a RadioGroup and index and selects the button
- Parameters:
-
- rGroup : GUIRadioGroup
- idx : Longint
- Signatures by Language:
- C/C++: void select_radio_button_from_radio_group_and_index(guiradio_group rGroup, int32_t idx);
- C++: void select_radio_button(guiradio_group rGroup, int32_t idx);
- Pascal: procedure SelectRadioButton(rGroup: GUIRadioGroup; idx: Longint);
- source code
- lib name: SelectRadioButtonFromRadioGroupAndIndex
Set Region Active
Sets the region active to Boolean
Show Open Dialog
Displays an OpenDialog
- Show Open Dialog () [show]
Displays an OpenDialog
- Show Open Dialog (select) [show]
Displays an OpenDialog file/folder/both filter
- Parameters:
-
- select : FileDialogSelectType
- Signatures by Language:
- C/C++: void show_open_dialog_with_type(file_dialog_select_type select);
- C++: void show_open_dialog(file_dialog_select_type select);
- Pascal: procedure ShowOpenDialog(select: FileDialogSelectType);
- source code
- lib name: ShowOpenDialogWithType
Show Panel
Display the panel on screen at panel's co-ordinates.
- Show Panel (p) [show]
Display the panel on screen at panel's co-ordinates.
- Parameters:
-
- p : Panel
- Signatures by Language:
- C/C++: void show_panel(panel p);
- Pascal: procedure ShowPanel(p: Panel);
- Show Panel (name) [show]
Display the panel on screen at panel's co-ordinates.
- Parameters:
-
- name : String
- Signatures by Language:
- C/C++: void show_panel_named(const char *name);
- C++: void show_panel(const char *name);
- Pascal: procedure ShowPanel(name: String);
- source code
- lib name: ShowPanelNamed
Show Panel Dialog
shows dialog panel
Show Save Dialog
Displays a SaveDialog
- Show Save Dialog () [show]
Displays a SaveDialog
- Show Save Dialog (select) [show]
Displays a SaveDialog with file/folder/both filter
- Parameters:
-
- select : FileDialogSelectType
- Signatures by Language:
- C/C++: void show_save_dialog_with_type(file_dialog_select_type select);
- C++: void show_save_dialog(file_dialog_select_type select);
- Pascal: procedure ShowSaveDialog(select: FileDialogSelectType);
- source code
- lib name: ShowSaveDialogWithType
Text Box Font
returns font of textbox
- Text Box Font (tb) : Font [show]
returns font of textbox
- Parameters:
-
- tb : GUITextbox
- Returns:
- Font :
- Signatures by Language:
- C/C++: font text_box_font(guitextbox tb);
- Pascal: function TextBoxFont(tb: GUITextbox): Font;
- Text Box Font (r) : Font [show]
returns font of region's textbox (If it has one)
- Parameters:
-
- r : Region
- Returns:
- Font :
- Signatures by Language:
- C/C++: font text_box_font_from_region(region r);
- C++: font text_box_font(region r);
- Pascal: function TextBoxFont(r: Region): Font;
- source code
- lib name: TextBoxFontFromRegion
Text Box From ID
The the TextBox from an ID
- Text Box From ID (id) : GUITextbox [show]
The the TextBox from an ID
- Parameters:
-
- id : String
- Returns:
- GUITextbox :
- Signatures by Language:
- C/C++: guitextbox text_box_from_id(const char *id);
- Pascal: function TextBoxFromID(id: String): GUITextbox;
Text Box From Region
Sets the textbox text from region
- Text Box From Region (r) : GUITextbox [show]
Sets the textbox text from region
- Parameters:
-
- r : Region
- Returns:
- GUITextbox :
- Signatures by Language:
- C/C++: guitextbox textbox_from_region(region r);
- C++: guitextbox text_box_from_region(region r);
- Pascal: function TextBoxFromRegion(r: Region): GUITextbox;
- source code
- lib name: TextboxFromRegion
Text Box Text
Gets the textbox text
- Text Box Text (tb) : String [show]
Gets the textbox text
- Parameters:
-
- tb : GUITextbox
- Returns:
- String :
- Signatures by Language:
- C/C++: void text_box_text(guitextbox tb, char *result);
- Pascal: function TextBoxText(tb: GUITextbox): String;
- Text Box Text (id) : String [show]
Gets the textbox text from region
- Parameters:
-
- id : String
- Returns:
- String :
- Signatures by Language:
- C/C++: void textbox_text_with_id(const char *id, char *result);
- C++: void text_box_text(const char *id, char *result);
- Pascal: function TextBoxText(id: String): String;
- source code
- lib name: TextboxTextWithId
- Text Box Text (r) : String [show]
Gets the textbox text from region
- Parameters:
-
- r : Region
- Returns:
- String :
- Signatures by Language:
- C/C++: void textbox_text_from_region(region r, char *result);
- C++: void text_box_text(region r, char *result);
- Pascal: function TextBoxText(r: Region): String;
- source code
- lib name: TextboxTextFromRegion
- Text Box Text (pnl, id) : String [show]
Gets the textbox text from region
- Parameters:
-
- pnl : Panel
- id : String
- Returns:
- String :
- Signatures by Language:
- C/C++: void textbox_text_on_panel_with_id(panel pnl, const char *id, char *result);
- C++: void text_box_text(panel pnl, const char *id, char *result);
- Pascal: function TextBoxText(pnl: Panel; id: String): String;
- source code
- lib name: TextboxTextOnPanelWithId
Textbox Alignment
Returns the alignment of the text in textbox passed in as region
- Textbox Alignment (r) : FontAlignment [show]
Returns the alignment of the text in textbox passed in as region
- Parameters:
-
- r : Region
- Returns:
- FontAlignment :
- Signatures by Language:
- C/C++: font_alignment text_box_alignment_from_region(region r);
- C++: font_alignment textbox_alignment(region r);
- Pascal: function TextboxAlignment(r: Region): FontAlignment;
- source code
- lib name: TextBoxAlignmentFromRegion
- Textbox Alignment (tb) : FontAlignment [show]
Gets the textbox alignmnet of the textbox
- Parameters:
-
- tb : GUITextbox
- Returns:
- FontAlignment :
- Signatures by Language:
- C/C++: font_alignment textbox_alignment(guitextbox tb);
- Pascal: function TextboxAlignment(tb: GUITextbox): FontAlignment;
Textbox Set Alignment
Set the textbox alignment of the textbox passed in
- Textbox Set Alignment (r, align) [show]
Set the textbox alignment of the textbox passed in
- Parameters:
-
- r : Region
- align : FontAlignment
- Signatures by Language:
- C/C++: void text_box_set_alignment_from_region(region r, font_alignment align);
- C++: void textbox_set_alignment(region r, font_alignment align);
- Pascal: procedure TextboxSetAlignment(r: Region; align: FontAlignment);
- source code
- lib name: TextBoxSetAlignmentFromRegion
- Textbox Set Alignment (tb, align) [show]
Set the textbox alignment of the textbox
- Parameters:
-
- tb : GUITextbox
- align : FontAlignment
- Signatures by Language:
- C/C++: void textbox_set_alignment(guitextbox tb, font_alignment align);
- Pascal: procedure TextboxSetAlignment(tb: GUITextbox; align: FontAlignment);
Textbox Set Font
Sets the textbox font
- Textbox Set Font (Tb, f) [show]
Sets the textbox font
- Parameters:
-
- Tb : GUITextbox
- f : Font
- Signatures by Language:
- C/C++: void textbox_set_font(guitextbox Tb, font f);
- Pascal: procedure TextboxSetFont(Tb: GUITextbox; f: Font);
Textbox Set Text
Sets the textbox text from Id
- Textbox Set Text (id, i) [show]
Sets the textbox text from Id
- Parameters:
-
- id : String
- i : Longint
- Signatures by Language:
- C/C++: void textbox_set_text_to_int_with_id(const char *id, int32_t i);
- C++: void textbox_set_text(const char *id, int32_t i);
- Pascal: procedure TextboxSetText(id: String; i: Longint);
- source code
- lib name: TextboxSetTextToIntWithId
- Textbox Set Text (id, single) [show]
Sets the textbox text from region
- Parameters:
-
- id : String
- single : Single
- Signatures by Language:
- C/C++: void textbox_set_text_to_single_from_id(const char *id, float single);
- C++: void textbox_set_text(const char *id, float single);
- Pascal: procedure TextboxSetText(id: String; single: Single);
- source code
- lib name: TextboxSetTextToSingleFromId
- Textbox Set Text (r, s) [show]
Sets the textbox text from region
- Parameters:
-
- r : Region
- s : String
- Signatures by Language:
- C/C++: void textbox_set_text_from_region(region r, const char *s);
- C++: void textbox_set_text(region r, const char *s);
- Pascal: procedure TextboxSetText(r: Region; s: String);
- source code
- lib name: TextboxSetTextFromRegion
- Textbox Set Text (tb, s) [show]
Sets the textbox text from region
- Parameters:
-
- tb : GUITextbox
- s : String
- Signatures by Language:
- C/C++: void textbox_set_text(guitextbox tb, const char *s);
- Pascal: procedure TextboxSetText(tb: GUITextbox; s: String);
- Textbox Set Text (id, s) [show]
Sets the textbox text from Id
- Parameters:
-
- id : String
- s : String
- Signatures by Language:
- C/C++: void textbox_set_text_from_id(const char *id, const char *s);
- C++: void textbox_set_text(const char *id, const char *s);
- Pascal: procedure TextboxSetText(id: String; s: String);
- source code
- lib name: TextboxSetTextFromId
- Textbox Set Text (r, i) [show]
Sets the textbox text from region
- Parameters:
-
- r : Region
- i : Longint
- Signatures by Language:
- C/C++: void textbox_set_text_to_int_from_region(region r, int32_t i);
- C++: void textbox_set_text(region r, int32_t i);
- Pascal: procedure TextboxSetText(r: Region; i: Longint);
- source code
- lib name: TextboxSetTextToIntFromRegion
- Textbox Set Text (tb, i) [show]
Sets the textbox text from region
- Parameters:
-
- tb : GUITextbox
- i : Longint
- Signatures by Language:
- C/C++: void textbox_set_text_to_int(guitextbox tb, int32_t i);
- C++: void textbox_set_text(guitextbox tb, int32_t i);
- Pascal: procedure TextboxSetText(tb: GUITextbox; i: Longint);
- source code
- lib name: TextboxSetTextToInt
- Textbox Set Text (tb, single) [show]
Sets the textbox text from Textbox
- Parameters:
-
- tb : GUITextbox
- single : Single
- Signatures by Language:
- C/C++: void textbox_set_text_to_single(guitextbox tb, float single);
- C++: void textbox_set_text(guitextbox tb, float single);
- Pascal: procedure TextboxSetText(tb: GUITextbox; single: Single);
- source code
- lib name: TextboxSetTextToSingle
- Textbox Set Text (r, single) [show]
Sets the textbox text from region
- Parameters:
-
- r : Region
- single : Single
- Signatures by Language:
- C/C++: void textbox_set_text_to_single_from_region(region r, float single);
- C++: void textbox_set_text(region r, float single);
- Pascal: procedure TextboxSetText(r: Region; single: Single);
- source code
- lib name: TextboxSetTextToSingleFromRegion
- Textbox Set Text (pnl, id, s) [show]
Sets the textbox text from Panel and Id
- Parameters:
-
- pnl : Panel
- id : String
- s : String
- Signatures by Language:
- C/C++: void textbox_set_text_on_panel_and_id(panel pnl, const char *id, const char *s);
- C++: void textbox_set_text(panel pnl, const char *id, const char *s);
- Pascal: procedure TextboxSetText(pnl: Panel; id: String; s: String);
- source code
- lib name: TextboxSetTextOnPanelAndId
- Textbox Set Text (pnl, id, i) [show]
Sets the textbox text from panel and Id
- Parameters:
-
- pnl : Panel
- id : String
- i : Longint
- Signatures by Language:
- C/C++: void textbox_set_text_to_int_on_panel_with_id(panel pnl, const char *id, int32_t i);
- C++: void textbox_set_text(panel pnl, const char *id, int32_t i);
- Pascal: procedure TextboxSetText(pnl: Panel; id: String; i: Longint);
- source code
- lib name: TextboxSetTextToIntOnPanelWithId
- Textbox Set Text (pnl, id, single) [show]
Sets the textbox text from Panel and Id
- Parameters:
-
- pnl : Panel
- id : String
- single : Single
- Signatures by Language:
- C/C++: void textbox_set_text_to_single_on_panel(panel pnl, const char *id, float single);
- C++: void textbox_set_text(panel pnl, const char *id, float single);
- Pascal: procedure TextboxSetText(pnl: Panel; id: String; single: Single);
- source code
- lib name: TextboxSetTextToSingleOnPanel
Toggle Activate Panel
Activates the panel if deactivated, and deactivates if activated.
Toggle Checkbox State
Toggles the state of a checkbox (ticked/unticked)
- Toggle Checkbox State (id) [show]
Toggles the state of a checkbox (ticked/unticked)
- Parameters:
-
- id : String
- Signatures by Language:
- C/C++: void toggle_checkbox_state_from_id(const char *id);
- C++: void toggle_checkbox_state(const char *id);
- Pascal: procedure ToggleCheckboxState(id: String);
- source code
- lib name: ToggleCheckboxStateFromID
- Toggle Checkbox State (c) [show]
Toggles the state of a checkbox (ticked/unticked)
- Parameters:
-
- c : GUICheckbox
- Signatures by Language:
- C/C++: void toggle_checkbox_state(guicheckbox c);
- Pascal: procedure ToggleCheckboxState(c: GUICheckbox);
- Toggle Checkbox State (pnl, id) [show]
Toggles the state of a checkbox (ticked/unticked)
- Parameters:
-
- pnl : Panel
- id : String
- Signatures by Language:
- C/C++: void toggle_checkbox_state_on_panel(panel pnl, const char *id);
- C++: void toggle_checkbox_state(panel pnl, const char *id);
- Pascal: procedure ToggleCheckboxState(pnl: Panel; id: String);
- source code
- lib name: ToggleCheckboxStateOnPanel
Toggle Region Active
Toggles the region active state
Toggle Show Panel
Toggles whether the panel is being shown or not.
Update Interface
UpdateInterface main loop, checks the draggable, checks the region clicked, updates the interface
- Update Interface () [show]
UpdateInterface main loop, checks the draggable, checks the region clicked, updates the interface