Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/fnsummary.html on line 1

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/fnsummary.html on line 1

Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/fnsummary.html on line 8

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/fnsummary.html on line 8

Summary of Entries

This chapter groups the datatypes and functions according to their purpose. You can use this chapter to determine what you need to perform a task.

The first two letters of a datatype's or function's name identify the chapter in which it's described, as follows:

If prefix is:	See the following chapter:
`Ab`	PhAB-Generated Code
`Al`	PhAB Translation
`Ap`	PhAB
`utf8`	UTF-8Character
`Pd`	Draw Context
`Pf`	Font Server
`Pg`	Graphics
`Ph`	Photon
`Pi`	Images
`Pm`	Memory
`Pp`	Printing
`Pt`	Widget Toolkit
`Px`	Extended
`Rt`	Realtime
`wc`	Wide-Character

For datatypes and functions that deal with specific widgets, see the Widget Reference.
For functions that deal with creating widget classes, see Building Custom Widgets.

This chapter includes the following categories:

Alpha blending
Background processing
Bitmaps and Images
Blitting
Characters, translating
Chroma key operations
Clipboard operations
Clipping
Colors, converting and parsing
Configuration files
Connections to other applications
Coordinates, translating
Cursors/pointers
Data chains
Direct mode
Drag and drop
Dragging
Draw contexts
Drawing attributes
- Fill attributes
- Stroke (line) attributes
Events
Font handling
Geometry
Gradients
- Driver-level
- Application-level
Graphical contexts
Input/Output events
Interprocess Communication (IPC)
Layers
Key events, translating
Memory contexts
Messages and questions
Modal dialogs
Modules
Online help
Photon Application Builder functions
Photon services, connecting and disconnecting
Power-saving modes
Primitive drawing routines
Printing
Processes
Realtime timers
Regions
Shared memory
Signals
Strings, translating
Synchronization
System information
Text
Threads
Tiles
UTF8-character strings
Video modes
Video offscreen memory
Video overlay
Wide characters
Widgets:
- Callbacks and hotkey handlers
- Class hierarchy
- Control surfaces
- Creating and destroying
- Custom widgets
- Damaging
- Databases
- Family hierarchy
- Finding in an area
- Focus
- Geometry
- Library initialization
- Menus
- PtComboBox
- PtFileSel
- PtGenList
- PtGenTree
- PtList
- PtMTrend
- PtMultiText
- PtPanelGroup
- PtProgress
- PtTerminal
- PtText
- PtTree
- PtTrend
- PtTty
- PtWindow
- Realizing and unrealizing
- Resources
- Styles
- Updates, forcing and holding off
Window Manager

Alpha blending

PgAlphaOff*(): Turn alpha blending operations off
PgAlphaOn*(): Turn alpha blending operations on
PgSetAlpha*(): Set the parameters for alpha blending in detail
PgSetAlphaBlend*(): Set the parameters for alpha blending simply

Background processing

PtAppAddWorkProc(): Add a WorkProc (background) function
PtAppRemoveWorkProc(): Remove a WorkProc processing function
PtWorkProcF_t, PtWorkProc_t: Type for defining a work procedure function

Bitmaps and Images

PgDrawBitmap*(): Draw a bitmap
PgDrawImage*(): Draw an image
PgDrawPhImage*(): Draw an image that's contained in a PhImage_t structure
PgDrawPhImageRect*(): Draw part of an image that's contained in a PhImage_t structure
PgDrawTImage*(): Draw an image with a transparency mask
PgDrawRepBitmap*(): Draw a bitmap several times
PgDrawRepImage*(): Draw an image several times
PgDrawRepPhImage*(): Repeatedly draw an image stored in a PhImage_t structure
PgReadScreen(): Read an image from the screen
PgReadScreenSize(): Determine the memory requirements for reading an image from the screen
PhCreateImage(): Create a new PhImage_t structure
PhImage_t: Data and characteristics of an image
PhMakeGhostBitmap(): Create a ghost bitmap for an image
PhMakeTransBitmap(): Create a transparency mask for an image
PhMakeTransparent(): Make a given color transparent in an image, using chroma if possible
PhReleaseImage(): Release allocated members of an image structure
PiConvertImage(): Convert an image from one type to another
PiCropImage(): Crop an image to the specified boundary
PiDuplicateImage(): Duplicate an image
PiFlipImage(): Flip all or part of an image
PiGetPixel(): Retrieve the value of a pixel within an image
PiGetPixelFromData(): Retrieve a value from a run of pixels
PiGetPixelRGB(): Retrieve the RGB value of a pixel within an image
PiInitImage(): Initialize a new image
PiResizeImage(): Resize an image
PiSetPixel(): Alter the value of a pixel within an image
PiSetPixelInData(): Set the value of a pixel in a run of pixels
PtCRC(): Calculate a CRC for a block of data
PtCRCValue(): Calculate a running CRC checksum
PxGetImageExtensions(): Get a list of supported image file extensions
PxLoadImage(): Read or query a graphic file

Blitting

PhBlit(): Blit an area within a region
PhMultiBlit(): Blit a multi-rectangular area within a region
PgBlit(): Blit an area within the region set for the current draw context
PgBlitCx(): Blit an area within the region set for a specified draw context
PgMultiBlit(): Blit a multi-rectangular area within the region set for the current draw context
PgMultiBlitCx(): Blit a multi-rectangular area within the region set for a specified draw context
PtBlit(): Blit an area within a widget
PtClippedBlit(): Blit areas within a widget, with clipping

Characters, translating

PtFepCmd(): Control a Front-End Processor (FEP) from an application
PxTerminalBuildCharsets(): Create character set tables based on translation tables
PxTerminalLoadCharsets(): Load character-set information from a file
PxTerminalSaveCharsets(): Save character-set information in a file
PxTranslateFromUTF(): Translate characters from Unicode UTF-8
PxTranslateList(): Create a list of all supported character translations
PxTranslateSet(): Install a new character set translation
PxTranslateStateFromUTF(): Translate characters from UTF-8, using an internal state buffer
PxTranslateStateToUTF(): Translate characters to UTF-8, using an internal state buffer
PxTranslateToUTF(): Translate characters to UTF-8
PxTranslateUnknown(): Control how unknown encodings are handled

Chroma key operations

PgChromaOff*(): Turn chroma key operations off
PgChromaOn*(): Turn chroma operations on
PgSetChroma(): Set the chroma color and operation

Clipboard operations

PhClipboardRead(): Read data from the clipboard
PhClipboardWrite(): Copy data to the clipboard
PhClipboardCopyString(): Copy string-only data to the clipboard
PhClipboardPasteString(): Paste string-only data from the clipboard
PhClipboardHdr: Clipboard header structure

Clipping

