LVCOMMDLGHELPCB

Summary

The callback function that will be called to provide the appropriate help information, based on the vector dialog from which help was requested.

Syntax

#include "ltvdlg.h"

L_VOID pEXT_CALLBACK LVCOMMDLGHELPCB (uDlgID, hElement, nCtlID, pUserData)

Parameters

L_UINT32 uDlgID

Id of the vector common dialog which made the help request. Possible values are:

Constant Meaning
LVDLG_HELP_ALLGROUPS Help command message coming from L_VecDlgEditAllGroups.
LVDLG_HELP_ALLLAYERS Help command message coming from L_VecDlgEditAllLayers.
LVDLG_HELP_GROUP Help command message coming from L_VecDlgEditGroup.
LVDLG_HELP_LAYER Help command message coming from L_VecDlgEditLayer.
LVDLG_HELP_HITTEST Help command message coming from L_VecDlgHitTest.
LVDLG_HELP_RENDER Help command message coming from L_VecDlgRender.
LVDLG_HELP_ROTATE Help command message coming from L_VecDlgRotate.
LVDLG_HELP_SCALE Help command message coming from L_VecDlgScale.
LVDLG_HELP_TRANSLATE Help command message coming from L_VecDlgTranslate.
LVDLG_HELP_CAMERA Help command message coming from L_VecDlgCamera.
LVDLG_HELP_VIEWMODE Help command message coming from L_VecDlgViewMode.
LVDLG_HELP_GENERAL Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_PEN Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_BRUSH Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_BRUSHSTYLE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_STDBRUSH Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_PTRBRUSH Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_GRDBRUSH Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_HATBRUSH Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_VERTEX Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_LINE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_RECTANGLE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_CIRCLE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_ELLIPSE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_POLYLINE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_POLYGON Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_POLYDRAW Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_POLYBEZIER Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_ARC Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_ELLIPTICALARC Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_PIE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_TEXT Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_RASTER Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_CLONE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject.
LVDLG_HELP_SPLINE Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject
LVDLG_HELP_HPOLYBEZIER Help command message coming from L_VecDlgEditObject or L_VecDlgNewObject

HWND hElement

Window handle of the dialog control which is requesting help information. if the handle is NULL, this means that the control which is requesting help information is the help button of the dialog.

L_INT nCtlID

ID of the dialog control which is requesting help information, IDs can be one of the following (defined in lvdlgres.h):

Transform dialog

Render dialog

View mode dialog

Hit test dialog

All layers dialog

Layer dialog

All groups dialog

Group dialog

General dialog

Pen dialog

Brush dialog

Standard Brush dialog

Pattern Brush dialog

Gradient Brush dialog

Hatch Brush dialog

Vertex dialog

Line dialog

Rectangle dialog

Polyline dialog

Polybezier dialog

Polygon dialog

Ellipse dialog

Circle dialog

Arc dialog

Text dialog

Pie dialog

Polydraw dialog

Raster dialog

Clone dialog

Elliptical arc dialog

Spline dialog

Heterogeneous Poly Bezier dialog

L_VOID pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the calling function.)

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

None.

Comments

This callback function is optional. It is necessary only if you wish to provide help information for individual dialogs. The exact nature of the help provided is up to you, but must be outlined in this callback function. In order to implement help for a dialog box, a pointer to this HelpCallback Function must be passed to the specific dialog function. By passing this pointer, a Help button is shown in the dialog.

Required DLLs and Libraries

See Also

Functions

Example

#define LVDLG_IDC_TRANSFORM_BUTTON_XUP 0 
#define LVDLG_IDC_TRANSFORM_EDIT_X 1  
#define LVDLG_IDC_TRANSFORM_BUTTON_XDOWN 2 
#define LVDLG_IDC_TRANSFORM_BUTTON_YUP 3 
#define LVDLG_IDC_TRANSFORM_EDIT_Y 4 
HWND g_hWndFrame; 
 
L_VOID EXT_CALLBACK VectorHelpCallback 
(  
   L_UINT32  uDlgID,  
   HWND      hElement, 
   L_INT     nCtlID,  
   L_VOID    *pUserData  
) 
{ 
   L_TCHAR  szBuffer[ 255 ] = TEXT("No information"); 
   L_TCHAR  szTitle[ 255 ]  = TEXT(""); 
 
 
   UNREFERENCED_PARAMETER( hElement ); 
   UNREFERENCED_PARAMETER( pUserData ); 
 
   switch( uDlgID ) 
   { 
      case LVDLG_HELP_SCALE: /* Scale Dialog */  
         lstrcpy( szTitle, TEXT("Scale")); 
         switch( nCtlID ) 
         { 
            case LVDLG_IDC_TRANSFORM_BUTTON_XUP: 
               lstrcpy( szBuffer, TEXT("Button X Up")); 
               break; 
 
            case LVDLG_IDC_TRANSFORM_EDIT_X: 
               lstrcpy( szBuffer, TEXT("Edit X")); 
               break; 
 
            case LVDLG_IDC_TRANSFORM_BUTTON_XDOWN: 
               lstrcpy( szBuffer, TEXT("Button X Down")); 
               break; 
 
            case LVDLG_IDC_TRANSFORM_BUTTON_YUP: 
               lstrcpy( szBuffer, TEXT("Button Y Up")); 
               break; 
 
            case LVDLG_IDC_TRANSFORM_EDIT_Y: 
               lstrcpy( szBuffer, TEXT("Edit Y")); 
               break; 
         } 
         break; 
   } 
 
   MessageBox( g_hWndFrame, szBuffer, szTitle, MB_OK | MB_ICONINFORMATION ); 
} 
 
L_INT LVCommDlgHelpcBExample( HWND hWnd, pVECTORHANDLE pVector ) 
{ 
   VECTORPOINT Point; 
   L_INT nRet; 
 
   nRet = L_VecGetRotation (pVector, &Point); 
   if(nRet == SUCCESS) 
      return nRet; 
   nRet = L_VecDlgRotate ( hWnd, 
                   pVector, 
                   &Point, 
                   NULL, 
                   VECTOR_DLG_AUTO_PROCESS | VECTOR_DLG_SHOW_PREVIEW,  
                   VectorHelpCallback, 
                   NULL ); 
    
   return nRet; 
}
Help Version 22.0.2022.12.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C API Help
Introduction
Version History
Getting Started
LEADTOOLS Vector Features
Redistributables/Files To Be Included With Your Application
Quick Reference
Function References
Appendix
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.