HTMLMAPPERDLGPARAMS

Summary

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

Syntax

typedef struct _HTMLMAPPERDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_BOOL bZoomToFit; 
   LPDLGHISTORYLIST pURLEntries; 
   LPDLGHISTORYLIST pALTEntries; 
   LPDLGHISTORYLIST pTargetEntries; 
   LPDLGHISTORYLIST pRolloverEntries; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
} HTMLMAPPERDLGPARAMS, * LPHTMLMAPPERDLGPARAMS; 

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:

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

pURLEntries

Pointer to an array of DLGHISTORYLIST structures that contains URLs displayed in the URL History Combo Box in the dialog. These URLs may be associated with a specific area and activated when the user clicks on that area. This member can be NULL. Set this member to initialize the dialog. This member will be updated with the value entered by the user in the dialog.

pALTEntries

Pointer to an array of DLGHISTORYLIST structures that contain information used in the ALT history combo box in the dialog. The ALT history combo box may be used to enter a short description of a specific area. Some browsers can display this text as a tool tip when the user hovers over the area. This parameter can be NULL. Set this member to initialize the dialog. This member will be updated with the value entered by the user in the dialog.

pTargetEntries

Pointer to an array of DLGHISTORYLIST structures that contain information used in the Target history combo box in the dialog. The information in the Target combo box can be used to determine how the new page should be displayed. This parameter can be NULL. Set this member to initialize the dialog. This member will be updated with the value entered by the user in the dialog.

pRolloverEntries

Pointer to an array of DLGHISTORYLIST structures that contain information used in the Rollover history combo box in the dialog. This parameter can be NULL. Set this member to initialize the dialog. This member will be updated with the value entered by the user in the dialog.

uDlgFlags

User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:

Value Meaning
DLG_HTMLMAPPER_SHOW_CONTEXTHELP [0x00000001] Dialog should contain a context sensitive help icon.

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.