PgSetClipping*(): Limit the extent of drawing
PgSetMultiClip*(): Set a list of rectangles to clip drawing
PgSetUserClip*(): Restrict subsequent draws
PgSetUserClipAbsolute*(): Restrict subsequent draws
PtWidgetVisibleExtent(): Calculate the visible portion of a widget

Colors, converting and parsing

PgAlphaValue(): Extract the alpha component from a color value
PgARGB(): Convert alpha, red, green, and blue values to composite color format
PgBackgroundShadings(): Calculate top and bottom shading colors
PgBlueValue(): Extract the blue component from a color value
PgCMY(): Convert cyan, magenta, and yellow values to composite color format
PgColor_t: Composite color value
PgColorHSV_t: Hue-Saturation-Value color value
PgColorMatch(): Query for best color matches
PgGetColorModel*(): Get the current color model
PgGetPalette(): Query for current color palette
PgGray(): Generate the RGB value for a shade of gray
PgGrayValue(): Extract color brightness
PgGreenValue(): Extract the green component from a color value
PgHSV(): Convert hue, saturation, and value to composite color format
PgHSV2RGB(): Convert HSV colors to RGB
PgRedValue(): Extract the red component from a color
PgRGB(): Convert red, green, and blue values to composite color format
PgRGB2HSV(): Convert RGB colors to HSV
PgSetColorModel*(): Set the current color model

Configuration files

PxConfigClose*(): Close a configuration file
PxConfigDeleteEntry*(): Delete an entry from a configuration file
PxConfigDeleteSection*(): Delete a section from a configuration file
PxConfigFirstSection*(): Seek the beginning of the first section of a configuration file
PxConfigForceEmptySection*(): Create an empty section in a configuration file
PxConfigNextEntry*(): Get the next entry in the current section
PxConfigNextSection*(): Seek the beginning of the next section of a configuration file
PxConfigNextString*(): Get the next entry in the current section
PxConfigOpen*(): Open a configuration file
PxConfigReadBool*(): Read a Boolean value from a configuration file
PxConfigReadChar*(): Read a character parameter from a configuration file
PxConfigReadDouble*(): Read a double-precision float parameter from a configuration file
PxConfigReadInt*(): Read an integer parameter from a configuration file
PxConfigReadLLong*(): Read a long long integer parameter from a configuration file
PxConfigReadLong*(): Read a long integer parameter from a configuration file
PxConfigReadShort*(): Read a short integer parameter from a configuration file
PxConfigReadString*(): Read a string parameter from a configuration file
PxConfigSection*(): Seek the start of a given section in a configuration file
PxConfigWriteBool*(): Write a Boolean parameter in a configuration file
PxConfigWriteChar*(): Write a character parameter in a configuration file
PxConfigWriteDouble*(): Write a double-precision float parameter in a configuration file
PxConfigWriteInt*(): Write an integer parameter in a configuration file
PxConfigWriteLLong*(): Write a long long integer parameter in a configuration file
PxConfigWriteLong*(): Write a long integer parameter in a configuration file
PxConfigWriteShort*(): Write a short integer parameter in a configuration file
PxConfigWriteString*(): Write a string parameter in a configuration file

Connections to other applications

PtConnectionAddEventHandlers(): Add a set of server event handlers to a client connection object
PtConnectionAddMsgHandlers(): Add a set of message handlers to a server connection object
PtConnectionClientDestroy(): Destroy a client connection object
PtConnectionClientGetUserData(): Get the client's user data pointer from a connection object
PtConnectionClientSetError(): Set the error-handler function for the client-side of a connection
PtConnectionClientSetUserData(): Set the client's user data pointer in a connection object
PtConnectionFindId(): Find the connector with a given ID
PtConnectionFindName(): Find the connector with a given name
PtConnectionFlush(): Send all pending notifications to the client
PtConnectionNotify(): Send a notification event to the client
PtConnectionReply(), PtConnectionReplymx(): Reply to a message from a client
PtConnectionResizeEventBuffer(): Resize the buffer used to store notifications
PtConnectionSend(), PtConnectionSendmx(): Send a message to a server
PtConnectionServerDestroy(): Destroy a server connection object
PtConnectionServerGetUserData(): Get the server's user data pointer from a connection object
PtConnectionServerSetError(): Set the error-handler function for the server-side of a connection
PtConnectionServerSetUserData(): Set the server's user data pointer in a connection object
PtConnectionTmpName(): Create a temporary name for a server
PtConnectionWaitForName(): Try to connect to the server with a given name
PtConnectorCreate(): Create a connector
PtConnectorDestroy(): Destroy a connector
PtConnectorGetId(): Get the ID of a connector

Coordinates, translating

PgClearTranslation*(): Restore the current translation to the default
PgSetTranslation*(): Translate draw commands horizontally and vertically
PhDeTranslateRect(): Detranslate a rectangle (subtract offset)
PhTranslateRect(): Translate a rectangle (add offset)

Cursors/pointers

PhCursorDef_t: Bitmap for the cursor
PhMoveCursorAbs(): Move the cursor to an absolute position
PhMoveCursorRel(): Move the cursor to a relative position
PhQueryCursor(): Collect cursor information

Data chains

PtAddData(): Add data to the provided data chain
PtFindData(): Find the first data block of a given type and subtype
PtFindNextData(): Find the next data block of a given type and subtype
PtRemoveData(): Remove a link from a data chain
PtUnlinkData(): Remove the provided data link from the data chain

Direct mode

PdCreateDirectContext(): Create a direct-mode context
PdDirectStart(): Enter direct mode
PdDirectStop(): Leave direct mode
PdReleaseDirectContext(): Leave direct mode and release the direct-mode context
PgWaitVSync*(): Wait for vertical synchronization

Drag and drop

