PtWindowGetFrameSize()

Determine the size of a window's frame

Synopsis:

int PtWindowGetFrameSize( PtWidget_t *window,
                          PhRect_t *rect );

Arguments:

window
The window you want to query the size of.
rect
A pointer to a PhRect_t in which the function stores the size of the window.

Library:

ph

Description:

This function determines the size of the frame for the window pointed to by window. The results are stored in the PhRect_t structure pointed to by rect; each member gives the size of a different part of the frame:

Member Part of frame
ul.y Top
lr.y Bottom
ul.x Left
lr.x Right

Returns:

0
Success.
-1
The frame size was estimated, or an error occurred.

Errors:

EINVAL
The widget given isn't a window.
EOK
The frame size is an estimate.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PhRect_t, PtCalcCanvas(), PtWidgetArea(), PtWidgetDim(), PtWidgetExtent()

Window Management chapter of the Photon Programmer's Guide