[Previous]
[Bookset]
[Next]

Summary of Entries

This chapter groups the datatypes and functions according to their purpose. You can use this chapter to determine which you may need to perform a task. The first two letters of a datatype's or function's name identify the chapter in which a description of the function will be found, as follows:

If prefix is: See the following chapter:
Ap*() PhAB
mbstr*() Multibyte-Character
Pf*() Font Server
Pg*() Graphics
Ph*() Photon
Pm*() Memory
Pp*() Printing
Pt*() Widget Toolkit
Px*() Extended
wc*() Wide-Character

Note:

This chapter includes the following sections:

Categories

The following categories have been used to group the datatypes and functions:

Entries arranged by category

Background processing

Entry Summary
PtAppAddWorkProc() Add a WorkProc (background) function
PtAppRemoveWorkProc() Remove a WorkProc processing function
PtWorkProc_t Pointer to a work procedure function

Bitmaps and Images

Entry Summary
PgDrawBitmap(),
PgDrawBitmapmx()
Draw a bitmap
PgDrawImage(),
PgDrawImagemx()
Draw an image
PgDrawPhImagemx() Draw an image that's contained in a PhImage_t structure
PgDrawTImage(),
PgDrawTImagemx()
Draw an image with a transparency mask
PgDrawRepBitmap(),
PgDrawRepBitmapmx()
Draw a bitmap several times
PgDrawRepImage(),
PgDrawRepImagemx()
Draw an image several times
PhImage_t Data and characteristics of an image
PhMakeGhostBitmap() Create a ghost bitmap for an image
PhMakeTransBitmap() Create a transparency mask for an image
PhReleaseImage() Release allocated members of an image structure
PxCRC() Calculate a cyclic redundancy check for a block of data
PxLoadImage() Read or query a graphic file

Blitting

Entry Summary
PhBlit() Blit an area within a region

Callbacks

Entry Summary
PtAddCallback() Add a single callback entry to a callback list
PtAddCallbacks() Add several callback entries to a callback list
PtAddEventHandler() Add a single event handler entry to a widget
PtAddEventHandlers() Add several event handler entries to a widget
PtAddHotkeyHandler() Add a single hotkey handler entry to a widget
PtRemoveCallback() Remove a single callback entry from a callback list
PtRemoveCallbacks() Remove several callback entries from a callback list
PtRemoveEventHandler() Remove a single event-handler entry from a widget
PtRemoveEventHandlers() Remove several event-handler entries from a widget
PtRemoveHotkeyHandler() Remove a single hotkey handler entry from a widget

Clipboard operations

Entry Summary
PhClipboardCopy() Copy data to the clipboard
PhClipboardCopyString() Copy string-only data to the clipboard
PhClipboardPasteFinish() Release all memory associated with a paste operation
PhClipboardPasteStart() Begin a paste operation
PhClipboardPasteString() Paste string-only data from the clipboard
PhClipboardPasteType() Search clipboard for an entry by type
PhClipboardPasteTypeN() Search clipboard for an entry by order
PhClipHeader Clipboard header structure

Clipping

Entry Summary
PgSetClipping() Limit the extent of drawing
PgSetMultiClip() Set a list of rectangles to clip drawing
PgSetUserClip() Restrict subsequent draws
PgSetUserClipAbsolute() Restrict subsequent draws
PtRectIntersect() Find the intersection of two rectangles
PtRectUnion() Determine a bounding box for two rectangles
PtWidgetVisibleExtent() Calculate the visible portion of a widget

Configuration files

Entry Summary
PxConfigClose() Close the current configuration file
PxConfigDeleteEntry() Delete an entry from a configuration file
PxConfigDeleteSection() Delete a section from a configuration file
PxConfigForceEmptySection() Create an empty section in a configuration file
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
PxConfigReadInt() Read an 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
PxConfigWriteInt() Write an 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

Connecting and disconnecting from Photon services

Entry Summary
PhAttach() Open a communications channel
PhDetach() Free all resources consumed by a Photon channel
PhReattach() Change the current Photon channel
PtReattach() Do a PhDetach(), PhAttach(), and extra realizing as required

