STITCHDLGPARAMS

Summary

The STITCHDLGPARAMS structure provides information used to initialize the dialog box created by the L_DlgStitch function. After the user closes the dialog box, this structure is updated with information about the user's selections.

Syntax

typedef struct _STITCHDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pResultingBitmap; 
   L_UINT uResultingBitmapStructSize; 
   L_INT nResultingBitmapWidth; 
   L_INT nResultingBitmapHeight; 
   L_INT nResultingBitmapBitsPerPixel; 
   L_INT nRes; 
   COLORREF crBackGround; 
   LPDLGBITMAPLIST pBitmapList; 
   HICON hWindowIcon; 
   L_INT nCmdShow; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
} STITCHDLGPARAMS, * LPSTITCHDLGPARAMS ; 

Members

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

pResultingBitmap

Pointer to a valid bitmap handle to be updated with the bitmap resulting from the stitch dialog. If L_DlgStitch returns SUCCESS_DLG_EXPORTANDEXIT, then this bitmap is allocated and the user is responsible for freeing this handle using  L_FreeBitmap.

uResultingBitmapStructSize

Size of the BITMAPHANDLE structure referencing pResultingBitmap.

nResultingBitmapWidth

Value that indicates the resulting image's width in pixels. This value is used to initialize the Width edit box in the Image Attributes sub dialog.

nResultingBitmapHeight

Value that indicates the resulting image's height in pixels. This value is used to initialize the Height edit box in the Image Attributes sub dialog.

nResultingBitmapBitsPerPixel

Value representing the image depth of the resulting image. This may be 1, 4, 8, 16, 24 bpp. This value is used to initialize the Depth combo box in the Image Attributes sub dialog.

nRes

Horizontal and vertical resolution, in dots per inch. This value is used to initialize the Resolution edit box in the Image Attributes sub dialog.

crBackGround

The COLORREF value that specifies the background color for the resulting image. This value is used to initialize the Back-Color color picker in the Image Attributes sub dialog.

pBitmapList

Pointer to a DLGBITMAPLIST structure that is used to initialize the image picker in the dialog. The pszDescription member of the DLGBITMAPLIST structure will be used as a tool tip for each image in the image picker when the mouse hovers over it.

hWindowIcon

Handle to the icon to use for the print window's system menu. Pass NULL to use the default icon.

nCmdShow

Flag that indicates the display state of the stitch window. This is the same flag passed to the ShowWindow windows C API function. Refer to the Microsoft SDK documentation — Windows User Interface — ShowWindow for more information. Possible values include:

uDlgFlags

User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:

pfnHelpCallback

Pointer to an optional help callback function. If you do not wish to provide help to this dialog, use NULL as the value of this parameter. To provide help to this dialog, use the function pointer as the value of this parameter. The callback function must adhere to the prototype described in LTCOMMDLGHELPCB.

pHelpCallBackUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs. To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pHelpCallBackUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.

Usage

• L_DlgStitch