PAINTDLGSHAPEINFO

Summary

The PAINTDLGSHAPEINFO structure contains information about the Shape dialog.

Syntax

typedef struct _PAINTDLGSHAPEINFO 
{ 
   L_INT nSize; 
   L_INT32 dwFlags; 
   L_TCHAR * pszTitle; 
   PAINTSHAPEBACKSTYLE nBackgroundStyle; 
   COLORREF crBackgroundColor; 
   L_TCHAR ** ppszBackgroundTileBitmap; 
   L_UINT uBackgroundTileBitmapCount; 
   L_INT nActiveBackgroundTileBitmapItem; 
   PAINTSHAPEBORDERSTYLE nBorderStyle; 
   L_INT nBorderWidth; 
   PAINTSHAPEBORDERBRUSHSTYLE nBorderBrushStyle; 
   COLORREF crBorderColor; 
   L_TCHAR ** ppszBorderTileBitmap; 
   L_UINT uBorderTileBitmapCount; 
   L_INT nActiveBorderTileBitmapItem; 
   PAINTSHAPEGRADIENTSTYLE nGradientStyle; 
   COLORREF crGradientStartColor; 
   COLORREF crGradientEndColor; 
   L_UINT uGradientSteps; 
   PAINTSHAPEBORDERENDCAP nBorderEndCap; 
   L_INT nRoundRectEllipseWidth; 
   L_INT nRoundRectEllipseHeight; 
   L_INT nOpacity; 
   L_TCHAR ** ppszPaperTexture; 
   L_UINT uPaperTextureCount; 
   L_INT nActivePaperTextureItem; 
} PAINTDLGSHAPEINFO, *pPAINTDLGSHAPEINFO ; 

Members

nSize

Size of this structure.

dwFlags

User interface flags for the dialog. Determines the layout and action of the dialog. Possible values are

pszTitle

Character string containing the Dialog box caption text.

nBackgroundStyle

An enumerated type that indicates the background style. For a list of possible values, refer to PAINTSHAPEBACKSTYLE.

crBackgroundColor

COLORREF value that specifies the color to be used to fill the shape when nBackgroundStyle is PAINT_SHAPE_BACK_STYLE_OPAQUE.

ppszBackgroundTileBitmap

Array of strings containing the names of the images used to fill the background tile bitmap combo box.

uBackgroundTileBitmapCount

Number of strings in ppszBackgroundTileBitmap.

nActiveBackgroundTileBitmapItem

Index of the image currently selected in the paper texture combo box.

nBorderStyle

An enumerated type that indicates the border style. For a list of possible values, refer to PAINTSHAPEBORDERSTYLE.

nBorderWidth

Value indicating the width of the border, in pixels. Valid values are 1 to 100.

nBorderBrushStyle

An enumerated type that indicates the brush style used to draw the shape's border. For a list of possible values, refer to PAINTSHAPEBORDERBRUSHSTYLE.

crBorderColor

COLORREF value that specifies the color used to draw the shape's border.

ppszBorderTileBitmap

Array of strings containing the names of the images used to fill the border tile bitmap combo box.

uBorderTileBitmapCount

Number of strings in ppszBorderTileBitmap.

nActiveBorderTileBitmapItem

Index of the image currently selected in the background tile combo box.

nGradientStyle

An enumerated type that indicates the shape's background gradient fill style. For a list of possible values, refer to PAINTSHAPEGRADIENTSTYLE.

crGradientStartColor

COLORREF value that specifies the color that will start the background gradient fill.

crGradientEndColor

COLORREF value that specifies the color that will end the background gradient fill.

uGradientSteps

Number of gradient color steps. Valid values are 2 to 255.

nBorderEndCap

An enumerated type that indicates how the ends of lines will be drawn. For a list of possible values, refer to PAINTSHAPEBORDERENDCAP.

nRoundRectEllipseWidth

Value indicating the width, in pixels, of the ellipse used to create a rounded rectangle. Valid values are 0 to 500.

nRoundRectEllipseHeight

Value indicating the height, in pixels, of the ellipse used to create a rounded rectangle. Valid values are 0 to 500.

nOpacity

Value indicating the transparency of the shape when combined with the painting canvas. Valid values are 0 to 255. A color or an image with an opacity of 255 is transparent a color or an image with an opacity of 0 is completely opaque (solid).

ppszPaperTexture

Array of strings containing the names of the images used to fill the paper texture combo box.

uPaperTextureCount

Number of strings in ppszPaperTexture.

nActivePaperTextureItem

Index of the currently selected image in the paper texture combo box.

Comments

An image of the Shape dialog can be seen below.

When the uBackgroundTileBitmapCount field value is set to 0 or when the ppszBackgroundTileBitmap field value is set to NULL, the structure members shown below will automatically be set to the following values:

ppszBackgroundTileBitmap= NULL   
uBackgroundTileBitmapCount= 0    
nActiveBackgroundTileBitmapItem = -1  

When the uBorderTileBitmapCount field value is set to 0 or when the ppszBorderTileBitmap field value is set to NULL, the structure members shown below will automatically be set to the following values:

ppszBorderTileBitmap = NULL    
uBorderTileBitmapCount = 0    
nActiveBorderTileBitmapItem = -1  

The nActivePaperTextureItem field value will be 1 when the user selects "none" from the paper texture combo box.

When the value of the nActivePaperTextureItem is set to 1, the current selection in the paper texture combo box will be "none".

When the user presses the default button, the dialog box will reset to the default values, for all fields, except nActiveBackgroundTileBitmapItem. The nActiveBorderTileBitmapItem value will be the value it was before the last call to the Dialog box.

Usage

• LRasterDialog::DoModalShape