PhAllocPackType(): Allocate a buffer and pack transport data into it
PhCreateTransportCtrl(): Allocate a PhTransportCtrl_t structure
PhFindTransportType(): Find a transport type in the transport registry
PhFreeTransportType(): Free data associated with a transport registry entry
PhGetAllTransportHdrs(): Extract all the headers from a buffer of packed transport data
PhGetNextInlineData(): Get the data for the next entry in a linked list of transport data
PhGetNextTransportHdr(): Get the next header from a buffer of packed transport data
PhGetTransportHdr(): Extract the header from a buffer of packed transport data
PhGetTransportVectors(): Build an I/O vector of data to be transported
PhLinkTransportData(): Add transport data to a linked list
PhLocateTransHdr(): Look for specific data in a linked list of transport headers
PhMallocUnpack(): Unpack transport data, using a custom memory-allocation function
PhPackEntry(): Pack transport data, given a transport registry entry
PhPackType(): Pack transport data, given the type of data
PhRegisterTransportType(): Add a new transport type to the transport registry
PhReleaseTransportCtrl(): Free a PhTransportCtrl_t structure
PhReleaseTransportHdrs(): Free a linked list of headers for packed transport data
PhTransportCtrl_t: Control structure for the Photon transport mechanism
PhTransportFindLink(): Search a linked list of transport data for some specific data
PhTransportLink_t: Entry in a linked list of transport data
PhTransportRegEntry_t: Data structure that describes data to be transported
PhTransportType(): Pack data into a PhTransportCtrl_t structure
PhUnlinkTransportHdr(): Remove an entry from a linked list of transport headers
PhUnpack(): Unpack transport data
PtAddResponseType(): Add data to the response chain
PtCancelDnd(): Cancel a drag-and-drop operation
PtCreateTransportCtrl(): Create a transport control structure for use with drag and drop
PtDndFetch_t: Structure that defines data types a widget accepts from a drag-and-drop event
PtDndSelect(): Select drag-and-drop data
PtGetDndFetchIndex(): Select drag-and-drop data
PtInitDnd(): Search for an entry in the data_array for an incoming drag and drop event
PtReleaseTransportCtrl(): Release a transport control structure used with drag and drop
PtTransportCtrl_t: Transport-control structure used in a drag-and-drop operation
PtTransportRequestable(): Add an entry for requestable data to the drag-and-drop data
PtTransportType(): Pack transport data

Dragging

PhCancelDrag(): Cancel a drag operation
PhDragEvent_t: Data associated with a drag event
PhInitDrag(): Initiate a drag operation

Draw contexts

PdGetDevices(): Get region IDs for the currently available draw devices
PdSetTargetDevice(): Set the target device
PhDCCreate(): Create and initialize a new draw context
PhDCGetCurrent(): Get the currently active draw context
PhDCRelease(): Release a draw context
PhDCSetCurrent(): Set the currently active draw context

Drawing attributes

General attributes

PgSetDrawMode*(): Set draw mode
PgSetPalette*(): Set the color palette
PgSetPlaneMask*(): Protect video memory from being modified

Fill attributes

PgDefaultAlpha(): Reset alpha attributes to their default system values
PgDefaultChroma(): Reset chroma attributes to their default system values
PgDefaultFill(): Reset the fill attribute to its default value
PgSetFillColor*(): Set exact fill color
PgSetFillDither*(): Set specific dither pattern and colors
PgSetFillTransPat*(): Set draw transparency
PgSetFillXORColor*(): Set a color for XOR drawing

Line (stroke) attributes

PgDefaultStroke(): Reset the stroke attribute to its system default
PgSetStrokeCap*(): Set what the ends of lines look like
PgSetStrokeColor*(): Set the color of subsequent outlines
PgSetStrokeDash*(): Set dashed lines
PgSetStrokeDither*(): Apply a color pattern to outlines
PgSetStrokeFWidth*(): Set line thickness
PgSetStrokeJoin*(): Set how lines are joined
PgSetStrokeTransPat*(): Use a masking pattern to set draw transparency on outlines
PgSetStrokeXORColor*(): Set the stroke color for XOR drawing
PgSetStrokeWidth*(): Set line thickness

Text attributes

PgDefaultText(): Reset the text attribute to its system default
PgSetFont*(): Set the text font
PgSetTextColor*(): Set text color
PgSetTextDither*(): Set text dither pattern
PgSetTextTransPat*(): Set draw transparency
PgSetTextXORColor*(): Set a color for XOR drawing
PgSetUnderline*(): Set colors for underlining text

Events

PhEmit(): Emit an event
PhEmitmx(): Emit an event when the event-specific data isn't contiguous in memory
PhEvent_t: Data structure describing an event
PhEventArm(): Arm the currently attached Photon channel
PhEventEmit(): Emit an event — PhEmit() provides a cleaner API
PhEventEmitmx(): Emit an event when the event-specific data isn't contiguous in memory — PhEmitmx() provides a cleaner API
PhEventNext(): Provide synchronous event notification
PhEventPeek(): Check to see if an event is pending
PhEventRead(): Provide asynchronous event notification
PhEventRegion_t: Data structure describing the emitter and collector of an event
PhGetData(): Get data for an event
PhGetMsgSize(): Get message size
PhGetRects(): Get an event's rectangle set
PhInputGroup(): Determine the input group associated with an event
PhKeyEvent_t: Data structure describing a key event
PhPointerEvent_t: Data associated with a pointer event
PhTimerArm(): Arm a timer event
PhWindowEvent_t: Data structure describing a window action
PtAddEventHandler(): Add a single Pt_CB_RAW entry to a widget
PtAddEventHandlers(): Add several Pt_CB_RAW entries to a widget
PtAddFilterCallback(): Add a single Pt_CB_FILTER callback to a widget
PtAddFilterCallbacks(): Add several Pt_CB_FILTER entries to a widget
PtAppAddEventHandler(): Set an event handler resource for an application.
PtAppAddFilterCallback(): Set a filter callback resource for an application.
PtAppAddHotkeyHandler(): Set a hotkey handler resource for an application.
PtAppRemoveEventHandler(): Remove an event hanlder from an application's callback list.
PtAppRemoveFilterCallback(): Remove a filter callback from an application's callback list.
PtAppRemoveHotkeyHandler(): Remove a hotkey handler from an application's callback list.
PtBkgdHandlerProcess(): Process all outstanding Photon events
PtEventHandler(): Determine the widgets involved in an event
PtForwardWindowEvent(): Forward a window event to the window with a given region ID
PtMainLoop(): Implement an application main loop
PtProcessEvent(): Standard Photon event-handling function
PtQuitMainLoop(): Cause PtMainLoop() in the calling thread to return
PtRemoveEventHandler(): Remove a single Pt_CB_RAW entry from a widget
PtRemoveEventHandlers(): Remove several Pt_CB_RAW entries from a widget
PtRemoveFilterCallback(): Remove a single Pt_CB_FILTER entry from a widget
PtRemoveFilterCallbacks(): Remove several Pt_CB_FILTER entries from a widget
PtResizeEventMsg(): Resize the event buffer
PtSendEventToWidget(): Give an event to a widget
PtTimerArm(): Arm a timer event on a widget

Font handling

