uiLabel Struct Reference

Description

A control that displays non interactive text.

#include <ui.h>

Public Member Functions
char *	uiLabelText (uiLabel *l)
	Returns the label text.
void	uiLabelSetText (uiLabel *l, const char *text)
	Sets the label text.
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
uiLabel *	uiNewLabel (const char *text)
	Creates a new label.
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

uiLabelSetText()

void uiLabelSetText	(	uiLabel *	l,
		const char *	text )

Sets the label text.

Parameters

l	uiLabel instance.
text	Label text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiLabelText()

char * uiLabelText

(

uiLabel *

l

)

Returns the label text.

Parameters

l	uiLabel instance.

Returns

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

uiNewLabel()

uiLabel * uiNewLabel ( const char * text )

static

Creates a new label.

Parameters

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

Returns

A new uiLabel instance.

---

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

• include/ui.h