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

Tool Tips

PBMessageGetToolTip

Structure: Contains the information necessary to create a tool tip.

Fields

contents (nullable owned PBTextDocument): The text document to display in the tool tip. Set to null if the element does not need a tool tip. You may need to increment the document's reference count with PBTextDocumentRetain before returning it. The document should use the PBNamedTextStyle_CONTROL_DEFAULT text style.

contentOffsetX (int32_t): The tool tip is positioned so the top-left corner of its contents matches the top-left corner of the element plus this offset.

contentOffsetY (int32_t): See contentOffsetX. This field is initialized to the height of the element so that the tool tip is display below it.

width (int32_t): The width of the tool tip. This field is initialized to a default value. Set to 0 to make the width match the contents.