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

Workspace IPC

PBWorkspaceRunFlags

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

Constants

PBWorkspaceRun_ACTIVATE_ONLY

PBWorkspaceRun_ACTIVATE_ONLY = 1<<0

(not documented yet)

PBWorkspaceRun_CONNECT

PBWorkspaceRun_CONNECT = 1<<1

(not documented yet)

PBWorkspaceRunConfiguration

Structure: (not documented yet)

Fields

flags (PBWorkspaceRunFlags): Flags bitwise OR-ed together controlling the run command.

embeddedViewID (uint64_t): 0 if the new window should not be embedded. Otherwise, set this to the ID of the embedded view in which to show the created window, from PBEmbeddedViewGetID.

PBWorkspaceRun

Function: (not documented yet)

Syntax (C/C++)

bool PBWorkspaceRun(ConstStr runCommand, PBWorkspaceRunFlags flags, 
    /* output */ uint64_t * _Nullable __restrict windowID);

Syntax (Python)

WorkspaceRun(runCommand, flags) -> (success, windowID)

Parameters and Return Values

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

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

[out] success (bool): (not documented yet)

[optional-out] windowID (uint64_t): (not documented yet)

PBWorkspaceRun2

Function: (not documented yet)

Syntax (C/C++)

bool PBWorkspaceRun2(ConstStr runCommand, 
    const PBWorkspaceRunConfiguration * __restrict configuration, 
    /* output */ uint64_t * _Nullable __restrict windowID);

Syntax (Python)

WorkspaceRun2(runCommand, configuration) -> (success, windowID)

Parameters and Return Values

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

[in] configuration (PBWorkspaceRunConfiguration): (not documented yet)

[out] success (bool): (not documented yet)

[optional-out] windowID (uint64_t): (not documented yet)

PBWorkspaceRunSplit

Function: (not documented yet)

Syntax (C/C++)

bool PBWorkspaceRunSplit(
    const ConstStr *_Nullable runArguments, size_t runArgumentsCount, 
    PBWorkspaceRunFlags flags, /* output */ uint64_t * _Nullable __restrict windowID);

Syntax (Python)

WorkspaceRunSplit(runArguments, flags) -> (success, windowID)

Parameters and Return Values

[in] runArguments (referenced array of referenced string): (not documented yet)

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

[out] success (bool): (not documented yet)

[optional-out] windowID (uint64_t): (not documented yet)

PBWorkspaceIsProtocolHandled

Function: (not documented yet)

Syntax (C/C++)

bool PBWorkspaceIsProtocolHandled(ConstStr protocol);

Syntax (Python)

WorkspaceIsProtocolHandled(protocol) -> (isHandled)

Parameters and Return Values

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

[out] isHandled (bool): (not documented yet)