PtBasicWidgetCanvas()

Determine the PtBasic canvas for a widget

Synopsis:

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

Description:

This function determines the canvas rectangle for the specified widget's PtBasic-class level. This canvas rectangle describes the area inside the widget's border and 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. If an error occurs, the function returns NULL.

Examples:

Return the rectangle inside PtWidget's border:

PtWidgetCanvas( labelwidget, &rect);

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

PtBasicWidgetCanvas( labelwidget, &rect);

Return the rectangle inside PtWidget's border, PtBasic's margins, and PtLabel's margins:

PtLabelWidgetCanvas( labelwidget, &rect);

Classification:

Photon

See also:

PtLabelWidgetCanvas(), PtWidgetCanvas(), PtWidgetExtent()