LVectorDialog::VectorHelpCallback

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 "ltwrappr.h"

L_VOID LVectorDialog::VectorHelpCallback(uDlgID, hElement, nCtlID)

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 LVectorDialog::DoModalVectorEditAllGroups.
LVDLG_HELP_ALLLAYERS Help command message coming from LVectorDialog::DoModalVectorEditAllLayers.
LVDLG_HELP_GROUP Help command message coming from LVectorDialog::DoModalVectorEditGroup.
LVDLG_HELP_LAYER Help command message coming from LVectorDialog::DoModalVectorEditLayer.
LVDLG_HELP_HITTEST Help command message coming from LVectorDialog::DoModalVectorHitTest.
LVDLG_HELP_RENDER Help command message coming from LVectorDialog::DoModalVectorRender.
LVDLG_HELP_ROTATE Help command message coming from LVectorDialog::DoModalVectorRotate.
LVDLG_HELP_SCALE Help command message coming from LVectorDialog::DoModalVectorScale.
LVDLG_HELP_TRANSLATE Help command message coming from LVectorDialog::DoModalVectorTranslate.
LVDLG_HELP_CAMERA Help command message coming from LVectorDialog::DoModalVectorCamera.
LVDLG_HELP_VIEWMODE Help command message coming from LVectorDialog::DoModalVectorViewMode.
LVDLG_HELP_GENERAL Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_PEN Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_BRUSH Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_BRUSHSTYLE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_STDBRUSH Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_PTRBRUSH Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_GRDBRUSH Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_HATBRUSH Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_VERTEX Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_LINE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_RECTANGLE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_CIRCLE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_ELLIPSE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_POLYLINE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_POLYGON Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_POLYDRAW Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_POLYBEZIER Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_ARC Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_ELLIPTICALARC Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_PIE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_TEXT Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_RASTER Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_CLONE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_SPLINE Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.
LVDLG_HELP_HPOLYBEZIER Help command message coming from LVectorDialog::DoModalVectorEditObject or LVectorDialog::DoModalVectorNewObject.

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

Brush Style 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

Returns

None.

Comments

Override this function 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 function.

This function will be called only if the callback functions are enabled, to enable callback functions for the LVectorDialog object Call LBase::EnableCallBack(TRUE). You must also enable the Help button by calling LVectorDialog::EnableHelp before displaying the dialog box.

Required DLLs and Libraries

See Also

Functions

Topics

Example

class MyVectorDialog : public LVectorDialog 
{ 
   protected:  
      L_VOID VectorHelpCallback( L_UINT32 uDlgID, HWND hElement, L_INT nCtlID );  
}; 
 
L_INT LVectorDialog__VectorHelpCallbackExample( L_UINT32 uDlgID, HWND hElement, L_INT nCtlID) 
{ 
   L_TCHAR  szBuffer[ 255 ] = TEXT("No information"); 
   L_TCHAR  szTitle[ 255 ]  = TEXT(""); 
 
   UNREFERENCED_PARAMETER( hElement ); 
 
   switch( uDlgID )  
   { 
      case LVDLG_HELP_SCALE: /* Scale Dialog */  
         lstrcpy( szTitle, TEXT("Scale"));  
         switch( nCtlID )  
         { 
            case VECTOR_DLGSTR_TRANSFORM_BUTTON_XUP:  
               lstrcpy( szBuffer, TEXT("Button X Up"));  
               break;  
         } 
         break;  
 
      case LVDLG_HELP_PEN: 
         lstrcpy( szTitle, TEXT("pen"));  
         switch( nCtlID )  
         { 
            case VECTOR_DLGSTR_PEN_FRAME_STYLE:  
               lstrcpy( szBuffer, TEXT("Pen Style"));  
               break;  
 
            case VECTOR_DLGSTR_PEN_FRAME_WIDTH:  
               lstrcpy( szBuffer, TEXT("Pen Width"));  
               break;  
 
            case VECTOR_DLGSTR_PEN_FRAME_COLOR:  
               lstrcpy( szBuffer, TEXT("Tasty colors...."));  
               break;  
         } 
         break;  
   } 
   MessageBox( NULL, szBuffer, szTitle, MB_OK | MB_ICONINFORMATION );  
   return SUCCESS; 
} 
 
L_VOID ShowMyDialog( )  
{ 
   MyVectorDialog    VectorDialog;  
   LVectorBase       Vector;  
   L_INT             nRet=0; 
 
   nRet = Vector.Load(MAKE_IMAGE_PATH(TEXT("random.dxf"))); 
   if(nRet != SUCCESS) 
      return ; 
 
   VectorDialog.SetVector( &Vector );  
 
   VectorDialog.EnablePreview( );  
 
   VectorDialog.EnableAutoProcess( );  
 
   if( VectorDialog.IsHelpEnabled( ) == FALSE )  
   { 
      VectorDialog.EnableHelp( );  
   } 
 
   nRet = VectorDialog.DoModalVectorScale( );  
}
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++ Class Library Help
Introduction
Version History
Getting Started
LEADTOOLS Vector Features
Redistributables/Files To Be Included With Your Application
Quick Reference
Classes and Member Functions
Appendix
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.