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

Table Views

PBTableView

Opaque object handle: (not documented yet)

This is a subclass of PBElement. You can safely cast from PBTableView to PBElement. To cast from PBElement to PBTableView, call PBTableViewCast; 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.

PBTableSelectionAction

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

Constants

PBTableSelectionAction_DESELECT

PBTableSelectionAction_DESELECT = 0

(not documented yet)

PBTableSelectionAction_TOGGLE

PBTableSelectionAction_TOGGLE = 1

(not documented yet)

PBTableSelectionAction_SELECT_ADD

PBTableSelectionAction_SELECT_ADD = 2

(not documented yet)

PBTableSelectionAction_SELECT_ONLY

PBTableSelectionAction_SELECT_ONLY = 3

(not documented yet)

PBTableViewFlags

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

Constants

PBTableView_NO_HEADER

PBTableView_NO_HEADER = 1<<1

If set, the column headers are not displayed.

Or any of the values from PBElementFlags.

PBTableViewColumnFlags

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

Constants

PBTableViewColumn_TABULAR_NUMERALS

PBTableViewColumn_TABULAR_NUMERALS = 1<<0

(not documented yet)

PBTableViewColumn_RIGHT_ALIGN_CELLS

PBTableViewColumn_RIGHT_ALIGN_CELLS = 1<<1

(not documented yet)

PBTableViewColumn_FILL_REMAINING_SPACE

PBTableViewColumn_FILL_REMAINING_SPACE = 1<<2

(not documented yet)

PBTableSelectionRange

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

Constants

PBTableSelectionRange_SINGLE

PBTableSelectionRange_SINGLE = 0

(not documented yet)

PBTableSelectionRange_ALL

PBTableSelectionRange_ALL = 1

(not documented yet)

PBTableSelectionRange_TO_FOCUSED

PBTableSelectionRange_TO_FOCUSED = 2

(not documented yet)

PBTableViewSetFocusedItemFlags

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

Constants

PBTableViewSetFocusedItem_MODIFY_SELECTION

PBTableViewSetFocusedItem_MODIFY_SELECTION = 1<<0

(not documented yet)

PBTableViewSetFocusedItem_CTRL_HELD

PBTableViewSetFocusedItem_CTRL_HELD = 1<<1

(not documented yet)

PBTableViewSetFocusedItem_SHIFT_HELD

PBTableViewSetFocusedItem_SHIFT_HELD = 1<<2

(not documented yet)

PBTableViewSetFocusedItem_DO_NOT_SEND_FOCUS

PBTableViewSetFocusedItem_DO_NOT_SEND_FOCUS = 1<<3

(not documented yet)

PBTableItemChooseSource

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

Constants

PBTableItemChooseSource_OTHER

PBTableItemChooseSource_OTHER = 0

(not documented yet)

PBTableItemChooseSource_DOUBLE_CLICK

PBTableItemChooseSource_DOUBLE_CLICK = 1

(not documented yet)

PBTableItemChooseSource_ENTER_KEY

PBTableItemChooseSource_ENTER_KEY = 2

(not documented yet)

PBTableItemContextMenuSource

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

Constants

PBTableItemContextMenuSource_OTHER

PBTableItemContextMenuSource_OTHER = 0

(not documented yet)

PBTableItemContextMenuSource_RIGHT_CLICK

PBTableItemContextMenuSource_RIGHT_CLICK = 1

(not documented yet)

PBTableItemContextMenuSource_KEY

PBTableItemContextMenuSource_KEY = 2

(not documented yet)

PBTableItemFocusSource

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

Constants

PBTableItemFocusSource_OTHER

PBTableItemFocusSource_OTHER = 0

(not documented yet)

PBTableItemFocusSource_PREVIOUS_REMOVED

PBTableItemFocusSource_PREVIOUS_REMOVED = 1

(not documented yet)

PBTableItemFocusSource_MOUSE_DOWN

PBTableItemFocusSource_MOUSE_DOWN = 2

