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

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

#include <ui.h>

Inheritance diagram for uiCheckbox:
uiControl

Public Member Functions

char * uiCheckboxText (uiCheckbox *c)
 Returns the checkbox label text. More...
 
void uiCheckboxSetText (uiCheckbox *c, const char *text)
 Sets the checkbox label text. More...
 
void uiCheckboxOnToggled (uiCheckbox *c, void(*f)(uiCheckbox *sender, void *senderData), void *data)
 Registers a callback for when the checkbox is toggled by the user. More...
 
int uiCheckboxChecked (uiCheckbox *c)
 Returns whether or the checkbox is checked. More...
 
void uiCheckboxSetChecked (uiCheckbox *c, int checked)
 Sets whether or not the checkbox is checked. More...
 
uiCheckboxuiNewCheckbox (const char *text)
 Creates a new checkbox. 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 with a user checkable box accompanied by a text label.

Member Function Documentation

◆ uiCheckboxChecked()

int uiCheckboxChecked ( uiCheckbox c)

Returns whether or the checkbox is checked.

Parameters
cuiCheckbox instance.
Returns
TRUE if checked, FALSE otherwise. [Default: FALSE]

◆ uiCheckboxOnToggled()

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

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

Parameters
cuiCheckbox instance.
fCallback function.
sender Back reference to the instance that initiated 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 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
cuiCheckbox instance.
checkedTRUE to check box, FALSE otherwise.

◆ uiCheckboxSetText()

void uiCheckboxSetText ( uiCheckbox c,
const char *  text 
)

Sets the checkbox label text.

Parameters
cuiCheckbox instance.
textLabel 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
cuiCheckbox 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)

Creates a new checkbox.

Parameters
textLabel 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: