playbit API documentation

v0.10.0
⌘P
Go-to Page: ⌘G

Guide

All UI Elements
App Bundles
libplaybit API Conventions
Frequently Asked Questions
Input Event Routing
Standard UI Layout
Text Controls
Text Styling

API Reference

Accessibility and Automation
Alerts
Buttons
Checkboxes
Clipboard
Colors
Commands and Command Lists
Common Definitions
Configuration
Data Streams
Display Screens
Drag and Drop
Drawing
Element Hierarchy
Element Interaction
Element Layout and Painting
Element Messaging
Element Properties
Element User Data
Event Loop
File Editors
File Pickers
Handoff
Image Displays
Images
Input Devices
Layout Columns and Rows
Layout Grids
Layout Wraps
Live Debug
Log Views
Notifications
Pop-Up Buttons
Progress Indicators
Radio Button Groups
Rectangles
Render Surfaces
Resizable Panels
Run-time Helpers
Scrolling
Shared Nodes
Size Constraint Panels
Sliders
Styling
Table Views
Text Displays
Text Documents
Text Input Fields
Text Plans
Text Styles
Tool Tips
Transition Panels
Value Stores
Virtual Text Views
Windows
Workspace IPC

Sliders

PBSlider

Opaque object handle: (not documented yet)

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: (not documented yet)

Constants

Or any of the values from PBElementFlags.

PBSliderTickMarkFlags

Enumeration/bitset of type uint32_t: (not documented yet)

Constants

PBSliderTickMark_MAJOR

PBSliderTickMark_MAJOR = 1<<0

(not documented yet)

PBSliderTickMark

Structure: (not documented yet)

Fields

position (double): (not documented yet)

rangeFrom (double): (not documented yet)

rangeTo (double): (not documented yet)

flags (PBSliderTickMarkFlags): (not documented yet)

PBMessageSliderAdjustValue

Structure: (not documented yet)

Fields

[in] action (PBKeyCode): (not documented yet)

[in] previousValue (double): (not documented yet)

newValue (double): (not documented yet)

PBMessageSliderDrag

Structure: (not documented yet)

Fields

[in] isDragging (bool): (not documented yet)

PBSliderCreate

Function: (not documented yet)

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): (not documented yet)

[in] flags (PBSliderFlags): (not documented yet)

[in] minimumValue (double): (not documented yet)

[in] maximumValue (double): (not documented yet)

[in] initialPosition (double): (not documented yet)

[out] slider (nullable owned PBSlider): (not documented yet)

PBSliderSetPosition

Function: (not documented yet)

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): (not documented yet)

[in] newPosition (double): (not documented yet)

[in] sendValueChangedMessage (bool): (not documented yet)

PBSliderGetPosition

Function: (not documented yet)

Syntax (C/C++)

double PBSliderGetPosition(PBSliderRef slider);

Syntax (Python)

SliderGetPosition(slider) -> (currentPosition)

Parameters and Return Values

[in] slider (referenced PBSlider): (not documented yet)

[out] currentPosition (double): (not documented yet)

PBSliderSetTickMarks

Function: (not documented yet)

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): (not documented yet)

[in] tickMarks (referenced array of PBSliderTickMark): (not documented yet)

PBSliderSetTickMarksEvenly

Function: (not documented yet)

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): (not documented yet)

[in] numberOfTickMarks (uintptr_t): (not documented yet)

[in] allowValuesBetweenTickMarks (bool): (not documented yet)

PBSliderPositionChildAtTickMark

Function: (not documented yet)

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): (not documented yet)

[in] childElementOfSlider (referenced PBElement): (not documented yet)

[in] indexOfTickMarkToPositionAt (uintptr_t): (not documented yet)

PBSliderSetLabelForTickMark

Function: (not documented yet)

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): (not documented yet)

[in] labelString (referenced string): (not documented yet)

[in] indexOfTickMarkToPositionAt (uintptr_t): (not documented yet)