uiGroup Struct Reference

Description

A control container that adds a label to the contained child control.

This control is a great way of grouping related controls in combination with uiBox.

A visual box will or will not be drawn around the child control dependent on the underlying OS implementation.

#include <ui.h>

Public Member Functions
char *	uiGroupTitle (uiGroup *g)
	Returns the group title.
void	uiGroupSetTitle (uiGroup *g, const char *title)
	Sets the group title.
void	uiGroupSetChild (uiGroup *g, uiControl *c)
	Sets the group's child.
int	uiGroupMargined (uiGroup *g)
	Returns whether or not the group has a margin.
void	uiGroupSetMargined (uiGroup *g, int margined)
	Sets whether or not the group has a margin.
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
uiGroup *	uiNewGroup (const char *title)
	Creates a new group.
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

uiGroupMargined()

int uiGroupMargined

(

uiGroup *

g

)

Returns whether or not the group has a margin.

Parameters

g	uiGroup instance.

Returns

TRUE if the group has a margin, FALSE otherwise. [Default: TODO]

uiGroupSetChild()

void uiGroupSetChild	(	uiGroup *	g,
		uiControl *	c )

Sets the group's child.

Parameters

g	uiGroup instance.
c	uiControl child instance, or NULL.

uiGroupSetMargined()

void uiGroupSetMargined	(	uiGroup *	g,
		int	margined )

Sets whether or not the group has a margin.

The margin size is determined by the OS defaults.

Parameters

g	uiGroup instance.
margined	TRUE to set a margin, FALSE otherwise.

uiGroupSetTitle()

void uiGroupSetTitle	(	uiGroup *	g,
		const char *	title )

Sets the group title.

Parameters

g	uiGroup instance.
title	Group title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiGroupTitle()

char * uiGroupTitle

(

uiGroup *

g

)

Returns the group title.

Parameters

g	uiGroup instance.

Returns

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

uiNewGroup()

uiGroup * uiNewGroup ( const char * title )

static

Creates a new group.

Parameters

title

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

Returns

A new uiGroup instance.

---

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

• include/ui.h