Converting and parsing colors

Entry Summary
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 colors matches
PgGetPalette() Query for current color palette
PgGray() Generate 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

Creating and destroying widgets

Entry Summary
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

Cursors/pointers

Entry Summary
PhMoveCursorAbs() Move cursor to absolute position
PhMoveCursorRel() Move cursor to relative position
PhQueryCursor() Collect cursor information

Data chains

Entry Summary
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

Dragging

Entry Summary
PhInitDrag() Initiate a drag operation

Drawing attributes

Entry Summary
PgSetDrawMode() Set draw mode
PgSetFont() Set text font
PgSetPalette() Set the color palette
PgSetPlaneMask() Protect video memory from being modified
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

Fill attributes

Entry Summary
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

Entry Summary
PgSetStrokeCap() Set what the ends of lines look like
PgSetStrokeColor() Set the color of subsequent outlines
PgSetStrokeDither() Apply a color pattern to outlines
PgSetStrokeTransPat() Use a masking pattern to set draw transparency on outlines
PgSetStrokeXORColor() Use the XOR of a color to draw outlines
PgSetStrokeDash() Set dashed lines
PgSetStrokeJoin() Set how lines are joined
PgSetStrokeWidth() Set line thickness
PgSetStrokeFWidth() Set line thickness

Finding widgets in an area

Entry Summary
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

Entry Summary
PtContainerFindFocus() Find the widget that currently has focus
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
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

Font handling

Entry Summary
PfAttach() Attach to font server
PfDetach() Detach from font server
PfExtentComponents() Calculate the extent of a text string and invoke a callback
PfExtentText() Calculate the extent rectangle of a text string
PfFractionalExtentText() Calculate the extent rectangle of a text string, using fractional scaling
PfFractionalRenderText() Render a string, using fractioanl scaling, via a callback function
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
PfQueryFont() Get information about a font
PfQueryFonts() Construct a list of fonts
PfRenderText() Render a string via a callback function
PfUnloadMetrics() Unload metric information for the given font
PtFontSelection() Create a font-selection dialog

Forcing and holding off updates

Entry Summary
PtContainerHold() Prevent repairs to a container widget and its children
PtContainerRelease() Decrement the hold count for a widget
PtEndFlux() Decrement the global and container flux count
PtFlush() Immediately repair widget damage
PtHold() Prevent visible repair of all widgets
PtRelease() Decrement the global widget hold count
PtStartFlux() Prevent changes from being applied to a widget
PtSyncPhoton() Synchronize Photon
PtSyncWidget() Synchronize a widget
PtUpdate() Decrement the global hold count

Geometry

Entry Summary
PhArea_t Position and dimensions of a rectangular area
PhDim_t Dimensions of an area
PhPoint_t Coordinates of a single point
PhRect_t Coordinates of a rectangle

Getting, emitting and handling events

Entry Summary
PhEvent_t An event
PhEventArm() Arm the currently attached Photon channel
PhEventEmit() Emit an event
PhEventEmitmx() Emit an event when the event-specific data isn't contiguous in memory
PhEventNext() Provide synchronous event notification
PhEventPeek() Check to see if an event is pending
PhEventRead() Provide asynchronous event notification
PhEventRegion_t Emitter and collector of an event
PhGetData() Get data for an event
PhGetMsgSize() Get message size
PhGetRects() Get an event's rectangle set
PhTimerArm() Arm a timer event
PtAddEventHandler() Add a single event handler entry to a widget
PtAddEventHandlers() Add several event handler entries to a widget
PtBkgdHandlerProcess() Process all outstanding Photon events
PtEventHandler() Determine the widgets involved in an event
PtForwardWindowEvent() Forward a window event
PtMainLoop() Implement an application main loop
PtProcessEvent() Standard Photon event-handling function
PtRemoveEventHandler() Remove a single event-handler entry from a widget
PtRemoveEventHandlers() Remove several event-handler entries from a widget
PtResizeEventMsg() Resize the event buffer
PtSendEventToWidget() Give an event to a widget
PtTimerArm() Arm a timer event on a widget
PhWindowEvent_t A window action

Graphical contexts