(not documented yet)

PBTableInlineInputEvent

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

Constants

PBTableInlineInputEvent_SUBMIT

PBTableInlineInputEvent_SUBMIT = 1

(not documented yet)

PBTableViewAccessory

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

Constants

PBTableViewAccessory_PREAMBLE

PBTableViewAccessory_PREAMBLE = 3

(not documented yet)

PBTableViewAccessory_POSTAMBLE

PBTableViewAccessory_POSTAMBLE = 4

(not documented yet)

PBMessageTableHeaderClicked

Structure: (not documented yet)

Fields

[in] columnIndex (uint32_t): (not documented yet)

PBMessageTableItemDragged

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

PBTableItemDNDUpdateType

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

Constants

PBTableItemDNDUpdate_DROP

PBTableItemDNDUpdate_DROP = 1

(not documented yet)

PBTableItemDNDUpdate_MOVE_OVER

PBTableItemDNDUpdate_MOVE_OVER = 2

(not documented yet)

PBTableItemDNDUpdate_ENTER

PBTableItemDNDUpdate_ENTER = 3

(not documented yet)

PBTableItemDNDUpdate_LEAVE

PBTableItemDNDUpdate_LEAVE = 4

(not documented yet)

PBMessageTableItemDNDUpdate

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

[in] [indirect] dndInfo (PBMessageDNDInfo): (not documented yet)

[in] type (PBTableItemDNDUpdateType): (not documented yet)

PBMessageTableItemToggle

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

addedItemsCount (uint64_t): (not documented yet)

PBMessageTableGetString

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

[in] columnIndex (uint32_t): (not documented yet)

[indirect] string (string buffer): (not documented yet)

PBMessageTableGetDocument

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

columnIndex (uint32_t): (not documented yet)

document (nullable owned PBTextDocument): (not documented yet)

PBMessageTableGetIcon

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

icon (nullable owned PBImage): (not documented yet)

PBMessageTableChoose

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

source (PBTableItemChooseSource): (not documented yet)

modifiers (PBModifierKeys): (not documented yet)

[in] columnIndex (uint8_t): (not documented yet)

PBMessageTableContextMenu

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

[in] source (PBTableItemContextMenuSource): (not documented yet)

[in] modifiers (PBModifierKeys): (not documented yet)

[in] columnIndex (uint8_t): (not documented yet)

PBMessageTableFocus

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

source (PBTableItemFocusSource): (not documented yet)

PBMessageTableInlineInput

Structure: (not documented yet)

Fields

[in] event (PBTableInlineInputEvent): (not documented yet)

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

PBTableItemState

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

Constants

PBTableItemState_SELECTED

PBTableItemState_SELECTED = 1<<0

(not documented yet)

PBTableItemState_GHOSTED

PBTableItemState_GHOSTED = 1<<1

(not documented yet)

PBTableItemState_DND_TARGET

PBTableItemState_DND_TARGET = 1<<2

(not documented yet)

PBTableItemState_CAN_EXPAND

PBTableItemState_CAN_EXPAND = 1<<3

(not documented yet)

PBTableItemState_CAN_COLLAPSE

PBTableItemState_CAN_COLLAPSE = 1<<4

(not documented yet)

PBMessageTableGetState

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

state (PBTableItemState): (not documented yet)

indentLevel (uint8_t): (not documented yet)

PBMessageTableSetSelected

Structure: (not documented yet)

Fields

[in] itemIndex (uint64_t): (not documented yet)

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

[in] range (PBTableSelectionRange): (not documented yet)

PBTableViewColumn

Structure: (not documented yet)

Fields

label (referenced string): (not documented yet)

flags (PBTableViewColumnFlags): (not documented yet)

width (uint32_t): (not documented yet)

PBMessageTableItemCreated

Structure: Notifies the table that an item element has been created. You must not insert or remove items while processing this message.

Fields

[in] itemIndex (uint64_t): The index of the item that has been created.

