v0.8.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
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

File Pickers

PBFilePickerFlags

Enumeration/bitset of type uint32_t:

Constants

PBFilePicker_ALLOW_VIRTUAL_ITEMS

PBFilePicker_ALLOW_VIRTUAL_ITEMS = 1<<0

PBFilePicker_MODE_OPEN_FILE

PBFilePicker_MODE_OPEN_FILE = 1<<28

PBFilePicker_MODE_OPEN_FILES

PBFilePicker_MODE_OPEN_FILES = 2<<28

PBFilePicker_MODE_OPEN_FOLDER

PBFilePicker_MODE_OPEN_FOLDER = 3<<28

PBFilePicker_MODE_OPEN_FOLDERS

PBFilePicker_MODE_OPEN_FOLDERS = 4<<28

PBFilePicker_MODE_SAVE_FILE

PBFilePicker_MODE_SAVE_FILE = 5<<28

PBFilePickerConfiguration

Structure:

Fields

persistKey (referenced string):

defaultFolder (referenced string):

flags (PBFilePickerFlags):

allowedFormats (referenced string):

context (PBUserContext):

PBFilePickerCompletionHandler

Callback:

Syntax (C/C++)

void PBFilePickerCompletionHandler(PBClipboardReaderRef _Nullable items, 
    PBUserContext context);

You can create a callback of this type from a function pointer with the above signature using PBFilePickerCompletionHandler_Make.

Syntax (Python)

FilePickerCompletionHandler(items, context)

Parameters and Return Values

[in] items (nullable referenced PBClipboardReader):

[in] context (PBUserContext):

PBFilePickerShow

Function:

Syntax (C/C++)

void PBFilePickerShow(PBWindowRef owner, PBFilePickerConfiguration configuration, 
    PBFilePickerCompletionHandler completionHandler);

Syntax (Python)

FilePickerShow(owner, configuration, completionHandler)

Parameters and Return Values

[in] owner (referenced PBWindow):

[in] configuration (PBFilePickerConfiguration):

[in] completionHandler (PBFilePickerCompletionHandler):