Entry Summary
PgClearDrawBuffer() Reset the current draw buffer
PgCreateGC() Allocate a graphics context
PgDefaultFill() Reset fill attribute to its default value
PgDefaultGC() Reset all graphics context attributes to their default system values
PgDefaultMode() Reset draw mode and plane mask to their default values
PgDefaultStroke() Reset stroke attribute to its system default
PgDefaultText() Reset text attribute to its system default
PgDestroyGC() Release resources of a graphics context
PgFlush(),
PgFFlush()
Explicitly flush the current draw buffer
PgGetGC() Get current graphics context
PgSetDrawBufferSize() Resize a draw buffer
PgSetGC() Set current graphics context
PgSetRegion() Determine which region will emit draw events

Hotkey handlers

Entry Summary
PtAddHotkeyHandler() Add a single hotkey handler entry to a widget
PtRemoveHotkeyHandler() Remove a single hotkey handler entry from a widget

Input/Output events

Entry Summary
PtAppAddFd() Add a file-descriptor function
PtAppAddFdPri() Add a file-descriptor function, specifying a priority
PtAppRemoveFd() Remove a file-descriptor function
PtPulseArmFd() Create a pulse message to be sent to another process
PtFileSelection() Create a file-selection dialog
PtFDProc_t Pointer to a file-descriptor function

Interprocess Communication (IPC)

Entry Summary
PhChannelAttach() Create or attach a channel
PtAppAddInput() Add an input processing function
PtAppCreatePulse() Create a Photon pulse
PtAppDeletePulse() Delete a Photon pulse
PtAppPulseTrigger() Deliver a 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)
PtInputCallbackProc_t Pointer to a input callback function
PtPulseArmFd() Create a pulse message to be sent to another process
PtPulseArmPid() Create a pulse message to be sent to another process
PtPulseDeliver() Send a pulse to another process
PtPulseDisarm() Release resources allocated for a pulse message

Jump Gates

Entry Summary
PtReattach() Send an application through the jump gate
PxCRC() Calculate a cyclic redundancy check for a block of data

Marking widgets as damaged

Entry Summary
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
PtEndFlux() Decrement the global and container flux count
PtIsFluxing() Determine whether a container or its family is in flux
PtStartFlux() Increment the global and container flux count

Memory contexts

Entry Summary
PhDCGetCurrent() Get the currently active Draw Context
PhDCSetCurrent() Set the currently active Draw Context
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

Menus

Entry Summary
PtPositionMenu() Set a menu's position

Modal dialogs

Entry Summary
PtAskQuestion() Display a question and request a response from the user
PtMessageBox() Pop up a message box
PtModalEnd() Terminate modal-window processing
PtModalStart() Initiate modal-window processing
PtProcessEvent() Standard Photon event-handling function

Multibyte-character strings

Entry Summary
mbstrblen() Find the number of multibyte characters in b bytes of a string
mbstrchr() Search for a multibyte character in a string
mbstrlen() Find the length of a multibyte-character string
mbstrnchr() Search for a multibyte character in part of a string
mbstrncmp() Compare part of a multibyte-character string
mbstrnlen() Find the number of bytes used by n characters of a multibyte-character string
mbstrrchr() Search backwards for a multibyte character in a string

Online help

Entry Summary
PtWidgetHelpHit() Find the first widget at a given position that has a help topic
PxHelpQuit() Exit the Helpviewer
PxHelpSearch() Search for text in help information
PxHelpTopic() Display the help text identified by the given topic path
PxHelpTopicRoot() Display the help text relative to the given topic path
PxHelpTopicTree() Load a new help topic tree
PxHelpUrl() Display the help text at the given URL
PxHelpUrlRoot() Display help text relative to the given URL
PxLoadImage() Read or query a graphic file

Photon Application Builder functions

These functions can be used only by applications made with the Photon Application Builder.

