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

Handoff

PBMessageHandoffSave

Structure:

Fields

[in] store (referenced PBValueStore): A value store into which elements can save state information. The data will be made available during restore.

PBMessageHandoffRestore

Structure:

Fields

[in] store (referenced PBValueStore): A value store into which elements can load state information.

PBWindowSetRestoreString

Function: Set a run command that can be used to recreate the window after restarting the workspace.

Syntax (C/C++)

void PBWindowSetRestoreString(PBWindowRef window, 
    const ConstStr *_Nullable runArguments, size_t runArgumentsCount);

Syntax (Python)

WindowSetRestoreString(window, runArguments)

Parameters and Return Values

[in] window (referenced PBWindow): The window to be recreated.

[in] runArguments (referenced array of referenced string): The run string that the system should pass to PBWorkspaceRunSplit.

Discussion

This function is called automatically if the window is registered as a file editor with PBWindowUseAsFileEditor.