[in] element (referenced PBElement): The created item element in the table. This element is managed by the table view. Do not add child elements to this element; do not destroy this element. You can pass this pointer to PBTableViewIndexOfItemElement to determine its index in the table at the time of calling.

PBTableViewInlineInputFieldFlags

Enumeration/bitset of type uint32_t: Set of flags customizing an inline input field for a table view.

Constants

PBTableViewInlineInputField_COLUMN_MASK

PBTableViewInlineInputField_COLUMN_MASK = 0xFF

The low 8 bits store the column index to edit.

PBTableViewCreate

Function: (not documented yet)

Syntax (C/C++)

PBTableViewPtr _Nullable PBTableViewCreate(PBScrollViewRef parent, 
    PBTableViewFlags flags);

Syntax (Python)

TableViewCreate(parent, flags) -> (tableView)

Parameters and Return Values

[in] parent (referenced PBScrollView): (not documented yet)

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

[out] tableView (nullable owned PBTableView): (not documented yet)

PBTableViewInsert

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewInsert(PBTableViewRef tableView, uint64_t firstIndex, 
    uint64_t count);

Syntax (Python)

TableViewInsert(tableView, firstIndex, count)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] firstIndex (uint64_t): (not documented yet)

[in] count (uint64_t): (not documented yet)

PBTableViewRemove

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewRemove(PBTableViewRef tableView, uint64_t firstIndex, 
    uint64_t count);

Syntax (Python)

TableViewRemove(tableView, firstIndex, count)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] firstIndex (uint64_t): (not documented yet)

[in] count (uint64_t): (not documented yet)

PBTableViewRemoveAll

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewRemoveAll(PBTableViewRef tableView);

Syntax (Python)

TableViewRemoveAll(tableView)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

PBTableViewInvalidate

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewInvalidate(PBTableViewRef tableView, uint64_t firstIndex, 
    uint64_t count);

Syntax (Python)

TableViewInvalidate(tableView, firstIndex, count)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] firstIndex (uint64_t): (not documented yet)

[in] count (uint64_t): (not documented yet)

PBTableViewReorder

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewReorder(PBTableViewRef tableView, uint64_t oldFirstIndex, 
    uint64_t newFirstIndex, uint64_t count);

Syntax (Python)

TableViewReorder(tableView, oldFirstIndex, newFirstIndex, count)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] oldFirstIndex (uint64_t): (not documented yet)

[in] newFirstIndex (uint64_t): (not documented yet)

[in] count (uint64_t): (not documented yet)

PBTableViewGetSingleSelected

Function: (not documented yet)

Syntax (C/C++)

bool PBTableViewGetSingleSelected(PBTableViewRef tableView, 
    /* output */ uint64_t * _Nullable __restrict index);

Syntax (Python)

TableViewGetSingleSelected(tableView) -> (anySelected, index)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

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

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

PBTableViewSetColumns

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewSetColumns(PBTableViewRef tableView, 
    const PBTableViewColumn *_Nullable columns, size_t columnsCount);

Syntax (Python)

TableViewSetColumns(tableView, columns)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] columns (referenced array of PBTableViewColumn): (not documented yet)

PBTableViewAddInlineInputField

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewAddInlineInputField(PBTableViewRef tableView, uint64_t atIndex, 
    ConstStr initialContents, uintptr_t selectFrom, uintptr_t selectTo);

Syntax (Python)

TableViewAddInlineInputField(tableView, atIndex, initialContents, selectFrom, selectTo)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] atIndex (uint64_t): (not documented yet)

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

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

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

PBTableViewAddInlineInputField2

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewAddInlineInputField2(PBTableViewRef tableView, uint64_t atIndex, 
    ConstStr initialContents, uintptr_t selectFrom, uintptr_t selectTo, 
    PBTableViewInlineInputFieldFlags flags);

Syntax (Python)

TableViewAddInlineInputField2(tableView, atIndex, initialContents, selectFrom, selectTo, flags)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] atIndex (uint64_t): (not documented yet)

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

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

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

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