Entry Summary
ApAddClass() Indicate the widgets likely to be encountered in a widget database
ApAppendTranslation() Append external translation files to an application's translation list
ApBitmap_t PhAB bitmap structure
ApCloseDBase() Close a widget database
ApCopyWidget() Copy a widget from a PhAB widget database
ApCreateModule() Create an instance of modules built with PhAB
ApCreateWidget() Create a widget by copying it from a PhAB widget database
ApCreateWidgetFamily() Create a widget by copying it from a PhAB widget database
ApDeleteWidget() Remove widgets from a widget database
ApError() Display an error message dialog
ApFreeBitmapRes() Free a bitmap resource structure
ApGetBitmapRes() Extract bitmap data from a widget
ApGetImageRes() Extract the image data from a widget
ApGetInstance() Get the widget's module instance pointer
ApGetItemText() Get the text for a menu item
ApGetTextRes() Get a translated text string from a widget database
ApGetWidgetPtr() Get the widget's instance pointer
ApInfo_t PhAB information structure
ApInstanceName() Return the widget's instance name string
ApModifyItemState() Modify the state of menu items
ApModifyItemText() Modify the text for a menu item
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 module
ApName() Return a PhAB name value for the specified widget
ApOpenDBase() Open a picture module as a widget database
ApOpenDBaseFile() Open a picture module as a widget database
ApResClose() Close the file of module resource records
ApSaveDBaseFile() Save a widget database as an external file
ApSetTranslation() Change the current translation to another language
ApWidget() Determine the widget that initiated a link callback

Primitive drawing routines

Entry Summary
PgDrawArc() Draw an arc, pie, or chord
PgDrawBevelBox(),
PgDrawIBevelBox()
Draw a beveled box
PgDrawBeveled() Draw a beveled rectangle or arrow
PgDrawBezier(),
PgDrawBeziermx()
Draw a stroked and/or filled Bézier curve
PgDrawBitmap(),
PgDrawBitmapmx()
Draw a bitmap
PgDrawEllipse() Draw an ellipse
PgDrawGrid() Draw a grid
PgDrawImage(),
PgDrawImagemx()
Draw an image
PgDrawLine(),
PgDrawILine()
Draw a single line
PgDrawPixel(),
PgDrawIPixel()
Draw a single point
PgDrawPixelArray(),
PgDrawPixelArraymx()
Draw multiple points
PgDrawPolygon(),
PgDrawPolygonmx()
Draw a stroked and/or filled polygon
PgDrawRect(),
PgDrawIRect()
Draw a rectangle
PgDrawRepBitmap(),
PgDrawRepBitmapmx()
Draw a bitmap several times
PgDrawRepImage(),
PgDrawRepImagemx()
Draw an image several times
PgDrawRoundRect() Draw a rounded rectangle
PgDrawSpan(),
PgDrawSpanmx()
Draw a list of spans
PgDrawString(),
PgDrawStringmx()
Draw a string of characters
PgDrawText(),
PgDrawTextmx()
Draw text
PgDrawTextArea() Draw text within an area
PgDrawTextChars() Draw the specified number of text characters
PgDrawTrend(),
PgDrawTrendmx()
Draw a trend graph

Printing

Entry Description
PhDCGetCurrent() Get the currently active Draw Context
PhDCSetCurrent() Set the currently active Draw Context
PpLoadPrinter() Initialize a print context with information for a given printer
PpPrintClose() Close a print context
PpPrintCreatePC() Create a print context
PpPrintGetPC() Extract data from a print context
PpPrintNewPage() Place a page break in the draw stream for a print context
PpPrintOpen() Prepare for printing
PpPrintReleasePC() Release a print context
PpPrintSetPC() Set data in a print context
PpPrintStart() Make a print context the active one
PpPrintStop() Deactivate a print context
PpPrintWidget() Print a widget
PtPrintSelection() Create a print-selection dialog

Processes

Entry Summary
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

Realizing and unrealizing widgets

Entry Summary
PtDestroyWidget() Remove a widget from the widget hierarchy
PtRealizeWidget() Initialize a widget and its children
PtReRealizeWidget() Force a widget to unrealize and then re-realize itself
PtUnrealizeWidget() Unrealize a widget
PtWidgetIsRealized() Determine whether a widget is realized

Regions

