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

A multiple choice control of check buttons from which only one can be selected at a time. More...

#include <ui.h>

Inheritance diagram for uiRadioButtons:
uiControl

Public Member Functions

void uiRadioButtonsAppend (uiRadioButtons *r, const char *text)
 Appends a radio button. More...
 
int uiRadioButtonsSelected (uiRadioButtons *r)
 Returns the index of the item selected. More...
 
void uiRadioButtonsSetSelected (uiRadioButtons *r, int index)
 Sets the item selected. More...
 
void uiRadioButtonsOnSelected (uiRadioButtons *r, void(*f)(uiRadioButtons *sender, void *senderData), void *data)
 Registers a callback for when radio button is selected. More...
 
uiRadioButtonsuiNewRadioButtons (void)
 Creates a new radio buttons instance. 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 multiple choice control of check buttons from which only one can be selected at a time.

Member Function Documentation

◆ uiNewRadioButtons()

uiRadioButtons * uiNewRadioButtons ( void  )

Creates a new radio buttons instance.

Returns
A new uiRadioButtons instance.

◆ uiRadioButtonsAppend()

void uiRadioButtonsAppend ( uiRadioButtons r,
const char *  text 
)

Appends a radio button.

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

◆ uiRadioButtonsOnSelected()

void uiRadioButtonsOnSelected ( uiRadioButtons r,
void(*)(uiRadioButtons *sender, void *senderData)  f,
void *  data 
)

Registers a callback for when radio button is selected.

Parameters
ruiRadioButtons 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 uiRadioButtonsSetSelected().
Only one callback can be registered at a time.

◆ uiRadioButtonsSelected()

int uiRadioButtonsSelected ( uiRadioButtons r)

Returns the index of the item selected.

Parameters
ruiRadioButtons instance.
Returns
Index of the item selected, -1 on empty selection.

◆ uiRadioButtonsSetSelected()

void uiRadioButtonsSetSelected ( uiRadioButtons r,
int  index 
)

Sets the item selected.

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

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