libui-ng
A portable GUI library for C
|
A control to display and modify integer values via a user draggable slider. More...
#include <ui.h>
Public Member Functions | |
int | uiSliderValue (uiSlider *s) |
Returns the slider value. More... | |
void | uiSliderSetValue (uiSlider *s, int value) |
Sets the slider value. More... | |
int | uiSliderHasToolTip (uiSlider *s) |
Returns whether or not the slider has a tool tip. More... | |
void | uiSliderSetHasToolTip (uiSlider *s, int hasToolTip) |
Sets whether or not the slider has a tool tip. More... | |
void | uiSliderOnChanged (uiSlider *s, void(*f)(uiSlider *sender, void *senderData), void *data) |
Registers a callback for when the slider value is changed by the user. More... | |
void | uiSliderOnReleased (uiSlider *s, void(*f)(uiSlider *sender, void *senderData), void *data) |
Registers a callback for when the slider is released from dragging. More... | |
void | uiSliderSetRange (uiSlider *s, int min, int max) |
Sets the slider range. More... | |
uiSlider * | uiNewSlider (int min, int max) |
Creates a new slider. 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 *) |
A control to display and modify integer values via a user draggable slider.
Values are guaranteed to be within the specified range.
Sliders by default display a tool tip showing the current value when being dragged.
Sliders are horizontal only.
uiSlider * uiNewSlider | ( | int | min, |
int | max | ||
) |
Creates a new slider.
The initial slider value equals the minimum value.
In the current implementation min
and max
are swapped if min>max
. This may change in the future though. See TODO.
min | Minimum value. |
max | Maximum value. |
int uiSliderHasToolTip | ( | uiSlider * | s | ) |
Returns whether or not the slider has a tool tip.
s | uiSlider instance. |
TRUE
if a tool tip is present, FALSE
otherwise. [Default TRUE
] Registers a callback for when the slider value is changed by the user.
s | uiSlider instance. |
f | Callback function.sender Back reference to the instance that triggered the callback.senderData User data registered with the sender instance. |
data | User data to be passed to the callback. |
void uiSliderOnReleased | ( | uiSlider * | s, |
void(*)(uiSlider *sender, void *senderData) | f, | ||
void * | data | ||
) |
Registers a callback for when the slider is released from dragging.
s | uiSlider instance. |
f | Callback function.sender Back reference to the instance that triggered the callback.senderData User data registered with the sender instance. |
data | User data to be passed to the callback. |
void uiSliderSetHasToolTip | ( | uiSlider * | s, |
int | hasToolTip | ||
) |
Sets whether or not the slider has a tool tip.
s | uiSlider instance. |
hasToolTip | TRUE to display a tool tip, FALSE to display no tool tip. |
void uiSliderSetRange | ( | uiSlider * | s, |
int | min, | ||
int | max | ||
) |
Sets the slider range.
s | uiSlider instance. |
min | Minimum value. |
max | Maximum value. |
void uiSliderSetValue | ( | uiSlider * | s, |
int | value | ||
) |
Sets the slider value.
s | uiSlider intance. |
value | Value to set. |
int uiSliderValue | ( | uiSlider * | s | ) |