Category Custom user interface, Object ProUIDrawingarea

Function ProUIDrawingareaClipchildrenSet


Description
Set the flag indicating whether drawing operations within the drawing area should be clipped so that they do not overlap any children contained within the drawing area.

NOTE: This option does not affect the initial display of the drawing area graphics using ProUIDrawingareaPostmanagenotifyActionSet() because the children are drawn after the graphics are drawn. This can be used from within other drawing area action callbacks.

Synopsis
#include <ProUIDrawingarea.h>
ProErrorProUIDrawingareaClipchildrenSet(
char* dialog
/* (In)
The name of the dialog that contains the drawing area.
*/
char* component
/* (In)
The name of the drawing area component.
*/
ProBoolean value
/* (In)
PRO_B_TRUE to clip the drawing operation. PRO_B_FALSE to not clip the drawing operation.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.

Manual References:

  1. User Interface: Dialogs: Drawing Area Attributes