Base class for GUI controls providing common methods. More...

#include <ui.h>

Inheritance diagram for uiControl:

Public Member Functions
void	uiControlDestroy (uiControl *c)
	Dispose and free all allocated resources. More...

void	uiControlOnDestroyed (uiControl c, void(f)(uiControl c, void data), void *data)
	Registers a function to be called when the control is destroyed. More...

uintptr_t	uiControlHandle (uiControl *c)
	Returns the control's OS-level handle. More...

uiControl *	uiControlParent (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...

uiControl *	uiAllocControl (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...

Public Attributes
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

Base class for GUI controls providing common methods.

Member Function Documentation

◆ uiAllocControl()

uiControl * uiAllocControl	(	size_t	n,
		uint32_t	OSsig,
		uint32_t	typesig,
		const char *	typenamestr
	)

Allocates a uiControl.

Helper to allocate new controls.

Parameters

n	Size of type to allocate.

Todo:: Document parameters

◆ uiControlDestroy()

void uiControlDestroy ( uiControl * c )

Dispose and free all allocated resources.

The platform specific APIs that actually destroy a control (and its children) are called. If called from a user callback, destruction is deferred to the main event loop so the native event handler can finish first. The control is hidden and notification callbacks are suppressed immediately. Outside a user callback, destruction remains synchronous.

Note: Most of the time is needed to be used directly only on the top level windows.

Parameters

c	uiControl instance.

Todo:: Document ownership.

◆ uiControlDisable()

void uiControlDisable ( uiControl * c )

Disables the control.

Parameters

c	uiControl instance.

◆ uiControlEnable()

void uiControlEnable ( uiControl * c )

Enables the control.

Parameters

c	uiControl instance.

◆ uiControlEnabled()

int uiControlEnabled ( uiControl * c )

Returns whether or not the control is enabled.

Defaults to true.

Parameters

c	uiControl instance.

See also: uiControlEnabledToUser

◆ uiControlEnabledToUser()

int uiControlEnabledToUser ( uiControl * c )

Returns whether or not the control can be interacted with by the user.

Checks if the control and all it's parents are enabled to make sure it can be interacted with by the user.

Parameters

c	uiControl instance.

Returns: TRUE if enabled, FALSE otherwise.

See also: uiControlEnabled

◆ uiControlHandle()

uintptr_t uiControlHandle ( uiControl * c )

Returns the control's OS-level handle.

Parameters

c	uiControl instance.

Returns: OS-level handle.

◆ uiControlHide()

void uiControlHide ( uiControl * c )

Hides the control.

Parameters

c	uiControl instance.

Note: Hidden controls do not take up space within the layout.

◆ uiControlOnDestroyed()

void uiControlOnDestroyed	(	uiControl *	c,
		void()(uiControl c, void *data)	f,
		void *	data
	)

Registers a function to be called when the control is destroyed.

The function is called from uiFreeControl(), after platform resources have been released and immediately before the control's storage is freed. It is also called for a child destroyed as part of destroying its parent. Calling this function again replaces the previous function; pass NULL for f to remove it.

Parameters

c	uiControl instance.
f	Function to call, or `NULL` to remove the current function.
data	Data to pass to `f`.

◆ uiControlParent()

uiControl * uiControlParent ( uiControl * c )

Returns the parent control.

Parameters

c	uiControl instance.

Returns: The parent control, NULL if detached.

◆ uiControlSetParent()

void uiControlSetParent	(	uiControl *	c,
		uiControl *	parent
	)

Sets the control's parent.

Parameters

c	uiControl instance.
parent	The parent control, `NULL` to detach.

Todo:: Document ownership.

◆ uiControlShow()

void uiControlShow ( uiControl * c )

Shows the control.

Parameters

c	uiControl instance.

◆ uiControlToplevel()

int uiControlToplevel ( uiControl * c )

Returns whether or not the control is a top level control.

Parameters

c	uiControl instance.

Returns: TRUE if top level control, FALSE otherwise.

◆ uiControlVerifySetParent()

void uiControlVerifySetParent	(	uiControl *	c,
		uiControl *	parent
	)

Makes sure the control's parent can be set to parent.

Parameters

c	uiControl instance.
parent	uiControl instance.

Warning: This will crash the application if FALSE.

◆ uiControlVisible()

int uiControlVisible ( uiControl * c )

Returns whether or not the control is visible.

Parameters

c	uiControl instance.

Returns: TRUE if visible, FALSE otherwise.

◆ uiFreeControl()

void uiFreeControl ( uiControl * c )

Frees the memory associated with the control reference.

Note: This method is public only for writing custom controls.

Parameters

c	uiControl instance.

Member Data Documentation

◆ Destroy

void(* uiControl::Destroy) (uiControl *)

◆ Disable

void(* uiControl::Disable) (uiControl *)

◆ Enable

void(* uiControl::Enable) (uiControl *)

◆ Enabled

int(* uiControl::Enabled) (uiControl *)

◆ Handle

uintptr_t(* uiControl::Handle) (uiControl *)

◆ Hide

void(* uiControl::Hide) (uiControl *)

◆ OSSignature

uint32_t uiControl::OSSignature

◆ Parent

uiControl *(* uiControl::Parent) (uiControl *)

◆ SetParent

void(* uiControl::SetParent) (uiControl *, uiControl *)

◆ Show

void(* uiControl::Show) (uiControl *)

◆ Signature

uint32_t uiControl::Signature

◆ Toplevel

int(* uiControl::Toplevel) (uiControl *)

◆ TypeSignature

uint32_t uiControl::TypeSignature

◆ Visible

int(* uiControl::Visible) (uiControl *)

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

ui.h

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ uiAllocControl()

◆ uiControlDestroy()

◆ uiControlDisable()

◆ uiControlEnable()

◆ uiControlEnabled()

◆ uiControlEnabledToUser()

◆ uiControlHandle()

◆ uiControlHide()

◆ uiControlOnDestroyed()

◆ uiControlParent()

◆ uiControlSetParent()

◆ uiControlShow()

◆ uiControlToplevel()

◆ uiControlVerifySetParent()

◆ uiControlVisible()

◆ uiFreeControl()

Member Data Documentation

◆ Destroy

◆ Disable

◆ Enable

◆ Enabled

◆ Handle

◆ Hide

◆ OSSignature

◆ Parent

◆ SetParent

◆ Show

◆ Signature

◆ Toplevel

◆ TypeSignature

◆ Visible