PUNCHDLGPARAMS

Summary

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

Syntax

typedef struct _PUNCHDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_BOOL bZoomToFit; 
   L_UINT uStress; 
   L_INT nValue; 
   POINT ptCenter; 
   COLORREF crFill; 
   L_UINT uPunchFlags; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
} PUNCHDLGPARAMS,* LPPUNCHDLGPARAMS; 

Members

uStructSize

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

pBitmap

Pointer to the bitmap handle that references the bitmap used for preview or processing.

bZoomToFit

Flag that indicates the initial zoom level for previewing the image. Possible values are:

uStress

Amount of punching intensity. This value is ignored when nValue is less than 0. Valid values range from 0 to 1000.

nValue

Amount of stretching, where positive values pinch the image toward its center and negative values expand the image away from its center. Valid values range from −500 to 500.

ptCenter

POINT structure that contains the point around which the image will be pinched or punched. The center point must be defined inside the bitmap or inside the region, if the bitmap has a region.

crFill

The COLORREF value that specifies the fill color for any exposed areas. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color.

uPunchFlags

Flags that indicate how to handle exposed areas, both centrally and peripherally. You can use a bitwise OR ( | ) to specify one flag from each group. Possible values are:

✎ NOTE

This flag is ignored if the nValue is positive.

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_DlgPunch