uiRadioButtons Struct Reference

Description

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

#include <ui.h>

Public Member Functions
void	uiRadioButtonsAppend (uiRadioButtons *r, const char *text)
	Appends a radio button.
int	uiRadioButtonsSelected (uiRadioButtons *r)
	Returns the index of the item selected.
void	uiRadioButtonsSetSelected (uiRadioButtons *r, int index)
	Sets the item selected.
void	uiRadioButtonsOnSelected (uiRadioButtons *r, void(*f)(uiRadioButtons *sender, void *senderData), void *data)
	Registers a callback for when radio button is selected.
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
uiRadioButtons *	uiNewRadioButtons (void)
	Creates a new radio buttons instance.
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

uiNewRadioButtons()

uiRadioButtons * uiNewRadioButtons ( void )

static

Creates a new radio buttons instance.

Returns

A new uiRadioButtons instance.

uiRadioButtonsAppend()

void uiRadioButtonsAppend	(	uiRadioButtons *	r,
		const char *	text )

Appends a radio button.

Parameters

r	uiRadioButtons instance.
text	Radio button text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiRadioButtonsOnSelected()

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

Registers a callback for when radio button is selected.

Parameters

r	uiRadioButtons 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 uiRadioButtonsSetSelected().

Only one callback can be registered at a time.

uiRadioButtonsSelected()

int uiRadioButtonsSelected

(

uiRadioButtons *

r

)

Returns the index of the item selected.

Parameters

r	uiRadioButtons instance.

Returns

Index of the item selected, -1 on empty selection.

uiRadioButtonsSetSelected()

void uiRadioButtonsSetSelected	(	uiRadioButtons *	r,
		int	index )

Sets the item selected.

Parameters

r	uiRadioButtons instance.
index	Index of the item to be selected, -1 to clear selection.

---

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

• include/ui.h