LEADTOOLS Common Dialog C DLL Help > Quick Reference > Data Types > TRANSITIONDLGPARAMS |
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 ;
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.
Member |
Description |
|
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 |
|
|
Value |
Meaning |
|
EFX_TRANS_SOLID |
Solid filling |
|
EFX_TRANS_HORZ_LINE |
Horizontal lines |
|
EFX_TRANS_VERT_LINE |
Vertical lines |
|
EFX_TRANS_DOWNWARD_DIAG |
Downward diagonal lines |
|
EFX_TRANS_UPWARD_DIAG |
Upward diagonal lines |
|
EFX_TRANS_CROSS |
Cross lines |
|
EFX_TRANS_DIAG_CROSS |
Diagonal cross lines |
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: |
|
|
Value |
Meaning |
|
TRUE |
Use the transparent color specified in crTransparent. |
|
FALSE |
Do not use a transparent color. |
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: |
|
|
Value |
Meaning |
|
DLG_TRANSITION_SHOW_CONTEXTHELP |
[0x00000001] dialog should contain a context sensitive help icon. |
|
DLG_TRANSITION_SHOW_PREVIEW |
[0x00000002] show a preview of the image in the dialog. The pBitmap member of this structure should contain a valid bitmap. |
|
DLG_TRANSITION_AUTOPREVIEW |
[0x00000004] auto preview when options change |
|
DLG_TRANSITION_FORECOLOR |
[0x00000008] fore color is an option |
|
DLG_TRANSITION_BACKCOLOR |
[0x00000010] back color is an option |
|
DLG_TRANSITION_DELAY |
[0x00000020] transition delay is an option |
|
DLG_TRANSITION_GRAIN |
[0x00000040] transition grain is an option |
|
DLG_TRANSITION_EFFECT |
[0x00000080] paint effect is an option |
|
DLG_TRANSITION_PASSES |
[0x00000100] transition passes is an option |
|
DLG_TRANSITION_WAND |
[0x00000200] wand is an option |
|
DLG_TRANSITION_TRANSPARENT |
[0x00000400] transparency is an option |
|
DLG_TRANSITION_GRADIENT |
[0x00000800] gradient is an option |
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. |