PtWidgetCanvas()

Determine the PtWidget canvas for a widget

Synopsis:

PhRect_t *PtWidgetCanvas( PtWidget_t *widget,
                          PhRect_t *canvas_rect );

Description:

This function determines the canvas rectangle for the specified widget's PtWidget-class level. This canvas rectangle describes the area inside the widget's border. The canvas_rect argument should point to an instance of a PhRect_t structure; if you pass canvas_rect as NULL, the function returns NULL.

Returns:

A pointer to the widget's canvas, or NULL if an error occurs.

Examples:

Return the area inside the widget's border:

PtWidgetCanvas( labelwidget, &rect);

Return the area inside PtWidget's border and PtBasic's margins:

PtBasicWidgetCanvas( labelwidget, &rect);

Return the area inside PtWidget's border, PtBasic's margins, and PtLabel's margins. This is the rectangle in which the label is permitted to render:

PtLabelWidgetCanvas( labelwidget, &rect);

Classification:

Photon

See also:

PtBasicWidgetCanvas(), PtLabelWidgetCanvas(), PtWidgetExtent()