LAutomation::SetPaintProperty

#include "Ltwrappr.h"

L_INT LAutomation::SetPaintProperty(nGroup, pProperty)

PAINTGROUP nGroup;

/* type of paint properties */

const L_VOID * pProperty;

/* pointer to a PAINTXXX structure */

Sets the DigitalPaint automation properties. This function is only available in the Digital Paint toolkits.

Parameter

Description

nGroup

Indicates the paint properties to set and the structure pointed to by pProperty. Possible values are:

 

Value

Meaning

 

PAINT_GROUP_BRUSH

Set the Paintbrush properties. pProperty points to a PAINTBRUSH structure.

 

PAINT_GROUP_SHAPE

Set the Paint shape properties. pProperty points to a PAINTSHAPE structure.

 

PAINT_GROUP_REGION

Set the Paint region properties. pProperty points to a PAINTREGION structure.

 

PAINT_GROUP_FILL

Set the Paint fill properties. pProperty points to a PAINTFILL structure.

 

PAINT_GROUP_TEXT

Set the Paint fill properties. pProperty points to a PAINTTEXT structure.

pProperty

Pointer to a PAINTXXX structure to be updated with the specified property values. The type of structure that this parameter points to is indicated by the nGroup parameter.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function will only work when the automation mode is AUTOMATION_MODE_PAINT.

Required DLLs and Libraries

LTAUT

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

See Also

Functions:

LAutomation::GetPaintProperty

Example

This example shows how to change the paint shape properties. 

L_INT LAutomation_SetPaintPropertyExample( LAutomation &Automation ) 
{
   L_INT nRet;
   nRet = Automation.IsValid ();
   if ( SUCCESS == nRet ) /* check the validity of the automation handle */
   {
      PAINTSHAPE shape ; 
      /* set the paint shape group properties */
      nRet = Automation.GetPaintProperty (PAINT_GROUP_SHAPE, &shape ) ; 
      if(nRet != SUCCESS)
         return nRet;
      /* do some check and change to the required properties */
      if (PAINT_SHAPE_BORDER_STYLE_SOLID == shape.nBorderStyle ) 
      {
         /* set the desired shape properties using the field masks */
         shape.nSize         = sizeof ( PAINTSHAPE ) ; 
         shape.dwMask    = PSF_BORDERSTYLE |
                                          PSF_BORDERWIDTH |
                                          PSF_BORDERENDCAP ; 
         shape.nBorderStyle  = PAINT_SHAPE_BORDER_STYLE_DOT ; 
         shape.nBorderWidth  = 10 ; 
         shape.nBorderEndCap = PAINT_SHAPE_BORDER_ENDCAP_ROUND ;
         /*set the paint shape group properties */
         nRet = Automation.SetPaintProperty (PAINT_GROUP_SHAPE, &shape ) ; 
         if(nRet != SUCCESS)
            return nRet;
      }
   }
   else
   {
      return nRet ;
   }
   return SUCCESS ;
}