PfAttach(): Attach to a font server
PfConvertFontID(): Convert a font ID to a font name for backwards compatibility
PfDecomposeStemToID(): Convert a stem name into a font ID
PfDetach(): Detach from a font server
PfDynamicLoad(): Dynamically load a font
PfDynamicUnload(): Unload a dynamically loaded font
PfExtent(), PfExtentCx(): Calculate the extent rectangle of a text string
PfExtentComponents(): Calculate the extent of a text string and invoke a callback
PfExtentFractTextCharPositions(): Calculate individual character positions, using fractional scaling
PfExtentText(): Calculate the extent rectangle of a text string
PfExtentTextCharPositions(): Calculate individual character positions
PfExtentTextCharPositionsCx(): Calculate individual character positions, specifying a font context
PfExtentTextToRect(): Calculate the extent of a string, up to a given rectangle
PfExtentWideText(): Calculate the extent rectangle of a wide-character string
PfFindFont(): Generate an ID for a font; PfFontBaseStem(); Get the base stem associated with a given font ID
PfFontDescription(): Get the foundry name of a font
PfFontFlags(): Get the flags for a font
PfFontSize(): Get the point size of a font
PfFractionalExtentText(): Calculate the extent rectangle of a text string, using fractional scaling
PfFreeFont(): Release resources associated with a font
PfGenerateFontName(), PfGenerateFontNameCx(): Generate a font name
PfGetOutline(), PfGetOutlineCx(): Get individual point information for a glyph outline
PfGlyph(): Obtain the metrics and/or bitmap for the specified character
PfLoadFont(): Preload a font within the font server
PfLoadMetrics(): Load metric information for the given font
PfQueryFontInfo(): Get information about a font
PfQueryFonts(): Construct a list of fonts
PfRender(), PfRender(): Render a string via a user callback function
PfTextWidthBytes(): Calculate the width of a char string of multibyte UTF-8 characters
PfTextWidthChars(): Calculate the width of a char string of multibyte UTF-8 characters
PfUnloadMetrics(): Unload metric information for the given font
PfWideTextWidthBytes(): Calculate the width of a wchar_t string of Unicode characters
PfWideTextWidthChars(): Calculate the width of a wchar_t string of Unicode characters
PtFontSelection(): Create a font-selection dialog

Geometry

PhArea_t: Position and dimensions of a rectangular area
PhAreaToRect(): Convert an area into a rectangle
PhDim_t: Dimensions of an area
PhPoint_t: Coordinates of a single point
PhRect_t: Coordinates of a rectangle
PhRectIntersect(): Find the intersection of two rectangles
PhRectToArea(): Convert a rectangle into an area
PhRectUnion(): Determine a bounding box for two rectangles

Gradients

Driver-level

PgDrawGradient*(): Ask the graphics driver to render a gradient

Application-level

PgBevelBox*(): Draw a beveled box with gradients
PgCalcColorContrast(): Compute light and dark colors to use for a gradient
PgContrastBevelBox*(): Draw a beveled box with gradients and a given level of contrast
PgDrawGradientBevelBox*(): Draw a beveled box with gradients and two flat colors

Graphical contexts

PgClearDrawBuffer*(): Reset the current draw buffer
PgCreateGC(): Allocate a graphics context
PgDefaultGC(): Reset all graphics context attributes to their default system values
PgDefaultMode(): Reset draw mode and plane mask to their default values
PgDestroyGC(): Release the resources of a graphics context
PgFlush*(), PgFFlush*(): Explicitly flush the current draw buffer
PgGetGC*(): Get current graphics context
PgGetRegion*(): Get the ID of the region that emits draw events
PgSetDrawBufferSize*(): Resize a draw buffer
PgSetGC*(): Set current graphics context
PgSetRegion*(): Determine which region will emit draw events

Input/Output events

PtAppAddFd(): Add a file-descriptor function
PtAppAddFdPri(): Add a file-descriptor function, specifying a priority
PtAppRemoveFd(): Remove a file-descriptor function
PtAppSetFdMode(): Change the mode that's of interest to an FD handler
PtPulseArm(): Arm a Photon pulse for delivery
PtFileSelection(): Create a file-selection dialog
PtFdProcF_t, PtFdProc_t: Type for defining a file-descriptor function

Interprocess Communication (IPC)

PhChannelAttach(): Create or attach a Neutrino channel
PtAppAddInput(): Add an input processing function
PtAppAddInputRemote(): Add an input processing function for a process on a remote node
PtAppCreatePulse(): Create a Photon pulse
PtAppDeletePulse(): Delete a Photon pulse
PtAppPulseTrigger(): Deliver a Photon pulse to yourself
PtAppRemoveInput(): Remove an input processing entry
PtChannelCreate(): Make sure the widget library is using a channel
PtGetRcvidPid(): Get the process ID (PID) from the receive ID (RCVID)
PtGetRcvidPidNd(): Get the process ID (PID) and node descriptor (ND) from the receive ID (RCVID)
PtInputCallbackProcF_t, PtInputCallbackProc_t: Type for defining a input callback function
PtPulseArm(): Arm a Photon pulse for delivery

Layers

PgCreateDriverRegion(): Create a region that's owned by the graphics driver
PgCreateLayerSurface(): Create an offscreen context for a layer
PgGetLayerCaps(): Query the capabilities of a layer
PgLayerCaps_t: Capabilities for a layer
PgLockLayer(): Lock a layer for exclusive use by an application
PgSetLayerArg(): Configure a layer argument
PgSetLayerSurface(): Display the offscreen context on the specified layer surface
PgUnlockLayer(): Unlock a layer

Key events, translating

PhKeyToMb(): Get the UTF-8 value of a key event
PhTo8859_1(): Get the ISO8859-1 value of a key event

Memory contexts

PmMemCreateMC(): Create a memory context
PmMemFlush(): Flush a memory context
PmMemReleaseMC(): Release a memory context
PmMemSetChunkSize(): Set the increment for growing a memory context's draw buffer
PmMemSetMaxBufSize(): Set the maximum size of a memory context's draw buffer
PmMemSetType(): Set the type of a memory context
PmMemStart(): Make a memory context active
PmMemStop(): Deactivate a memory context

Messages and questions

ApError(): Display an error message dialog
PtAlert(): Display a message and request a response
PtMessageBox(): Pop up a message box
PtNotice(): Display a message and wait for acknowledgment
PtPassword(): Prompt for a password
PtPrompt(): Display a message and get textual input from the user

Modal dialogs

ApModalWait(): Process Photon events until a given widget is destroyed
PtBlockAllWindows(): Block all windows except the one with a given widget
PtBlockWindow(): Block a given window
PtMakeModal(): Block all of an application's windows, except the one containing a given widget
PtModalBlock(): Start a modal loop
PtModalEnd(): Terminate modal-window processing
PtModalStart(): Initiate modal-window processing
PtModalUnblock(): Stop a modal loop
PtProcessEvent(): Standard Photon event-handling function
PtUnblockWindows(): Unblock a set of previously blocked windows

Modules

The following can be used only by applications made with the Photon Application Builder:

