TRANSITIONDLGPARAMS

Summary

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

Syntax

typedef struct _TRANSITIONDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_UINT uTransition; 
   COLORREF crBack; 
   COLORREF crFore; 
   L_UINT uSteps; 
   L_UINT uEffect; 
   L_UINT uGrain; 
   L_UINT uDelay; 
   L_UINT uMaxPass; 
   L_BOOL bTransparent; 
   COLORREF crTransparent; 
   L_UINT uWandWidth; 
   COLORREF crWand; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
} TRANSITIONDLGPARAMS,* LPTRANSITIONDLGPARAMS ; 

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.

uTransition

The transition to use. Possible values are

crBack

The background color or the starting gradient color, if a gradient transition is used. 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.

crFore

The foreground color or the ending gradient color, if a gradient transition is used. 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.

uSteps

Number of steps in the gradient.

uEffect

The effect to use. For a list of possible values, refer to Effect Types.

uGrain

The grain size, in pixels.

uDelay

The delay, in milliseconds

uMaxPass

The maximum number of passes.

bTransparent

Flag that indicates whether to use a transparent color. Possible values are:

crTransparent

The transparent color. 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.

uWandWidth

The wand width, in pixels.

crWand

The wand color. 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.

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_DlgGetTransition