Sliders
PBSlider
Opaque object handle:
This is a subclass of PBElement. You can safely cast from PBSlider to PBElement. To cast from PBElement to PBSlider, call PBSliderCast; this performs a runtime assertion to check the cast is possible. This function is thread-safe.
This object maintains an internal reference count. When the reference count reaches zero, the object will be automatically deallocated. To increment the reference count, call PBElementRetain; to decrement the reference count, call PBElementRelease. These functions are thread-safe.
PBSliderFlags
Enumeration/bitset of type uint32_t:
Constants
Or any of the values from PBElementFlags.
PBSliderTickMarkFlags
Enumeration/bitset of type uint32_t:
Constants
PBSliderTickMark_MAJOR
PBSliderTickMark_MAJOR = 1<<0
PBSliderTickMark
Structure:
Fields
position (double
):
rangeFrom (double
):
rangeTo (double
):
flags (PBSliderTickMarkFlags):
PBMessageSliderAdjustValue
Structure:
Fields
[in] action (PBKeyCode):
[in] previousValue (double
):
newValue (double
):
PBMessageSliderDrag
Structure:
Fields
[in] isDragging (bool
):
PBSliderCreate
Function:
Syntax (C/C++)
PBSliderPtr _Nullable PBSliderCreate(PBElementRef parent, PBSliderFlags flags,
double minimumValue, double maximumValue, double initialPosition);
Syntax (Python)
SliderCreate(parent, flags, minimumValue, maximumValue, initialPosition) -> (slider)
Parameters and Return Values
[in] parent (referenced PBElement):
[in] flags (PBSliderFlags):
[in] minimumValue (double
):
[in] maximumValue (double
):
[in] initialPosition (double
):
[out] slider (nullable owned PBSlider):
PBSliderSetPosition
Function:
Syntax (C/C++)
void PBSliderSetPosition(PBSliderRef slider, double newPosition,
bool sendValueChangedMessage);
Syntax (Python)
SliderSetPosition(slider, newPosition, sendValueChangedMessage)
Parameters and Return Values
[in] slider (referenced PBSlider):
[in] newPosition (double
):
[in] sendValueChangedMessage (bool
):
PBSliderGetPosition
Function:
Syntax (C/C++)
double PBSliderGetPosition(PBSliderRef slider);
Syntax (Python)
SliderGetPosition(slider) -> (currentPosition)
Parameters and Return Values
[in] slider (referenced PBSlider):
[out] currentPosition (double
):
PBSliderSetTickMarks
Function:
Syntax (C/C++)
void PBSliderSetTickMarks(PBSliderRef slider,
const PBSliderTickMark *_Nullable tickMarks, size_t tickMarksCount);
Syntax (Python)
SliderSetTickMarks(slider, tickMarks)
Parameters and Return Values
[in] slider (referenced PBSlider):
[in] tickMarks (referenced array of PBSliderTickMark):
PBSliderSetTickMarksEvenly
Function:
Syntax (C/C++)
void PBSliderSetTickMarksEvenly(PBSliderRef slider, uintptr_t numberOfTickMarks,
bool allowValuesBetweenTickMarks);
Syntax (Python)
SliderSetTickMarksEvenly(slider, numberOfTickMarks, allowValuesBetweenTickMarks)
Parameters and Return Values
[in] slider (referenced PBSlider):
[in] numberOfTickMarks (uintptr_t
):
[in] allowValuesBetweenTickMarks (bool
):
PBSliderPositionChildAtTickMark
Function:
Syntax (C/C++)
void PBSliderPositionChildAtTickMark(PBSliderRef slider,
PBElementRef childElementOfSlider, uintptr_t indexOfTickMarkToPositionAt);
Syntax (Python)
SliderPositionChildAtTickMark(slider, childElementOfSlider, indexOfTickMarkToPositionAt)
Parameters and Return Values
[in] slider (referenced PBSlider):
[in] childElementOfSlider (referenced PBElement):
[in] indexOfTickMarkToPositionAt (uintptr_t
):
PBSliderSetLabelForTickMark
Function:
Syntax (C/C++)
void PBSliderSetLabelForTickMark(PBSliderRef slider, ConstStr labelString,
uintptr_t indexOfTickMarkToPositionAt);
Syntax (Python)
SliderSetLabelForTickMark(slider, labelString, indexOfTickMarkToPositionAt)
Parameters and Return Values
[in] slider (referenced PBSlider):
[in] labelString (referenced string):
[in] indexOfTickMarkToPositionAt (uintptr_t
):