AbGetABW(): Get the instance pointer for a widget
ApCreateModule(): Create an instance of a module that was built with PhAB
ApGetInstance(): Get the module link instance pointer for a widget
ApGetWidgetPtr(): Get the instance pointer for a widget in a given module
ApModuleFunction(): Specify the setup function for a PhAB internal link callback
ApModuleLocation(): Specify the module location for a PhAB internal link
ApModuleParent(): Specify the parent for a window or dialog module
ApWidget(): Determine the widget that initiated a link callback

Online help

PtWidgetHelpHit(): Find the first widget at a given position that has a help topic
PtHelpQuit(): Exit the Helpviewer
PtHelpSearch(): Search for text in help information
PtHelpTopic(): Display the help text identified by the given topic path
PtHelpTopicRoot(): Specify the root of help topic paths
PtHelpTopicTree(): Load a new help topic tree
PtHelpUrl(): Display the help text at the given URL
PtHelpUrlRoot(): Display help text relative to the given URL

Photon Application Builder functions

The following can be used only by applications made with the Photon Application Builder:

ApAddContext(): Add a PhAB context so you can use a PhAB application as a DLL
ApInfo_t: Data structure for information passed to PhAB callbacks and setup functions
ApInstanceName(): Return the widget's instance name string
ApName(): Return a PhAB name value for the specified widget
ApRemoveContext(): Remove the PhAB context from a PhAB application that you're using as a DLL
ApResClose(): Close the file of module resource records

Photon services, connecting and disconnecting

PhAttach(): Open a communications channel
PhDetach(): Free all resources consumed by a Photon channel
PhLibVersion(): Get the version number of the Photon libraries
PhReattach(): Change the current Photon channel
PtReattach(): Send an application to another Photon server

Power-saving modes

PgSetDPMSMode(): Set the display power-saving mode

Primitive drawing routines

PgDrawArrow*(): Draw an arrow that fits inside a given rectangle
PgBevelBox*(): Draw a beveled box with gradients
PgContrastBevelBox*(): Draw a beveled box with gradients and a given level of contrast
PgDrawArc*(): Draw an arc, pie, or chord
PgDrawBevelBox*(), PgDrawIBevelBox*(): Draw a beveled box
PgDrawBeveled*(): Draw a beveled rectangle or arrow
PgDrawBezier*(): Draw a stroked and/or filled Bézier curve
PgDrawBitmap*(): Draw a bitmap
PgDrawEllipse*(): Draw an ellipse
PgDrawGradient*(): Ask the graphics driver to render a gradient
PgDrawGradientBevelBox*(): Draw a beveled box with gradients and two flat colors
PgDrawGrid*(): Draw a grid
PgDrawImage*(): Draw an image
PgDrawLine*(), PgDrawILine(): Draw a single line
PgDrawMultiTextArea*(): Draw multiline text in an area
PgDrawPixel*(), PgDrawIPixel*(): Draw a single point
PgDrawPixelArray*(): Draw multiple points
PgDrawPolygon*(): Draw a stroked and/or filled polygon
PgDrawRect*(), PgDrawIRect*(): Draw a rectangle
PgDrawRepBitmap*(): Draw a bitmap several times
PgDrawRepImage*(): Draw an image several times
PgDrawRoundRect*(): Draw a rounded rectangle
PgDrawSpan*(): Draw a list of spans
PgDrawString*(): Draw a string of characters
PgDrawText*(): Draw text
PgDrawTextArea*(): Draw text within an area
PgDrawTextChars*(): Draw the specified number of text characters
PgDrawTrend*(): Draw a trend graph

Printing

PpContinueJob(): Continue a suspended print job
PpCreatePC(): Create a print context
PpEndJob(): End a print job
PpFreePrinterList(): Free a list of available printers
PpGetCanvas(): Get the size of the current drawing area of a print context
PpGetPC(): Extract data from a print context
PpLoadDefaultPrinter(): Initialize a print context with information for the default printer
PpLoadPrinter(): Initialize a print context with information for a given printer
PpLoadPrinterList(): Load a list of available printers
PpPrintContext_t: Data structure describing a print context
PpPrintNewPage(): Place a page break in the draw stream for a print context
PpPrintWidget(): Print a widget
PpReleasePC(): Release a print context
PpSetCanvas(): Set the size of the current drawing area of a print context
PpSetPC(): Set data in a print context
PpStartJob(): Start a print job
PpSuspendJob(): Suspend a print job
PtPrintPropSelect(): Change the printing options for a selected printer via a modal dialog
PtPrintSelect(): Display a custom modal dialog for selecting print options
PtPrintSelection(): Display a modal dialog for selecting print options

Processes

PtAllowExit(): Allow a Photon application to exit
PtExit(): Exit a Photon program
PtPreventExit(): Prevent a Photon application from exiting
PtSpawn(): Spawn a new process
PtSpawnDeleteCallback(): Remove a child-termination callback
PtSpawnSetCallback(): Change the callback in a PtSpawn() control structure
PtSpawnWait(): Spawn a process and wait for its termination

Realtime timers

RtTimerCreate(): Create a realtime timer
RtTimerDelete(): Delete a realtime timer
RtTimerGetTime(): Get the time remaining on a realtime timer
RtTimerSetTime(): Set the expiration time for a realtime timer

Regions

PhQueryRids(): Get a list of regions
PhRegion_t: Data structure that describes a region
PhRegionChange(): Change the definition of a region
PhRegionClose(): Remove a region
PhRegionDataFindType(): Find a data type within a region's data
PhRegionDataHdr_t: Data that's attached to a region
PhRegionInfo(): Retrieve information about a region with multiple rectangles
PhRegionOpen(): Open a region
PhRegionQuery(): Retrieve information about a region
PhQuerySystemInfo(): Query the system for information about a given region
PtWidgetRid(): Get a widget's region ID

Shared memory

PgShmemAttach(): Record a shared memory reference
PgShmemCleanup(): Remove shared memory references
PgShmemCreate(): Create a block of shared memory
PgShmemDestroy(): Remove a block of shared memory
PgShmemDetach(): Remove a shared memory reference

Signals

PtAppAddSignalProc(): Add Photon signalling to a context
PtAppRemoveSignal(): Remove specific signal handling from a context
PtSignalProcF_t, PtSignalProc_t: Type for defining a signal-handling function

Strings, translating

AlClearTranslation(): Clear all the translations in a language or message database
AlCloseDBase(): Close a language or message database
AlGetEntry(): Get an entry from a language or message database
AlGetSize(): Get the number of records in a language or message database
AlOpenDBase(): Load a language or message database
ApCloseMessageDB(): Close a message database
AlReadTranslation(): Read a translation file into a database
AlSaveTranslation(): Save translations from a language or message database
AlSetEntry(): Set the translated string for a database entry
ApAppendTranslation(): Append external translation files to an application's translation list
ApCloseMessageDB(): Close a message database
ApGetTextRes(): Get a translated text string from a widget database
ApGetMessage(): Get a message from a message database
ApLoadMessageDB(): Load a message database
ApSetTranslation(): Change the current translation to another language
ApSetContext(): Change the application's current context. Language translations are context-specific.

