playbit API documentation

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

Guide

All UI Elements
App Bundles
libplaybit API Conventions
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

Drag and Drop

PBMessageDNDInfo

Structure:

Fields

[in] x (int32_t):

[in] y (int32_t):

[in] clipboard (referenced PBClipboardReader):

[in] modifiers (PBModifierKeys):

PBDNDImage

Structure:

Fields

surface (referenced PBRenderSurface):

dx (int32_t):

dy (int32_t):

PBDNDAction

Enumeration/bitset of type uint32_t:

Constants

PBDNDAction_MOVE

PBDNDAction_MOVE = 1<<0

PBDNDAction_COPY

PBDNDAction_COPY = 1<<1

PBDNDAction_LINK = 1<<2

PBDNDAction_OPEN_WITH

PBDNDAction_OPEN_WITH = 1<<3

PBDNDStart

Function:

Syntax (C/C++)

void PBDNDStart(PBElementRef sourceElement, PBClipboardWriterPtr clipboardWriter, 
    PBDNDImage dragImage);

Syntax (Python)

DNDStart(sourceElement, clipboardWriter, dragImage)

Parameters and Return Values

[in] sourceElement (referenced PBElement):

[in] clipboardWriter (owned PBClipboardWriter):

[in] dragImage (PBDNDImage):

PBDNDSetFeedback

Function:

Syntax (C/C++)

void PBDNDSetFeedback(PBDNDAction action, PBTextDocumentRef informationText);

Syntax (Python)

DNDSetFeedback(action, informationText)

Parameters and Return Values

[in] action (PBDNDAction):

[in] informationText (referenced PBTextDocument):

PBDNDIsSourceElement

Function:

Syntax (C/C++)

bool PBDNDIsSourceElement(PBElementRef element);

Syntax (Python)

DNDIsSourceElement(element) -> (isSourceElement)

Parameters and Return Values

[in] element (referenced PBElement):

[out] isSourceElement (bool):