BORDERREMOVEDLGPARAMS

Summary

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

Syntax

typedef struct _BORDERREMOVEDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_BOOL bZoomToFit; 
   BORDERREMOVE BorderRemove; 
   COLORREF crModification; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
} BORDERREMOVEDLGPARAMS,* LPBORDERREMOVEDLGPARAMS; 

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 1-bit bitmap used for preview or processing.

bZoomToFit

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

Value Meaning
TRUE Set the initial zoom level to "Zoom to fit".
FALSE Set the initial zoom level to "Normal (1:1)".

BorderRemove

BORDERREMOVE structure that LEADTOOLS uses to perform the border removal operation.You should pass valid pBitmapRegion address and fill the uBitmapStructSize with the proper value.

✎ NOTE

Its user responsibility to free region in pBitmapRegion with L_FreeBitmapRgn if there is one.

crModification

Color used to fill the modified areas. This is used only for dialog previewing purposes. 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_BORDERREMOVE_AUTOPROCESS [0x00000001] process the image on OK. The pBitmap member of this structure should contain a valid 1-bit bitmap.
DLG_BORDERREMOVE_SHOW_CONTEXTHELP [0x00000002] dialog should contain a context sensitive help icon.
DLG_BORDERREMOVE_SHOW_PREVIEW [0x00000004] show a preview of the image in the dialog. The pBitmap member of this structure should contain a valid 1-bit bitmap.
DLG_BORDERREMOVE_SHOW_TOOL_ZOOMLEVEL [0x00000008] show the "Zoom to fit" and "Zoom Normal" toolbar buttons. The DLG_BORDERREMOVE_SHOW_PREVIEW flag must be set in order to show these buttons.

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

Help Version 22.0.2023.2.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Common Dialog C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.