LEADTOOLS Common Dialog C++ Class Library Help > Quick Reference > Data Types > GRADIENTDLGPARAMS |
typedef struct _GRADIENTDLGPARAMS
{
L_UINT uStructSize;
pBITMAPHANDLE pBitmap;
L_UINT uStyle;
COLORREF crStart;
COLORREF crEnd;
L_UINT uSteps;
L_UINT32 uDlgFlags;
LTCOMMDLGHELPCB pfnHelpCallback;
L_VOID *pHelpCallBackUserData;
} GRADIENTDLGPARAMS, * LPGRADIENTDLGPARAMS;
The GRADIENTDLGPARAMS structure provides information used to initialize the dialog box created by the LDialogEffect::DoModalGetGradient 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 |
Ignored. |
|
uStyle |
The gradient style. For a list of possible values, refer to Effect Gradient Styles. |
|
crStart |
The starting color of the gradient. 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. |
|
crEnd |
The ending color of the gradient. 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 |
The number of steps in the gradient. |
|
uDlgFlags |
User interface flags for this dialog, which determines the layout and action of the dialog. Possible values are: |
|
|
Value |
Meaning |
|
DLG_GRADIENT_SHOW_CONTEXTHELP |
[0x00000001] dialog should contain a context sensitive help icon. |
|
DLG_GRADIENT_AUTOPREVIEW |
[0x00000004] auto preview when options change |
|
DLG_GRADIENT_STARTCOLOR |
[0x00000008] start color is an option |
|
DLG_GRADIENT_ENDCOLOR |
[0x00000010] end color is an option |
|
DLG_GRADIENT_STEPS |
[0x00000020] gradient steps is an option |
|
DLG_GRADIENT_NO_TREEVIEW |
[0x00000040] DO NOT use TreeView |
|
DLG_GRADIENT_CLASS_LINEAR |
[0x00000080] linear gradients are an option |
|
DLG_GRADIENT_CLASS_ANGULAR |
[0x00000100] angular gradients are an option |
|
DLG_GRADIENT_CLASS_RECTANGULAR |
[0x00000200] rectangular gradients are an option |
|
DLG_GRADIENT_CLASS_ELLIPTICAL |
[0x00000400] elliptical gradients are an option |
|
DLG_GRADIENT_CLASS_CONICAL |
[0x00000800] conical gradients are an option |
pfnHelpCallback |
Ignored. |
|
pHelpCallBackUserData |
Ignored. |