PtLabelWidgetCanvas()

Determine the PtLabel canvas for a widget

Synopsis:

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

Description:

This function determines the canvas rectangle for the specified widget's PtLabel-class level. This canvas rectangle describes the area inside PtWidget's border, PtBasic's margins, and PtLabel's margins.

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 canvas of the PtBasic widget, or NULL if an error occurred.

Examples:

Return the area inside PtWidget'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:

PtLabelWidgetCanvas( labelwidget, &rect);

Classification:

Photon

See also:

PtLabelWidgetCanvas(), PtWidgetCanvas(), PtWidgetExtent()