Entry Summary
PhQueryRids() Get a list of regions
PhRegion_t 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
PhRegionOpen() Open a region
PhRegionQuery() Retrieve information about a region
PtQuerySystemInfo() Query the system for information
PtWidgetRid() Get a widget's region ID

Resources

Entry Summary
PtArg_t Which resource is affected when you get or set resources
Pt_ARG() Macro for creating statically initialized argument lists
PtGetControlFlags() Get the flags from the _Pt_ control structure
PtGetResources() Retrieve resource values for a widget
PtSetArg() Build argument lists for widgets
PtSetResources() Set resources for a widget
PtWidgetClassFlags() Retrieve a widget's class structure flags
PtWidgetFlags() Retrieve a widget's flags

Shared memory

Entry Summary
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

Entry Summary
PtAppAddSignalProc() Add Photon signalling to a context
PtAppRemoveSignal() Remove specific signal handling from a context
PtAppRemoveSignalProc() Remove Photon signalling from a context
PtSignalProc_t Pointer to a signal-handling function

System information

Entry Summary
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
PtQuerySystemInfo() Query the system for information about a given widget

Text

Entry Summary
PgExtentText() Calculate the extent of a string of text
PgSetFont() Set 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

Tiles

Entry Summary
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 a point 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
PhTilesToRects() Create an array of rectangles from a list of tiles
PhTranslateTiles() Add a point to the vertices of a list of tiles

Translating characters

Entry Summary
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

Translating coordinates

Entry Summary
PgClearTranslation() Restore the current translation to the default
PgSetTranslation() Translate draw commands horizontally and vertically
PtDeTranslateRect() Detranslate a rectangle (subtract offset)
PtTranslateRect() Translate a rectangle (add offset)

Translating key events

Entry Summary
PhKeyToMb() Get the UTF-8 value of a key event
PhTo8859_1() Get the ASCII value of a key event

Wide characters

Entry Summary
wctolower() Return the lowercase equivalent of a wide character

Widget class hierarchy

Entry Summary
PtFindChildClass() Find the first child that matches the specified class
PtFindChildClassMember() Find the first child that's a subclass of the specified class
PtFindContainer() Return the nearest container parent
PtFindDisjoint() Return the nearest disjoint parent widget
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

Widget family hierarchy

Entry Summary
PtChildType() Determine the relationship between two widgets
PtCreateWidget() Create a widget
PtFindFocusChild() Find the closest focusable child widget
PtFindGuardian() Find the widget responsible for another widget's actions
PtGetParent() Find the nearest widget with the same parent class
PtGetParentWidget() Return the current default widget parent
PtNextTopLevelWidget() Get a pointer to the next top-level widget
PtReParentWidget() "Re-parent" 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
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

Widget geometry

Entry Summary
PtBasicWidgetCanvas() Determine the PtBasic canvas for a widget
PtCalcAbsPosition() Calculate the position of a widget based on a position and another 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
PtLabelWidgetCanvas() Determine the PtLabel canvas for a widget
PtSetAreaFromExtent() Set the extent of a widget
PtSetAreaFromWidgetCanvas() Set the canvas of a widget
PtWidgetArea() Retrieve a copy of a widget's area
PtWidgetCanvas() Determine the PtWidget canvas for a widget
PtWidgetDim() Retrieve a copy of a widget's dimension
PtWidgetExtent() Get a widget's extent
PtWidgetOffset() Find the offset of a widget's origin from its disjoint parent
PtWidgetVisibleExtent() Calculate the visible portion of a widget

Widget library initialization

Entry Summary
PtAppInit() Initialize an application and create the main window
PtCreateAppContext() Create a new application context
PtInit() Initialize the widget library

Window Manager

Entry Summary
PhWindowChange() Modify the attributes of a window's region
PhWindowClose() Close a window
PhWindowQueryVisible() Query a visible extent
PhWindowOpen() Create a window region
PtConsoleSwitch() Switch to another virtual console
PtForwardWindowEvent() Forward a window event
PtForwardWindowTaskEvent() Forward a window event to a task
PtFrameSize() Determine the size of the window frame borders
PtWindowConsoleSwitch() Switch to the console a given window's displayed on

[Previous]
[Bookset]
[Next]