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

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

#include <ui.h>

Inheritance diagram for uiGroup:
uiControl

Public Member Functions

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

Member Function Documentation

◆ uiGroupMargined()

int uiGroupMargined ( uiGroup g)

Returns whether or not the group has a margin.

Parameters
guiGroup 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
guiGroup instance.
cuiControl 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
guiGroup instance.
marginedTRUE to set a margin, FALSE otherwise.

◆ uiGroupSetTitle()

void uiGroupSetTitle ( uiGroup g,
const char *  title 
)

Sets the group title.

Parameters
guiGroup instance.
titleGroup 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
guiGroup 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)

Creates a new group.

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