Synchronization

PgWaitDrawComplete(): Wait until all emitted draw streams have been processed
PgWaitHWIdle(): Wait until the video driver is idle
PgWaitVSync*(): Wait for vertical synchronization

System information

PhGetConnectId(): Get the connection ID of the calling process
PhGetConnectInfo(): Get information about a Photon channel
PhQueryCursor(): Collect cursor information
PhQuerySystemInfo(): Query the system for information about a given region
PhSysInfo_t: Data structure for system information
PtQuerySystemInfo(): Query the system for information about a given widget

Text

PgExtentMultiText(): Calculate the extent of a multiline text string
PgExtentText(): Calculate the extent of a string of text

See also the PtMultiText and PtText convenience functions.

Threads

PtCondTimedWait(): Block a thread on a conditional variable, with a time limit
PtCondWait(): Block a thread on a conditional variable
PtEnter(): Lock the Photon library for use by a single thread
PtLeave(): Unlock the Photon library for use by other threads

Tiles

PhAddMergeTiles(): Merge two list tiles, eliminating overlap
PhClipTilings(): Clip one list of tiles from another
PhCoalesceTiles(): Combine a list of tiles
PhCopyTiles(): Copy a list of tiles
PhDeTranslateTiles(): Subtract x and y offsets from the vertices of a list of tiles
PhFreeTiles(): Return a list of tiles to the internal tile pool
PhGetTile(): Retrieve a tile from the internal tile pool
PhIntersectTilings(): Determine the intersection of two lists of tiles
PhMergeTiles(): Remove all overlap from a list of tiles
PhRectsToTiles(): Create a list of tiles from an array of rectangles
PhSortTiles(): Sort a list of tiles
PhTile_t: A list of rectangles
PhTilesBoundingRect(): Calculate the bounding box for a list of tiles
PhTilesToRects(): Create an array of rectangles from a list of tiles
PhTranslateTiles(): Add x and y offsets to the vertices of a list of tiles

UTF-8 character strings

utf8len(): Count the bytes in a UTF-8 character
utf8strblen(): Find the number of UTF8 characters in part of a string
utf8strchr(): Search for a UTF8 character in a string
utf8strichr(): Search for a UTF8 character in a string, ignoring case
utf8strirchr(): Search backwards for a UTF8 character in a string, ignoring case
utf8strlen(): Find the length of a UTF-8 character string
utf8strnchr(): Search for a UTF8 character in part of a string
utf8strncmp(): Compare part of a UTF-8 character string
utf8strndup(): Create a copy of part of a UTF-8 character string
utf8strnichr(): Search for a UTF8 character in part of a string, ignoring case
utf8strnlen(): Find the number of bytes used by n characters of a UTF-8 character string
utf8strrchr(): Search backwards for a UTF8 character in a string
utf8towc(): Convert a UTF-8 character to a wide-character code
wctoutf8(): Convert a wide-character code into a UTF-8 character

Video modes

PgGetGraphicsHWCaps(): Determine the hardware capabilities
PgGetVideoMode(): Get the current video mode
PgGetVideoModeInfo(): Get information about a video mode
PgGetVideoModeList(): Query a graphics driver for a list of its supported video modes
PgSetVideoMode(): Set the current video mode

Video offscreen memory

PdCreateOffscreenContext(): Create an offscreen context in video RAM
PdCreateOffscreenLock(): Create a lock for an offscreen context
PdDestroyOffscreenLock(),: Destroy a lock for an offscreen context
PdDupOffscreenContext(): Duplicate an offscreen context
PdGetOffscreenContextPtr(): Create a shared memory object reference to an offscreen context
PdGetOffscreenSurface(): Get a handle for an offscreen surface
PdIsOffscreenLocked(),: Determine whether or not an offscreen context is locked
PdLockOffscreen(),: Lock an offscreen context
PdOffscreenContext_t: Data structure that describes an offscreen context
PdSetOffscreenTranslation(): Set the translation for an offscreen context
PdUnlockOffscreen(): Unlock an offscreen context
PgContextBlit*(): Copy data from a rectangle in one context to another context
PgContextBlitArea*(): Copy data from an area in one context to another context
PgSwapDisplay(): Point the CRT of the video display at a given context

Video overlay

PgConfigScalerChannel(): Configure a video overlay scaler channel
PgCreateVideoChannel(): Create a channel for video streaming
PgDestroyVideoChannel(): Destroy resources associated with a video channel
PgGetOverlayChromaColor(): Return the color used for video overlay chroma-key operations
PgGetScalerCapabilities(): Get the capabilities of a video overlay scaler
PgNextVideoFrame(): Get the index of the next video buffer to fill
PgScalerCaps_t: Data structure that describes video overlay scaler capabilities
PgScalerProps_t: Data structure that describes video overlay scaler properties
PgVideoChannel_t: Data structure that describes a video overlay channel

Wide characters

utf8towc(): Convert a UTF-8 character to a wide-character code
wctolower(): Return the lowercase equivalent of a wide character
wctoutf8(): Convert a wide-character code into a UTF-8 character

Widgets

Callbacks and hotkey handlers

PtAddCallback(): Add a single callback entry to a callback list
PtAddCallbacks(): Add several callback entries to a callback list
PtAddEventHandler(): Add a single Pt_CB_RAW entry to a widget
PtAddEventHandlers(): Add several Pt_CB_RAW entries to a widget
PtAddFilterCallback(): Add a single Pt_CB_FILTER callback to a widget
PtAddFilterCallbacks(): Add several Pt_CB_FILTER entries to a widget
PtAddHotkeyHandler(): Add a single hotkey handler entry to a widget
PtBalloonCallback_t: Balloon callback structure — see the Photon Widget Reference
PtCallback_t: Regular callback structure — see the Photon Widget Reference
PtCallbackInfo_t: Specific callback information — see the Photon Widget Reference
PtHotkeyCallback_t: Hotkey handler structure — see the Photon Widget Reference
PtRawCallback_t: Event handler structure — see the Photon Widget Reference
PtRemoveCallback(): Remove a single callback entry from a callback list
PtRemoveCallbacks(): Remove several callback entries from a callback list
PtRemoveEventHandler(): Remove a single Pt_CB_RAW entry from a widget
PtRemoveEventHandlers(): Remove several Pt_CB_RAW entries from a widget
PtRemoveFilterCallback(): Remove a single Pt_CB_FILTER entry from a widget
PtRemoveFilterCallbacks(): Remove several Pt_CB_FILTER entries from a widget
PtRemoveHotkeyHandler(): Remove a single hotkey handler entry from a widget

