libui-ng
A portable GUI library for C
uiCombobox Struct Reference

A control to select one item from a predefined list of items via a drop down menu. More...

#include <ui.h>

Inheritance diagram for uiCombobox:
uiControl

Public Member Functions

void uiComboboxAppend (uiCombobox *c, const char *text)
 Appends an item to the combo box. More...
 
void uiComboboxInsertAt (uiCombobox *c, int index, const char *text)
 Inserts an item at index to the combo box. More...
 
void uiComboboxDelete (uiCombobox *c, int index)
 Deletes an item at index from the combo box. More...
 
void uiComboboxClear (uiCombobox *c)
 Deletes all items from the combo box. More...
 
int uiComboboxNumItems (uiCombobox *c)
 Returns the number of items contained within the combo box. More...
 
int uiComboboxSelected (uiCombobox *c)
 Returns the index of the item selected. More...
 
void uiComboboxSetSelected (uiCombobox *c, int index)
 Sets the item selected. More...
 
void uiComboboxOnSelected (uiCombobox *c, void(*f)(uiCombobox *sender, void *senderData), void *data)
 Registers a callback for when a combo box item is selected. More...
 
uiComboboxuiNewCombobox (void)
 Creates a new combo box. More...
 
- Public Member Functions inherited from uiControl
void uiControlDestroy (uiControl *c)
 Dispose and free all allocated resources. More...
 
uintptr_t uiControlHandle (uiControl *c)
 Returns the control's OS-level handle. More...
 
uiControluiControlParent (uiControl *c)
 Returns the parent control. More...
 
void uiControlSetParent (uiControl *c, uiControl *parent)
 Sets the control's parent. More...
 
int uiControlToplevel (uiControl *c)
 Returns whether or not the control is a top level control. More...
 
int uiControlVisible (uiControl *c)
 Returns whether or not the control is visible. More...
 
void uiControlShow (uiControl *c)
 Shows the control. More...
 
void uiControlHide (uiControl *c)
 Hides the control. More...
 
int uiControlEnabled (uiControl *c)
 Returns whether or not the control is enabled. More...
 
void uiControlEnable (uiControl *c)
 Enables the control. More...
 
void uiControlDisable (uiControl *c)
 Disables the control. More...
 
uiControluiAllocControl (size_t n, uint32_t OSsig, uint32_t typesig, const char *typenamestr)
 Allocates a uiControl. More...
 
void uiFreeControl (uiControl *c)
 Frees the memory associated with the control reference. More...
 
void uiControlVerifySetParent (uiControl *c, uiControl *parent)
 Makes sure the control's parent can be set to parent. More...
 
int uiControlEnabledToUser (uiControl *c)
 Returns whether or not the control can be interacted with by the user. More...
 

Additional Inherited Members

- Public Attributes inherited from uiControl
uint32_t Signature
 
uint32_t OSSignature
 
uint32_t TypeSignature
 
void(* Destroy )(uiControl *)
 
uintptr_t(* Handle )(uiControl *)
 
uiControl *(* Parent )(uiControl *)
 
void(* SetParent )(uiControl *, uiControl *)
 
int(* Toplevel )(uiControl *)
 
int(* Visible )(uiControl *)
 
void(* Show )(uiControl *)
 
void(* Hide )(uiControl *)
 
int(* Enabled )(uiControl *)
 
void(* Enable )(uiControl *)
 
void(* Disable )(uiControl *)
 

Detailed Description

A control to select one item from a predefined list of items via a drop down menu.

See also
uiEditableCombobox.

Member Function Documentation

◆ uiComboboxAppend()

void uiComboboxAppend ( uiCombobox c,
const char *  text 
)

Appends an item to the combo box.

Parameters
cuiCombobox instance.
textItem text.
A valid, NUL terminated UTF-8 string.
Data is copied internally. Ownership is not transferred.

◆ uiComboboxClear()

void uiComboboxClear ( uiCombobox c)

Deletes all items from the combo box.

Parameters
cuiCombobox instance.

◆ uiComboboxDelete()

void uiComboboxDelete ( uiCombobox c,
int  index 
)

Deletes an item at index from the combo box.

Note
Deleting the index of the item currently selected will move the selection to the next item in the combo box or -1 if no such item exists.
Parameters
cuiCombobox instance.
indexIndex of the item to be deleted.

◆ uiComboboxInsertAt()

void uiComboboxInsertAt ( uiCombobox c,
int  index,
const char *  text 
)

Inserts an item at index to the combo box.

Parameters
cuiCombobox instance.
indexIndex at which to insert the item.
textItem text.
A valid, NUL terminated UTF-8 string.
Data is copied internally. Ownership is not transferred.

◆ uiComboboxNumItems()

int uiComboboxNumItems ( uiCombobox c)

Returns the number of items contained within the combo box.

Parameters
cuiCombobox instance.
Returns
Number of items.

◆ uiComboboxOnSelected()

void uiComboboxOnSelected ( uiCombobox c,
void(*)(uiCombobox *sender, void *senderData)  f,
void *  data 
)

Registers a callback for when a combo box item is selected.

Parameters
cuiCombobox instance.
fCallback function.
sender Back reference to the instance that triggered the callback.
senderData User data registered with the sender instance.
dataUser data to be passed to the callback.
Note
The callback is not triggered when calling uiComboboxSetSelected(), uiComboboxInsertAt(), uiComboboxDelete(), or uiComboboxClear().
Only one callback can be registered at a time.

◆ uiComboboxSelected()

int uiComboboxSelected ( uiCombobox c)

Returns the index of the item selected.

Parameters
cuiCombobox instance.
Returns
Index of the item selected, -1 on empty selection. [Default -1]

◆ uiComboboxSetSelected()

void uiComboboxSetSelected ( uiCombobox c,
int  index 
)

Sets the item selected.

Parameters
cuiCombobox instance.
indexIndex of the item to be selected, -1 to clear selection.

◆ uiNewCombobox()

uiCombobox * uiNewCombobox ( void  )

Creates a new combo box.

Returns
A new uiCombobox instance.

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