PAINTDLGTEXTINFO

Summary

The PAINTDLGTEXTINFO structure contains information about the Text dialog.

Syntax

typedef struct _PAINTDLGTEXTINFO 
{ 
   L_INT nSize; 
   L_INT32 dwFlags; 
   L_TCHAR * pszTitle; 
   L_TCHAR * pszText; 
   LOGFONTW logFont; 
   PAINTTEXTBORDERBRUSHSTYLE nBorderBrushStyle; 
   L_INT nBorderWidth; 
   COLORREF crBorderColor; 
   PAINTTEXTBACKSTYLE nBackgroundStyle; 
   COLORREF crBackgroundColor; 
   L_TCHAR ** ppszBackgroundTileBitmap; 
   L_UINT uBackgroundTileBitmapCount; 
   L_INT nActiveBackgroundTileBitmapItem; 
   PAINTALIGNMENT nAlignment; 
   L_INT nOpacity; 
   L_TCHAR ** ppszPaperTexture; 
   L_UINT uPaperTextureCount; 
   L_INT nActivePaperTextureItem; 
   PAINTTRANSFORM TransformInfo; 
} PAINTDLGTEXTINFO, *pPAINTDLGTEXTINFO; 

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.

pszText

Character string containing the text string to be drawn. The toolkit will copy this string to its internal data.

logFont

Handle to the font used to paint the text. This font should be a true type font. The toolkit will not copy this handle. Therefore, this font handle should still valid after setting this field.

nBorderBrushStyle

An enumerated type that indicates the text border (outline) style. For a list of possible values, refer to PAINTTEXTBORDERBRUSHSTYLE.

nBorderWidth

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

crBorderColor

COLORREF value that contains the text border (outline) color.

nBackgroundStyle

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

crBackgroundColor

COLORREF value that contains the text background color.

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 currently selected image in the background tile combo box.

nAlignment

An enumerated type that indicates text alignment. For a list of possible values, refer to PAINTALIGNMENT.

nOpacity

Value that indicates the transparency of the text 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.

TransformInfo

Structure that contains information used to transform the text output.

The nRotate structure field of TransformInfo will effect the text output result only when the nAlignment field is: (PAINT_ALIGNMENT_HCENTER | PAINT_ALIGNMENT_VCENTER ) Otherwise, the toolkit will consider nRotate to be 0.

Comments

An image of the Text 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  

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 nActivebackgroundTileBitmapItem field will be the value it was before the last call to the Dialog box.

Usage

• LRasterDialog::DoModalText