GalDev:Client2SigSlot

From Starsonata Wiki
Jump to: navigation, search

GUI Element Signals

(Note on "item based" elements. These include listbox, combobox, table, contextmenu and generally any element that holds a list of items. For tables "item" generally refers to a row.)

value_changed: (Param is core::stringw) Sent by all gui elements when the value changes. For scrollbars and such this would be the numerical value in the form of a string, and for item-based elements such as list it will send the text of the selected item (Not the user data) if an item is selected.

checkbox_checked: (No params) Sent by a checkbox when it becomes checked.

checkbox_unchecked: (No params) Sent by a checkbox when it becomes unchecked.

button_clicked: (No params) Sent by a button when a button is clicked. Specifically this means that the button was held down and then the mouse was released over the button comfirming the action.

button_down: (No params) Sent by a button when it is held down for the first time.

button_up: (No params) Sent by a button when it is released (Even if the mouse is not over the button).

item_selected_text: (Param is core::stringw) Sent by item based elements when a new item is selected. It sends the text of the new item.

item_selected_index: (Param is core::stringw) Sent by item based elements when a new item is selected. It sends the numerical index in the form of a string of the new item.

item_selected_data: (Param is core::stringw) Sent by item based elements when a new item is selected. It sends the user data in the form of a string of the new item.

hidden: (No params) Sent when a gui element is set non-visible (Not sent when it's destroyed!).

revealed: (No params) Sent when a gui element was previously non-visible and is now visible (Not sent when it's created).

created: (No params) Sent when a gui element is first created.

GUI Element Slots

setText: (Param is core::stringw) Takes a string and uses it to set the element data. For item-based elements each item will be seperated by a delimiter. For tables each field separated by a delimiter indicates a cell and the data will wrap around to a new row based on the number of columns. For scrollbars and such this will be the numerical value in the form of a string.

setUserData: (Param is core::stringw) Takes a string and uses it to set the element user data. For item-based elements each item will be seperated by a delimiter. For tables each field separated by a delimiter indicates a cell and the data will wrap around to a new row based on the number of columns.