Description

A control that visualizes the progress of a task via the fill level of a horizontal bar.

Indeterminate values are supported via an animated bar.

#include <ui.h>

Public Member Functions
int	uiProgressBarValue (uiProgressBar *p)
	Returns the progress bar value.

void	uiProgressBarSetValue (uiProgressBar *p, int n)
	Sets the progress bar value.

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
uiProgressBar *	uiNewProgressBar (void)
	Creates a new progress bar.

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

uiProgressBar * uiNewProgressBar ( void )

static

Creates a new progress bar.

void uiProgressBarSetValue	(	uiProgressBar *	p,
		int	n )

Sets the progress bar value.

Valid values are [0, 100] for displaying a solid bar imitating a percent value.

Use a value of -1 to render an animated bar to convey an indeterminate value.

Parameters

p	uiProgressBar instance.
n	Value to set. Integer in the range of `[-1, 100]`.

int uiProgressBarValue ( uiProgressBar * p )

Returns the progress bar value.

Parameters

p	uiProgressBar instance.

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