uiCheckbox Struct Reference

Description

A control with a user checkable box accompanied by a text label.

#include <ui.h>

Public Member Functions
char *	uiCheckboxText (uiCheckbox *c)
	Returns the checkbox label text.
void	uiCheckboxSetText (uiCheckbox *c, const char *text)
	Sets the checkbox label text.
void	uiCheckboxOnToggled (uiCheckbox *c, void(*f)(uiCheckbox *sender, void *senderData), void *data)
	Registers a callback for when the checkbox is toggled by the user.
int	uiCheckboxChecked (uiCheckbox *c)
	Returns whether or the checkbox is checked.
void	uiCheckboxSetChecked (uiCheckbox *c, int checked)
	Sets whether or not the checkbox is checked.
Public Member Functions inherited from uiControl
void	uiControlDestroy (uiControl *c)
	Dispose and free all allocated resources.
uintptr_t	uiControlHandle (uiControl *c)
	Returns the control's OS-level handle.
uiControl *	uiControlParent (uiControl *c)
	Returns the parent control.
void	uiControlSetParent (uiControl *c, uiControl *parent)
	Sets the control's parent.
int	uiControlToplevel (uiControl *c)
	Returns whether or not the control is a top level control.
int	uiControlVisible (uiControl *c)
	Returns whether or not the control is visible.
void	uiControlShow (uiControl *c)
	Shows the control.
void	uiControlHide (uiControl *c)
	Hides the control.
int	uiControlEnabled (uiControl *c)
	Returns whether or not the control is enabled.
void	uiControlEnable (uiControl *c)
	Enables the control.
void	uiControlDisable (uiControl *c)
	Disables the control.
void	uiFreeControl (uiControl *c)
	Frees the memory associated with the control reference.
void	uiControlVerifySetParent (uiControl *c, uiControl *parent)
	Makes sure the control's parent can be set to parent.
int	uiControlEnabledToUser (uiControl *c)
	Returns whether or not the control can be interacted with by the user.
void	uiControlSetTooltip (uiControl *c, const char *tooltip)
	Sets the control tooltip.

Static Public Member Functions
uiCheckbox *	uiNewCheckbox (const char *text)
	Creates a new checkbox.
Static Public Member Functions inherited from uiControl
uiControl *	uiAllocControl (size_t n, uint32_t OSsig, uint32_t typesig, const char *typenamestr)
	Allocates a uiControl.

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 *)

Member Function Documentation

uiCheckboxChecked()

int uiCheckboxChecked

(

uiCheckbox *

c

)

Returns whether or the checkbox is checked.

Parameters

c	uiCheckbox instance.

Returns

TRUE if checked, FALSE otherwise. [Default: FALSE]

uiCheckboxOnToggled()

void uiCheckboxOnToggled	(	uiCheckbox *	c,
		void(*	f )(uiCheckbox *sender, void *senderData),
		void *	data )

Registers a callback for when the checkbox is toggled by the user.

Parameters

c	uiCheckbox instance.
f	Callback function. sender Back reference to the instance that initiated 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 uiCheckboxSetChecked().

Only one callback can be registered at a time.

uiCheckboxSetChecked()

void uiCheckboxSetChecked	(	uiCheckbox *	c,
		int	checked )

Sets whether or not the checkbox is checked.

Parameters

c	uiCheckbox instance.
checked	TRUE to check box, FALSE otherwise.

uiCheckboxSetText()

void uiCheckboxSetText	(	uiCheckbox *	c,
		const char *	text )

Sets the checkbox label text.

Parameters

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

uiCheckboxText()

char * uiCheckboxText

(

uiCheckbox *

c

)

Returns the checkbox label text.

Parameters

c	uiCheckbox instance.

Returns

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

uiNewCheckbox()

uiCheckbox * uiNewCheckbox ( const char * text )

static

Creates a new checkbox.

Parameters

text	Label text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

Returns

A new uiCheckbox instance.

---

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

• include/ui.h