PBTableViewGetFocusedItem

Function: (not documented yet)

Syntax (C/C++)

bool PBTableViewGetFocusedItem(PBTableViewRef tableView, 
    /* output */ uint64_t * _Nullable __restrict index);

Syntax (Python)

TableViewGetFocusedItem(tableView) -> (anyFocused, index)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

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

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

PBTableViewSetFocusedItem

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewSetFocusedItem(PBTableViewRef tableView, uint64_t itemIndex, 
    PBTableViewSetFocusedItemFlags flags);

Syntax (Python)

TableViewSetFocusedItem(tableView, itemIndex, flags)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] itemIndex (uint64_t): (not documented yet)

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

PBTableViewEnsureFocusedItemIsVisible

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewEnsureFocusedItemIsVisible(PBTableViewRef tableView);

Syntax (Python)

TableViewEnsureFocusedItemIsVisible(tableView)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

PBTableViewEnsureItemIsVisible

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewEnsureItemIsVisible(PBTableViewRef tableView, uint64_t itemIndex, 
    PBEnsureVisibleMode mode);

Syntax (Python)

TableViewEnsureItemIsVisible(tableView, itemIndex, mode)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] itemIndex (uint64_t): (not documented yet)

[in] mode (PBEnsureVisibleMode): (not documented yet)

PBTableViewCreateDragImage

Function: (not documented yet)

Syntax (C/C++)

PBRenderSurfacePtr _Nullable PBTableViewCreateDragImage(PBTableViewRef tableView, 
    /* output */ int32_t * __restrict dx, /* output */ int32_t * __restrict dy);

Syntax (Python)

TableViewCreateDragImage(tableView) -> (renderSurface, dx, dy)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[out] renderSurface (nullable owned PBRenderSurface): (not documented yet)

[out] dx (int32_t): (not documented yet)

[out] dy (int32_t): (not documented yet)

PBTableViewSetSelected

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewSetSelected(PBTableViewRef tableView, uint64_t itemIndex, 
    PBTableSelectionAction action, PBTableSelectionRange range);

Syntax (Python)

TableViewSetSelected(tableView, itemIndex, action, range)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

[in] itemIndex (uint64_t): (not documented yet)

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

[in] range (PBTableSelectionRange): (not documented yet)

PBTableViewIndexOfItemElement

Function: (not documented yet)

Syntax (C/C++)

uint64_t PBTableViewIndexOfItemElement(PBTableViewRef tableView, 
    PBElementRef itemElement);

Syntax (Python)

TableViewIndexOfItemElement(tableView, itemElement) -> (itemIndex)

Parameters and Return Values

[in] tableView (referenced PBTableView): (not documented yet)

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

[out] itemIndex (uint64_t): (not documented yet)

PBTableViewSetAccessory

Function: (not documented yet)

Syntax (C/C++)

void PBTableViewSetAccessory(PBTableViewRef view, PBElementRef childElement, 
    PBTableViewAccessory accessory);

Syntax (Python)

TableViewSetAccessory(view, childElement, accessory)

Parameters and Return Values

[in] view (referenced PBTableView): (not documented yet)

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

[in] accessory (PBTableViewAccessory): (not documented yet)

PBTableViewSetColumnHeaderMark

Function: Put a sort indicator in a column header.

Syntax (C/C++)

void PBTableViewSetColumnHeaderMark(PBTableViewRef view, uint32_t columnIndex, 
    PBNamedImage mark);

Syntax (Python)

TableViewSetColumnHeaderMark(view, columnIndex, mark)

Parameters and Return Values

[in] view (referenced PBTableView): (not documented yet)

[in] columnIndex (uint32_t): (not documented yet)

[in] mark (PBNamedImage): Either PBNamedImage_SORT_ASCENDING_MARK or PBNamedImage_SORT_DESCENDING_MARK.

Discussion

If there is a mark in another column, it is removed.