uiEditableCombobox Struct Reference

A control to select one item from a predefined list of items or enter ones own. More...

#include <ui.h>

Inheritance diagram for uiEditableCombobox:

Public Member Functions
void	uiEditableComboboxAppend (uiEditableCombobox *c, const char *text)
	Appends an item to the editable combo box. More...
char *	uiEditableComboboxText (uiEditableCombobox *c)
	Returns the text of the editable combo box. More...
void	uiEditableComboboxSetText (uiEditableCombobox *c, const char *text)
	Sets the editable combo box text. More...
void	uiEditableComboboxOnChanged (uiEditableCombobox *c, void(*f)(uiEditableCombobox *sender, void *senderData), void *data)
	Registers a callback for when an editable combo box item is selected or user text changed. More...
uiEditableCombobox *	uiNewEditableCombobox (void)
	Creates a new editable 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...
uiControl *	uiControlParent (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...
uiControl *	uiAllocControl (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 or enter ones own.

Predefined items can be selected from a drop down menu.

A customary item can be entered by the user via an editable text field.

See also

uiCombobox

Member Function Documentation

uiEditableComboboxAppend()

void uiEditableComboboxAppend	(	uiEditableCombobox *	c,
		const char *	text
	)

Appends an item to the editable combo box.

Parameters

c	uiEditableCombobox instance.
text	Item text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiEditableComboboxOnChanged()

void uiEditableComboboxOnChanged	(	uiEditableCombobox *	c,
		void(*)(uiEditableCombobox *sender, void *senderData)	f,
		void *	data
	)

Registers a callback for when an editable combo box item is selected or user text changed.

Parameters

c	uiEditableCombobox instance.
f	Callback function. sender Back reference to the instance that triggered the callback. senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

The callback is not triggered when calling uiEditableComboboxSetText().

Only one callback can be registered at a time.

uiEditableComboboxSetText()

void uiEditableComboboxSetText	(	uiEditableCombobox *	c,
		const char *	text
	)

Sets the editable combo box text.

Parameters

c	uiEditableCombobox instance.
text	Text field text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiEditableComboboxText()

char * uiEditableComboboxText

(

uiEditableCombobox *

c

)

Returns the text of the editable combo box.

This text is either the text of one of the predefined list items or the text manually entered by the user.

Parameters

c	uiEditableCombobox instance.

Returns

The editable combo box text.
A NUL terminated UTF-8 string.
Caller is responsible for freeing the data with uiFreeText().

uiNewEditableCombobox()

uiEditableCombobox * uiNewEditableCombobox

(

void

)

Creates a new editable combo box.

Returns

A new uiEditableCombobox instance.

---

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

• ui.h