Class hierarchy

PtWidgetClass(): Return the class of a widget
PtWidgetIsClass(): Determine whether a widget is a specific class type
PtWidgetIsClassMember(): Determine whether a widget belongs to a specified class

Control surfaces

PtCalcSurface(): Force a surface to calculate its geometry
PtCalcSurfaceByAction(): Force all surfaces associated with an action to calculate their geometry
PtCalcSurfaceById(): Force the control surface with a given ID to calculate its geometry
PtCheckSurfaces(): Match an event with the control surfaces belonging to a widget
PtCreateActionSurface(): Create a control surface within a widget, bound to a widget action
PtCreateSurface(): Create a regular control surface within a widget
PtDamageSurface(), PtDamageSurfaceById(): Mark a control surface as damaged so that it will be redrawn
PtDamageSurfaceByAction(): Damage all surfaces that are associated with an action
PtDestroyAllSurfaces(): Destroy all of a widget's control surfaces
PtDestroySurface(): Destroy a control surface
PtDestroySurfaceById(): Destroy the control surface with a given ID
PtDisableSurface(), PtDisableSurfaceById(): Disable a control surface
PtDisableSurfaceByAction(): Disable all control surfaces associated with an action
PtEnableSurface(), PtEnableSurfaceById(): Enable a control surface
PtEnableSurfaceByAction(): Enable all control surfaces associated with an action
PtFindSurface(): Find the control surface with a given ID
PtFindSurfaceByAction(): Find the control surface associated with a given action
PtHideSurface(), PtHideSurfaceById(): Hide a control surface
PtHideSurfaceByAction(): Hide all control surfaces associated with an action
PtInsertSurface(), PtInsertSurfaceById(): Insert a control surface in front of or behind another
PtShowSurface(), PtShowSurfaceById(): Show a hidden control surface
PtShowSurfaceByAction(): Show all hidden control surfaces associated with an action
PtSurfaceActionId(): Get the action ID for a surface
PtSurfaceAddData(), PtSurfaceAddDataById(): Add data to a control surface
PtSurfaceBrotherBehind(): Get the control surface behind a given one
PtSurfaceBrotherInFront(): Get the control surface in front of a given one
PtSurfaceCalcBoundingBox(), PtSurfaceCalcBoundingBoxById(): Calculate the bounding box for a control surface
PtSurfaceExtent(), PtSurfaceExtentById(): Calculate the extent of a control surface
PtSurfaceGetData(), PtSurfaceGetDataById(): Get data associated with a control surface
PtSurfaceHit(): Find the control surface hit by a given point
PtSurfaceId(): Get the ID of a control surface
PtSurfaceInBack(): Get the backmost control surface belonging to a widget
PtSurfaceInFront(): Get the frontmost control surface belonging to a widget
PtSurfaceIsDisabled(): Determine if a control surface is disabled
PtSurfaceIsEnabled(): Determine if a control surface is enabled
PtSurfaceIsHidden(): Determine if a control surface is hidden
PtSurfaceIsShown(): Determine if a control surface is shown
PtSurfaceRect(), PtSurfaceRectById(): Get the bounding box of a control surface
PtSurfaceRemoveData(), PtSurfaceRemoveDataById(): Remove data from a control surface
PtSurfaceTestPoint(): Test whether or not a point is inside a control surface
PtSurfaceToBack(), PtSurfaceToBackById(): Move a control surface behind all other control surfaces belonging to a widget
PtSurfaceToFront(), PtSurfaceToFrontById(): Move a control surface in front of all other control surfaces belonging to a widget
PtWidgetActiveSurface(): Get a widget's currently active control surface

Creating and destroying widgets

Pt_ARG(): Macro for creating statically initialized argument lists
PtClearWidget(): Destroy all widgets within a container
PtCreateWidget(): Create a widget
PtDestroyWidget(): Remove a widget from the widget hierarchy
PtInflateBalloon(): Create a balloon widget
PtSetArg(): Build argument lists for widgets

Custom widgets

The following are described in Building Custom Widgets:

PtAddWidgetData(): Add data to the widget data chain
PtAnchorDeregister(): Deregister a widget from its parent for anchoring
PtAnchorRegister(): Register a widget with its parent for anchoring
PtAnchorWidget(): Anchor the provided widget
PtApplyAnchors(): Anchor a widget and its children
PtAttemptResize(): Adjust the size of a widget
PtCalcAnchorOffsets(): Update the anchoring values (rules) for the given widget
PtCalcRegion(): Determine whether or not a widget needs a region
PtChildBoundingBox(): Calculate a widget's canvas and its children's bounding boxes
PtClipAdd(): Add a clipping rectangle to the stack
PtClipRemove(): Take a clipping rectangle off the stack
PtCompoundRedirect(): Redirect widgets to a parent
PtCoreChangeRegion(): Determine if a region is required
PtCreateWidgetClass(): Create a widget class
PtDamageExposed(): Damage the specified widgets
PtDestroyCallbackList(): Free the specified callbacks
PtDestroyHotkeyCallbacks(): Free the specified hotkey callbacks
PtDestroyRawCallbacks(): Free the specified raw callbacks
PtFindNextWidgetData(): Find the next appropriate data block
PtFindResource(): Find the record associated with a resource
PtFindWidgetData(): Find the first data block of a given type and subtype
PtGetCallbackList(): Get a callback list
PtGetStruct(): Retrieve the specified resource
PtInvokeCallbackList(): Invoke a callback list
PtInvokeCallbackType(): Invoke a callback list of a specific type
PtInvokeResizeCallbacks(): Invoke the resize callbacks of the specified container
PtMoveResizeWidget(): Synchronize a widget's extent
PtRemoveWidgetData(): Remove data from the widget data chain
PtResizeCanvas(): Set the size of a widget's canvas
PtResizePolicy(): Determine whether a widget has a resize policy
PtSetExtentFromArea(): Calculate the extent of a widget
PtSetStruct(): Set the specified resource
PtSetValue(): Set the value of a resource using mod_f
PtSuperClassCalcOpaque(): Call the Calc Opaque Rect method of the specified superclass
PtSuperClassChildCreated(): Invoke a Child Created method
PtSuperClassChildDestroyed(): Invoke a Child Destroyed method
PtSuperClassChildGettingFocus(): Invoke a Child Getting Focus method
PtSuperClassChildGettingResources(): Invoke a Child Getting Resources method
PtSuperClassChildLosingFocus(): Invoke a Child Losing Focus method
PtSuperClassChildMovedResized(): Invoke a Child Moved/Resized method
PtSuperClassChildRealized(): Invoke a Child Realized method
PtSuperClassChildSettingResources(): Invoke a Child Setting Resources method
PtSuperClassChildUnrealized(): Invoke a Child Unrealized method
PtSuperClassConnect(), PtSuperClassConnectFrom(): Invoke the Connection method of the specified widget class
PtSuperClassDraw(): Invoke the Draw method of the specified superclass
PtSuperClassExtent(): Invoke the Extent method of the specified superclass
PtSuperClassGetResources(): Get the specified resource
PtSuperClassGotFocus(): Invoke the Got Focus method of the specified superclass
PtSuperClassInit(), PtSuperClassInitFrom(): Invoke the Initialize method of the specified widget class
PtSuperClassLostFocus(): Invoke the Lost Focus method of the specified superclass
PtSuperClassRawEvent(), PtSuperClassRawEventFrom(): Invoke the raw callback list of the specified widget class
PtSuperClassRealized(): Invoke the Realization method of the specified widget class
PtSuperClassSetResources(): Set resources
PtUpdateVisibility(): Tell the widget library about a change in visibility
PtWidgetAbove(): Get the widget that's above a given widget in a family hierarchy

