uiProgressBar Struct Reference
A control that visualizes the progress of a task via the fill level of a horizontal bar. More...
#include <ui.h>
Inheritance diagram for uiProgressBar:
Public Member Functions | |
| int | uiProgressBarValue (uiProgressBar *p) |
| Returns the progress bar value. More... | |
| void | uiProgressBarSetValue (uiProgressBar *p, int n) |
| Sets the progress bar value. More... | |
| uiProgressBar * | uiNewProgressBar (void) |
| Creates a new progress bar. 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... | |
| 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... | |
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 that visualizes the progress of a task via the fill level of a horizontal bar.
Indeterminate values are supported via an animated bar.
Member Function Documentation
◆ uiNewProgressBar()
| uiProgressBar * uiNewProgressBar | ( | void | ) |
Creates a new progress bar.
- Returns
- A new uiProgressBar instance.
◆ uiProgressBarSetValue()
| 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].
◆ uiProgressBarValue()
| int uiProgressBarValue | ( | uiProgressBar * | p | ) |
Returns the progress bar value.
- Parameters
-
p uiProgressBar instance.
- Returns
- Progress bar value.
[Default 0]
The documentation for this struct was generated from the following file:
