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

A boxlike container that holds a group of controls. More...

#include <ui.h>

Inheritance diagram for uiBox:
uiControl

Public Member Functions

void uiBoxAppend (uiBox *b, uiControl *child, int stretchy)
 Appends a control to the box. More...
 
int uiBoxNumChildren (uiBox *b)
 Returns the number of controls contained within the box. More...
 
void uiBoxDelete (uiBox *b, int index)
 Removes the control at index from the box. More...
 
int uiBoxPadded (uiBox *b)
 Returns whether or not controls within the box are padded. More...
 
void uiBoxSetPadded (uiBox *b, int padded)
 Sets whether or not controls within the box are padded. More...
 
uiBoxuiNewHorizontalBox (void)
 Creates a new horizontal box. More...
 
uiBoxuiNewVerticalBox (void)
 Creates a new vertical box. 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 boxlike container that holds a group of controls.

The contained controls are arranged to be displayed either horizontally or vertically next to each other.

Member Function Documentation

◆ uiBoxAppend()

void uiBoxAppend ( uiBox b,
uiControl child,
int  stretchy 
)

Appends a control to the box.

Stretchy items expand to use the remaining space within the box. In the case of multiple stretchy items the space is shared equally.

Parameters
buiBox instance.
childControl instance to append.
stretchyTRUE to stretch control, FALSE otherwise.

◆ uiBoxDelete()

void uiBoxDelete ( uiBox b,
int  index 
)

Removes the control at index from the box.

Parameters
buiBox instance.
indexIndex of control to be removed.
Note
The control neither destroyed nor freed.

◆ uiBoxNumChildren()

int uiBoxNumChildren ( uiBox b)

Returns the number of controls contained within the box.

Parameters
buiBox instance.
Returns
Number of children.

◆ uiBoxPadded()

int uiBoxPadded ( uiBox b)

Returns whether or not controls within the box are padded.

Padding is defined as space between individual controls.

Parameters
buiBox instance.
Returns
TRUE if controls are padded, FALSE otherwise. [Default: TODO]

◆ uiBoxSetPadded()

void uiBoxSetPadded ( uiBox b,
int  padded 
)

Sets whether or not controls within the box are padded.

Padding is defined as space between individual controls. The padding size is determined by the OS defaults.

Parameters
buiBox instance.
paddedTRUE to make controls padded, FALSE otherwise.

◆ uiNewHorizontalBox()

uiBox * uiNewHorizontalBox ( void  )

Creates a new horizontal box.

Controls within the box are placed next to each other horizontally.

Returns
A new uiBox instance.

◆ uiNewVerticalBox()

uiBox * uiNewVerticalBox ( void  )

Creates a new vertical box.

Controls within the box are placed next to each other vertically.

Returns
A new uiBox instance.

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