LDialogBase::DialogHelpCallBack

Summary

Provides the appropriate help information based on the dialog from which help was requested.

Syntax

#include "ltwrappr.h"

virtual L_VOID LDialogBase::DialogHelpCallBack(uFlag, iControlID)

Parameters

L_UINT32 uFlag

Flag that indicates the origin of the help command message. Possible values are:

Value Meaning
DLG_HELP_OPEN [1] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_SAVE [2] Help command message coming from LDialogFile::DoModalSave.
DLG_HELP_COLORRES [3] Help command message coming from LDialogColor::DoModalColorRes.
DLG_HELP_RESIZE [4] Help command message coming from LDialogImage::DoModalResize.
DLG_HELP_INTENSITYDETECT [5] Help command message coming from LDialogColor::DoModalIntensityDetect.
DLG_HELP_GAMMAADJUSTMENT [6] Help command message coming from LDialogColor::DoModalGammaAdjustment.
DLG_HELP_ADDNOISE [7] Help command message coming from LDialogImageEffect::DoModalAddNoise.
DLG_HELP_GETEFFECT [8] Help command message coming from LDialogEffect::DoModalGetEffect.
DLG_HELP_GETSHAPE [9] Help command message coming from LDialogEffect::DoModalGetShape.
DLG_HELP_GETTEXT [10] Help command message coming from LDialogEffect::DoModalGetText.
DLG_HELP_GETGRADIENT [11] Help command message coming from LDialogEffect::DoModalGetGradient.
DLG_HELP_GETTRANSITION [12] Help command message coming from LDialogEffect::DoModalGetTransition.
DLG_HELP_GETDIRECTORY [13] Help command message coming from LDialogFile::DoModalGetDirectory.
DLG_HELP_CONTOURFILTER [14] Help command message coming from LDialogImageEffect::DoModalContourFilter.
DLG_HELP_HALFTONE [15] Help command message coming from LDialogColor::DoModalHalfTone.
DLG_HELP_J2KOPTIONS [16] Help command message coming from LDialogFile::DoModalSave.
DLG_HELP_FILEINFO [17] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_SOLARIZE [18] Help command message coming from LDialogColor::DoModalSolarize.
DLG_HELP_BRIGHTNESS [19] Help command message coming from LDialogColor::DoModalBrightness.
DLG_HELP_CONTRAST [20] Help command message coming from LDialogColor::DoModalContrast.
DLG_HELP_HUE [21] Help command message coming from LDialogColor::DoModalHue.
DLG_HELP_SATURATION [22] Help command message coming from LDialogColor::DoModalSaturation.
DLG_HELP_POSTERIZE [24] Help command message coming from LDialogColor::DoModalPosterize.
DLG_HELP_HISTOCONTRAST [25] Help command message coming from LDialogColor::DoModalHistoContrast.
DLG_HELP_AVERAGE [26] Help command message coming from LDialogImageEffect::DoModalAverage.
DLG_HELP_MEDIAN [27] Help command message coming from LDialogImageEffect::DoModalMedian.
DLG_HELP_MAXFILTER [28] Help command message coming from LDialogImageEffect::DoModalMaxFilter.
DLG_HELP_MINFILTER [29] Help command message coming from LDialogImageEffect::DoModalMinFilter.
DLG_HELP_SHARPEN [30] Help command message coming from LDialogImageEffect::DoModalSharpen.
DLG_HELP_SHIFTDIFFERENCEFILTER [31] Help command message coming from LDialogImageEffect::DoModalShiftDifferenceFilter.
DLG_HELP_EMBOSS [32] Help command message coming from LDialogImageEffect::DoModalEmboss.
DLG_HELP_OILIFY [33] Help command message coming from LDialogImageEffect::DoModalOilify.
DLG_HELP_MOSAIC [34] Help command message coming from LDialogImageEffect::DoModalMosaic.
DLG_HELP_EROSIONFILTER [35] Help command message coming from LDialogImageEffect::DoModalErosionFilter.
DLG_HELP_DILATIONFILTER [36] Help command message coming from LDialogImageEffect::DoModalDilationFilter.
DLG_HELP_GRADIENTFILTER [37] Help command message coming from LDialogImageEffect::DoModalGradientFilter.
DLG_HELP_LAPLACIANFILTER [38] Help command message coming from LDialogImageEffect::DoModalLaplacianFilter.
DLG_HELP_SOBELFILTER [39] Help command message coming from LDialogImageEffect::DoModalSobelFilter.
DLG_HELP_PREWITTFILTER [40] Help command message coming from LDialogImageEffect::DoModalPrewittFilter.
DLG_HELP_LINESEGMENTFILTER [41] Help command message coming from LDialogImageEffect::DoModalLineSegmentFilter.
DLG_HELP_ROTATE [42] Help command message coming from LDialogImage::DoModalRotate.
DLG_HELP_SHEAR [43] Help command message coming from LDialogImage::DoModalShear.
DLG_HELP_LOADOPTIONS_VECTOR [44] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_RASTER [45] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_PDF [46] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_GENERAL [47] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_SMOOTH [48] Help command message coming from LDialogDocument::DoModalSmooth.
DLG_HELP_LINEREMOVE [49] Help command message coming from LDialogDocument::DoModalLineRemove.
DLG_HELP_BORDERREMOVE [50] Help command message coming from LDialogDocument::DoModalBorderRemove.
DLG_HELP_INVERTEDTEXT [51] Help command message coming from LDialogDocument::DoModalInvertedText.
DLG_HELP_DOTREMOVE [52] Help command message coming from LDialogDocument::DoModalDotRemove.
DLG_HELP_HOLEPUNCHREMOVE [53] Help command message coming from LDialogDocument::DoModalHolePunchRemove.
DLG_HELP_COLOR [54] Help command message coming from LDialogColor::DoModalColor.
DLG_HELP_CANVASRESIZE [55] Help command message coming from LDialogImage::DoModalCanvasResize.
DLG_HELP_ADDFRAME [56] Help command message coming from LDialogImage::DoModalAddFrame.
DLG_HELP_FILESASSOCIATION [57] Help command message coming from LDialogFile::DoModalFilesAssociation.
DLG_HELP_GIFWEBTUNER [58] Help command message coming from LDialogWeb::DoModalGIFWebTuner.
DLG_HELP_ADDBORDER [59] Help command message coming from LDialogImage::DoModalAddBorder.
DLG_HELP_HTMLMAPPER [60] Help command message coming from LDialogWeb::DoModalHTMLMapper.
DLG_HELP_JPEGWEBTUNER [62] Help command message coming from LDialogWeb::DoModalJPEGWebTuner.
DLG_HELP_PNGWEBTUNER [63] Help command message coming from LDialogWeb::DoModalPNGWebTuner.
DLG_HELP_CUSTOMIZEPALETTE [64] Help command message coming from LDialogColor::DoModalCustomizePalette.
DLG_HELP_PICTURIZE [65] Help command message coming from LDialogImageEffect::DoModalPicturize.
DLG_HELP_UNDERLAY [66] Help command message coming from LDialogImageEffect::DoModalUnderlay.
DLG_HELP_AUTOTRIM [67] Help command message coming from LDialogImage::DoModalAutoTrim.
DLG_HELP_GAUSSIANBLUR [68] Help command message coming from LDialogImageEffect::DoModalGaussianBlur.
DLG_HELP_UNSHARPMASK [69] Help command message coming from LDialogImageEffect::DoModalUnsharpMask.
DLG_HELP_ANTIALIAS [70] Help command message coming from LDialogImageEffect::DoModalAntiAlias.
DLG_HELP_EDGEDETECTOR [71] Help command message coming from LDialogImageEffect::DoModalEdgeDetector.
DLG_HELP_MOTIONBLUR [72] Help command message coming from LDialogImageEffect::DoModalMotionBlur.
DLG_HELP_GRAYSCALE [73] Help command message coming from LDialogColor::DoModalGrayScale.
DLG_HELP_COLOREDGRAY [74] Help command message coming from LDialogColor::DoModalColoredGray.
DLG_HELP_HISTOGRAM [75] Help command message coming from LDialogImage::DoModalHistogram.
DLG_HELP_MULTIPLY [76] Help command message coming from LDialogImageEffect::DoModalMultiply.
DLG_HELP_LOCALHISTOEQUALIZE [78] Help command message coming from LDialogColor::DoModalLocalHistoEqualize.
DLG_HELP_BALANCECOLORS [79] Help command message coming from LDialogColor::DoModalBalanceColors.
DLG_HELP_ADDBITMAPS [80] Help command message coming from LDialogImageEffect::DoModalAddBitmaps.
DLG_HELP_PRINTPREVIEW [81] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_REMAPINTENSITY [82] Help command message coming from LDialogColor::DoModalRemapIntensity.
DLG_HELP_REMAPHUE [83] Help command message coming from LDialogColor::DoModalRemapHue.
DLG_HELP_FREEHANDWAVE [84] Help command message coming from LDialogImageEffect::DoModalFreeHandWave.
DLG_HELP_WIND [85] Help command message coming from LDialogImageEffect::DoModalWind.
DLG_HELP_IMPRESSIONIST [86] Help command message coming from LDialogImageEffect::DoModalImpressionist.
DLG_HELP_CYLINDRICAL [87] Help command message coming from LDialogImageEffect::DoModalCylindrical.
DLG_HELP_POLAR [88] Help command message coming from LDialogImageEffect::DoModalPolar.
DLG_HELP_PIXELATE [89] Help command message coming from LDialogImageEffect::DoModalPixelate.
DLG_HELP_STITCH [90] Help command message coming from LDialogImageEffect::DoModalStitch.
DLG_HELP_STITCH_TILE [91] Help command message coming from LDialogImageEffect::DoModalStitch.
DLG_HELP_STITCH_ATTRIBUTES [92] Help command message coming from LDialogImageEffect::DoModalStitch.
DLG_HELP_ZOOMWAVE [93] Help command message coming from LDialogImageEffect::DoModalZoomWave.
DLG_HELP_RADIALWAVE [94] Help command message coming from LDialogImageEffect::DoModalRadialWave.
DLG_HELP_RIPPLE [95] Help command message coming from LDialogImageEffect::DoModalRipple.
DLG_HELP_PUNCH [96] Help command message coming from LDialogImageEffect::DoModalPunch.
DLG_HELP_BENDING [97] Help command message coming from LDialogImageEffect::DoModalBending.
DLG_HELP_SPHERIZE [98] Help command message coming from LDialogImageEffect::DoModalSpherize.
DLG_HELP_SWIRL [99] Help command message coming from LDialogImageEffect::DoModalSwirl.
DLG_HELP_RADIALBLUR [100] Help command message coming from LDialogImageEffect::DoModalRadialBlur.
DLG_HELP_ZOOMBLUR [101] Help command message coming from LDialogImageEffect::DoModalZoomBlur.
DLG_HELP_WAVE [102] Help command message coming from LDialogImageEffect::DoModalWave.
DLG_HELP_WAVESHEAR [103] Help command message coming from LDialogImageEffect::DoModalWaveShear.
DLG_HELP_FILECONVERSION [104] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_FILESAVEOPTIONS [105] Help command message coming from LDialogFile::DoModalSave.
DLG_HELP_FILELOADOPTIONS [106] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_FILECONVERSION_LOGREPORT [107] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_PRINTPREVIEW_PREFERENCES [108] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_PRINTSTITCHEDIMAGES [109] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_PRINTSTITCHEDIMAGES_DELETEPAGES [110] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_PRINTSTITCHEDIMAGES_INSERTPAGES [111] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_PRINT [112] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_PAGESETUP [113] Help command message coming from LDialogFile::DoModalPrintStitchedImages.
DLG_HELP_FILECONVERSION_PROGRESS [114] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_FILECONVERSION_ADDPROGRESS[115] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_NAMINGTEMPLATE [116] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_RENAME [117] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_FILECONVERSION_ROTATE [118] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_FILECONVERSION_RESIZE [119] Help command message coming from LDialogFile::DoModalFileConversion.
DLG_HELP_WINDOWLEVEL [120] Help command message coming from LDialogColor::DoModalWindowLevel
DLG_HELP_JBIG2OPTIONS [121] Help command message coming from LDialogFile::DoModalSave and LDialogFile::DoModalFileConversion.
DLG_HELP_ICCPROFILE [122] Help command message coming from LDialogFile::DoModalICCProfile.
DLG_HELP_LOADOPTIONS_XPS [123] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_J2KROIOPTIONS [124] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_XLS [125] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_RASTERIZEDOCUMENT [126] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_VFF [127] Help command message coming from LDialogFile::DoModalOpen.
DLG_HELP_LOADOPTIONS_ANZ [128] Help command message coming from LDialogFile::DoModalOpen.

L_INT iControlID

The ID of the control that received the context sensitive help request.

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 LDialogBase object Call LBase::EnableCallBack(TRUE).

Required DLLs and Libraries

See Also

Functions

Topics

Example

For an example, refer to LDialogBase::SetFont.

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

LEADTOOLS Common Dialog C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.