Damaging widgets

PtDamageExtent(): Mark an area of a widget as damaged so that it will be redrawn
PtDamageWidget(): Mark a widget as damaged so it will be redrawn

Databases

The following can be used only by applications made with the Photon Application Builder:

ApAddClass(): Indicate the widgets likely to be encountered in a widget database
ApCloseDBase(): Close a widget database
ApCopyDBWidget(): Copy a widget from a PhAB widget database
ApCreateDBWidget(): Create a widget by copying it from a PhAB widget database, specifying a parent
ApCreateDBWidgetFamily(): Create a widget family by copying it from a PhAB widget database, specifying a parent
ApCreateWidget(): Create a widget by copying it from a PhAB widget database
ApCreateWidgetFamily(): Create a widget family by copying it from a PhAB widget database
ApDeleteDBWidget(): Remove widgets from a widget database
ApGetDBWidgetInfo(): Get information about a widget in a widget database
ApGetImageRes(): Extract the image data from a widget in a widget database
ApGetTextRes(): Get a translated text string from a widget database
ApOpenDBase(): Open a picture module as a widget database
ApOpenDBaseFile(): Open an external module file as a widget database
ApSaveDBaseFile(): Save a widget database as an external file
ApRemoveClass(): Remove a widget class

Family hierarchy

PtChildType(): Determine the relationship between two widgets
PtCreateWidget(): Create a widget
PtFindChildClass(): Find the first descendant that matches the specified class
PtFindChildClassMember(): Find the first descendant that's a subclass of the specified class
PtFindContainer(): Return the nearest container parent
PtFindDisjoint(): Return the nearest disjoint parent widget
PtFindFocusChild(): Find the closest focusable child widget
PtFindGuardian(): Find the widget responsible for another widget's actions
PtGetParent(): Find the nearest parent widget that matches the specified class
PtGetParentWidget(): Return the current default widget parent
PtNextTopLevelWidget(): Get a pointer to the next top-level widget
PtReparentWidget(): “Reparent” a widget to a new container
PtSetParentWidget(): Set the current parent widget
PtValidParent(): Identify a valid parent for a widget
PtWidgetBrotherBehind(): Get the brother behind a widget
PtWidgetBrotherInFront(): Get the brother in front of a widget
PtWidgetChildBack(): Get the child that's farthest back in a container
PtWidgetChildFront(): Get the child at the very front of a container
PtWidgetFamily(): Traverse the widget hierarchy from back to front
PtWidgetInsert(): Insert a widget in the widget family hierarchy
PtWidgetParent(): Get a widget's parent
PtWidgetSkip(): Skip to a widget in the next hierarchy
PtWidgetToBack(): Move a widget behind all its brothers
PtWidgetToFront(): Move a widget in front of all its brothers
PtWidgetTree(): Walk the widget tree from front to back
PtWidgetTreeTraverse(): Walk the widget family hierarchy from front to back

Finding widgets in an area

PtContainerBox(): Find the next widget in an area
PtContainerHit(): Find the nth widget in an area
PtHit(): Identify a widget in the specified container

Focus

PtContainerFindFocus(): Find the currently focused widget in the same family hierarchy as a widget
PtContainerFocusNext(): Give focus to the next Pt_GETS_FOCUS widget within the same container
PtContainerFocusPrev(): Give focus to the previous Pt_GETS_FOCUS widget within the same container
PtContainerGiveFocus(): Give focus to a widget
PtContainerNullFocus(): Truncate the focus chain at the specified widget
PtFindFocusChild(): Find the closest focusable child widget
PtFindFocusNextFrom(): Find the next widget that can get focus
PtFindFocusPrevFrom(): Find the previous widget that can get focus
PtGiveFocus(): Give focus to a widget
PtGlobalFocusNext(): Give focus to next widget
PtGlobalFocusNextContainer(): Give focus to another container's widget
PtGlobalFocusNextFrom(): Give focus to the next widget behind the specified widget
PtGlobalFocusPrev(): Give focus to previous widget
PtGlobalFocusPrevContainer(): Give focus to widget in previous container
PtGlobalFocusPrevFrom(): Give focus to widget previous to the specified widget
PtIsFocused(): Determine to what degree a widget is focused

Geometry

PtCalcAbsPosition(): Calculate the position of a widget based on a position and another widget
PtCalcCanvas(): Calculate the drawable canvas for a widget
PtExtentWidget(): Force a widget to calculate its extent
PtExtentWidgetFamily(): Force a widget and its children to calculate their extents
PtGetAbsPosition(): Get the absolute position of a widget
PtSetAreaFromCanvas(): Calculate an area based on the canvas and borders of a widget
PtWidgetArea(): Retrieve a copy of a widget's area
PtWidgetDim(): Retrieve a copy of a widget's dimension
PtWidgetExtent(): Get a widget's extent
PtWidgetMinimumSize(): Determine the minimum permissible size of a widget
PtWidgetOffset(): Find the offset of a widget's origin from its disjoint parent
PtWidgetPreferredSize(): Retrieve the preferred size of a widget
PtWidgetVisibleExtent(): Calculate the visible portion of a widget

Library initialization

PtAppInit(): Initialize an application and create the main window
PtInit(): Initialize the widget library

Menus

The following can be used only with menu modules created in PhAB:

ApGetItemText(): Get the text for a menu item
ApModifyItemAccel(): Modify the keyboard shortcut for a menu item
ApModifyItemState(): Modify the state of menu items
ApModifyItemText(): Modify the text for a menu item

This function is to be used with a PtMenu widget:

PtPositionMenu(): Set a menu's position