[JVCL-Checkins] CVS: dev/help JVCL.dox,1.35,1.36

[Marcel Bestebroer <jedi_mbe@us...>]

Update of /cvsroot/jvcl/dev/help
In directory usw-pr-cvs1:/tmp/cvs-serv1297/dev/help

Modified Files:
	JVCL.dox 
Log Message:
* Added JvCheckBox, JvDSADialogs documentation
* Added "Additional Information" group

Index: JVCL.dox
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JVCL.dox,v
retrieving revision 1.35
retrieving revision 1.36
diff -C2 -d -r1.35 -r1.36
*** JVCL.dox	5 Sep 2002 12:44:15 -0000	1.35
--- JVCL.dox	6 Sep 2002 17:02:52 -0000	1.36
***************
*** 10,14 ****
  
  [Source Files]
! Count=62
  File0=generic\eventstypes.pas
  File1=..\..\jvcl\source\JvAddPrinter.pas
--- 10,14 ----
  
  [Source Files]
! Count=64
  File0=generic\eventstypes.pas
  File1=..\..\jvcl\source\JvAddPrinter.pas
***************
*** 33,76 ****
  File20=..\..\jvcl\source\JvCaptionButton.pas
  File21=..\..\jvcl\source\JvCaptionPanel.pas
! File22=..\..\jvcl\source\JvColorCombo.pas
! File23=..\..\jvcl\source\JvComponent.pas
! File24=..\..\jvcl\source\JvDataEmbedded.pas
! File25=..\..\jvcl\source\JvDateTimePicker.pas
! File26=..\..\jvcl\source\JvEdit.pas
! File27=..\..\jvcl\source\JvFileInfo.pas
! File28=..\..\jvcl\source\JvInspDB.pas
! File29=..\..\jvcl\source\JvInspector.pas
! File30=..\..\jvcl\source\JvListBox.pas
! File31=..\..\jvcl\source\JvScreenCanvas.pas
! File32=..\..\jvcl\source\JvScreenResolution.pas
! File33=..\..\jvcl\source\JvScrollBar.pas
! File34=..\..\jvcl\source\JvScrollBox.pas
! File35=..\..\jvcl\source\JvScrollingLabel.pas
! File36=..\..\jvcl\source\JvScrollText.pas
! File37=..\..\jvcl\source\JvSearchFiles.pas
! File38=..\..\jvcl\source\JvSerialDlg.pas
! File39=..\..\jvcl\source\JvShape.pas
! File40=..\..\jvcl\source\JvSHFileOp.pas
! File41=..\..\jvcl\source\JvSizeablePanel.pas
! File42=..\..\jvcl\source\JvSlider.pas
! File43=..\..\jvcl\source\JvSoundControl.pas
! File44=..\..\jvcl\source\JvSpacer.pas
! File45=..\..\jvcl\source\JvSpecialImage.pas
! File46=..\..\jvcl\source\JvSpecialLabel.pas
! File47=..\..\jvcl\source\JvSpecialProgress.pas
! File48=..\..\jvcl\source\JvSpeedButton.pas
! File49=..\..\jvcl\source\JvSplitter.pas
! File50=..\..\jvcl\source\JvStarfield.pas
! File51=..\..\jvcl\source\JvStaticText.pas
! File52=..\..\jvcl\source\JvStatusBar.pas
! File53=..\..\jvcl\source\JvStringGrid.pas
! File54=..\..\jvcl\source\JvSyncSplitter.pas
! File55=..\..\jvcl\source\JvSysComp.pas
! File56=..\..\jvcl\source\JvSystemPopup.pas
! File57=..\..\jvcl\source\JvTextcontainer.pas
! File58=..\..\jvcl\source\JvThreadTimer.pas
! File59=..\..\jvcl\source\JvTimeLimit.pas
! File60=..\..\jvcl\source\JvToolBar.pas
! File61=..\..\jvcl\source\JvTrayIcon.pas
  
  [Source Include Directories]
--- 33,78 ----
  File20=..\..\jvcl\source\JvCaptionButton.pas
  File21=..\..\jvcl\source\JvCaptionPanel.pas
! File22=..\..\jvcl\source\JvCheckBox.pas
! File23=..\..\jvcl\source\JvColorCombo.pas
! File24=..\..\jvcl\source\JvComponent.pas
! File25=..\..\jvcl\source\JvDataEmbedded.pas
! File26=..\..\jvcl\source\JvDateTimePicker.pas
! File27=..\..\jvcl\source\JvDSADialogs.pas
! File28=..\..\jvcl\source\JvEdit.pas
! File29=..\..\jvcl\source\JvFileInfo.pas
! File30=..\..\jvcl\source\JvInspDB.pas
! File31=..\..\jvcl\source\JvInspector.pas
! File32=..\..\jvcl\source\JvListBox.pas
! File33=..\..\jvcl\source\JvScreenCanvas.pas
! File34=..\..\jvcl\source\JvScreenResolution.pas
! File35=..\..\jvcl\source\JvScrollBar.pas
! File36=..\..\jvcl\source\JvScrollBox.pas
! File37=..\..\jvcl\source\JvScrollingLabel.pas
! File38=..\..\jvcl\source\JvScrollText.pas
! File39=..\..\jvcl\source\JvSearchFiles.pas
! File40=..\..\jvcl\source\JvSerialDlg.pas
! File41=..\..\jvcl\source\JvShape.pas
! File42=..\..\jvcl\source\JvSHFileOp.pas
! File43=..\..\jvcl\source\JvSizeablePanel.pas
! File44=..\..\jvcl\source\JvSlider.pas
! File45=..\..\jvcl\source\JvSoundControl.pas
! File46=..\..\jvcl\source\JvSpacer.pas
! File47=..\..\jvcl\source\JvSpecialImage.pas
! File48=..\..\jvcl\source\JvSpecialLabel.pas
! File49=..\..\jvcl\source\JvSpecialProgress.pas
! File50=..\..\jvcl\source\JvSpeedButton.pas
! File51=..\..\jvcl\source\JvSplitter.pas
! File52=..\..\jvcl\source\JvStarfield.pas
! File53=..\..\jvcl\source\JvStaticText.pas
! File54=..\..\jvcl\source\JvStatusBar.pas
! File55=..\..\jvcl\source\JvStringGrid.pas
! File56=..\..\jvcl\source\JvSyncSplitter.pas
! File57=..\..\jvcl\source\JvSysComp.pas
! File58=..\..\jvcl\source\JvSystemPopup.pas
! File59=..\..\jvcl\source\JvTextcontainer.pas
! File60=..\..\jvcl\source\JvThreadTimer.pas
! File61=..\..\jvcl\source\JvTimeLimit.pas
! File62=..\..\jvcl\source\JvToolBar.pas
! File63=..\..\jvcl\source\JvTrayIcon.pas
  
  [Source Include Directories]
***************
*** 78,156 ****
  
  [Description Files]
! Count=74
  File0=generated includes\JVCL.FuncRef.dtx
  File1=generic\JVCL.Acknowledge.dtx
  File2=generic\JVCL.FileRef.dtx
! File3=generic\JVCL.Main.AboutJVCL.dtx
! File4=generic\JVCL.Main.dtx
! File5=generic\JVCL.Team.Coord.dtx
! File6=generic\JVCL.Team.Develop.dtx
! File7=generic\JVCL.Team.Global.dtx
! File8=generic\JVCL.Team.Help.dtx
! File9=JvAddPrinter.dtx
! File10=JvAlarms.dtx
! File11=JvAngleLabel.dtx
! File12=JvAnimate.dtx
! File13=JvAnimTitle.dtx
! File14=JvAppAnimatedIcon.dtx
! File15=JvAppearingLabel.dtx
! File16=JvAppHotKey.dtx
! File17=JvAppInfo.dtx
! File18=JvArrow.dtx
! File19=JvArrowBtn.dtx
! File20=JvAutoSizeCompo.dtx
! File21=JvBaseDlg.dtx
! File22=JvBevel.dtx
! File23=JvBitBtn.dtx
! File24=JvBlinkingLabel.dtx
! File25=JvBMPListBox.dtx
! File26=JvCaesarCipher.dtx
! File27=JvCalendar.dtx
! File28=JvCaptionButton.dtx
! File29=JvCaptionPanel.dtx
! File30=JvColorCombo.dtx
! File31=JvComponent.dtx
! File32=JvDataEmbedded.dtx
! File33=JvDateTimePicker.dtx
! File34=JvEdit.dtx
! File35=JvFileInfo.dtx
! File36=JvInsp.dtx
! File37=JvInspCtrl.dtx
! File38=JvInspData.dtx
! File39=JvInspItem.dtx
! File40=JvInspPainter.dtx
! File41=JvInspReg.dtx
! File42=JvListBox.dtx
! File43=JvScreenCanvas.dtx
! File44=JvScreenResolution.dtx
! File45=JvScrollBar.dtx
! File46=JvScrollBox.dtx
! File47=JvScrollingLabel.dtx
! File48=JvScrollText.dtx
! File49=JvSearchFiles.dtx
! File50=JvSerialDlg.dtx
! File51=JvShape.dtx
! File52=JvSHFileOp.dtx
! File53=JvSizeablePanel.dtx
! File54=JvSlider.dtx
! File55=JvSoundControl.dtx
! File56=JvSpacer.dtx
! File57=JvSpecialImage.dtx
! File58=JvSpecialLabel.dtx
! File59=JvSpecialProgress.dtx
! File60=JvSpeedButton.dtx
! File61=JvSplitter.dtx
! File62=JvStarfield.dtx
! File63=JvStaticText.dtx
! File64=JvStatusBar.dtx
! File65=JvStringGrid.dtx
! File66=JvSyncSplitter.dtx
! File67=JvSysComp.dtx
! File68=JvSystemPopup.dtx
! File69=JvTextcontainer.dtx
! File70=JvThreadTimer.dtx
! File71=JvTimeLimit.dtx
! File72=JvToolBar.dtx
! File73=JvTrayIcon.dtx
  
  [Description Include Directories]
--- 80,162 ----
  
  [Description Files]
! Count=78
  File0=generated includes\JVCL.FuncRef.dtx
  File1=generic\JVCL.Acknowledge.dtx
  File2=generic\JVCL.FileRef.dtx
! File3=generic\JVCL.InfoGrp.dtx
! File4=generic\JVCL.Main.AboutJVCL.dtx
! File5=generic\JVCL.Main.dtx
! File6=generic\JVCL.Team.Coord.dtx
! File7=generic\JVCL.Team.Develop.dtx
! File8=generic\JVCL.Team.Global.dtx
! File9=generic\JVCL.Team.Help.dtx
! File10=info\JVCL.Info.Dialogs.dtx
! File11=JvAddPrinter.dtx
! File12=JvAlarms.dtx
! File13=JvAngleLabel.dtx
! File14=JvAnimate.dtx
! File15=JvAnimTitle.dtx
! File16=JvAppAnimatedIcon.dtx
! File17=JvAppearingLabel.dtx
! File18=JvAppHotKey.dtx
! File19=JvAppInfo.dtx
! File20=JvArrow.dtx
! File21=JvArrowBtn.dtx
! File22=JvAutoSizeCompo.dtx
! File23=JvBaseDlg.dtx
! File24=JvBevel.dtx
! File25=JvBitBtn.dtx
! File26=JvBlinkingLabel.dtx
! File27=JvBMPListBox.dtx
! File28=JvCaesarCipher.dtx
! File29=JvCalendar.dtx
! File30=JvCaptionButton.dtx
! File31=JvCaptionPanel.dtx
! File32=JvCheckBox.dtx
! File33=JvColorCombo.dtx
! File34=JvComponent.dtx
! File35=JvDataEmbedded.dtx
! File36=JvDateTimePicker.dtx
! File37=JvDSADialogs.dtx
! File38=JvEdit.dtx
! File39=JvFileInfo.dtx
! File40=JvInsp.dtx
! File41=JvInspCtrl.dtx
! File42=JvInspData.dtx
! File43=JvInspItem.dtx
! File44=JvInspPainter.dtx
! File45=JvInspReg.dtx
! File46=JvListBox.dtx
! File47=JvScreenCanvas.dtx
! File48=JvScreenResolution.dtx
! File49=JvScrollBar.dtx
! File50=JvScrollBox.dtx
! File51=JvScrollingLabel.dtx
! File52=JvScrollText.dtx
! File53=JvSearchFiles.dtx
! File54=JvSerialDlg.dtx
! File55=JvShape.dtx
! File56=JvSHFileOp.dtx
! File57=JvSizeablePanel.dtx
! File58=JvSlider.dtx
! File59=JvSoundControl.dtx
! File60=JvSpacer.dtx
! File61=JvSpecialImage.dtx
! File62=JvSpecialLabel.dtx
! File63=JvSpecialProgress.dtx
! File64=JvSpeedButton.dtx
! File65=JvSplitter.dtx
! File66=JvStarfield.dtx
! File67=JvStaticText.dtx
! File68=JvStatusBar.dtx
! File69=JvStringGrid.dtx
! File70=JvSyncSplitter.dtx
! File71=JvSysComp.dtx
! File72=JvSystemPopup.dtx
! File73=JvTextcontainer.dtx
! File74=JvThreadTimer.dtx
! File75=JvTimeLimit.dtx
! File76=JvToolBar.dtx
! File77=JvTrayIcon.dtx
  
  [Description Include Directories]

[JVCL-Checkins] CVS: dev/help/generic JVCL.InfoGrp.dtx,NONE,1.1 JVCL.Main.dtx,1.3,1.4

[Marcel Bestebroer <jedi_mbe@us...>]

Update of /cvsroot/jvcl/dev/help/generic
In directory usw-pr-cvs1:/tmp/cvs-serv996/dev/help/generic

Modified Files:
	JVCL.Main.dtx 
Added Files:
	JVCL.InfoGrp.dtx 
Log Message:
* Added "Additional Info" node
* Updated TOPICORDER values for all main nodes.

--- NEW FILE: JVCL.InfoGrp.dtx ---
####################################################################################################
## JVCL.InfoGrp.dtx: Additional information group                                                 ##
####################################################################################################
@@$JVCL.Info
<GROUP JVCL>
<TOPICORDER -1>
<TITLE Additional information>
Description
  Some of the components and controls are so extensive, that not all information can be captured in
  the component and class descriptions. For these components and controls, additional informational
  topic are written, that explain the component and it's background in more detail, often giving a
  more elobarate explanation of the component, it's underlaying technique and additional routines
  and classes involved.
  
  This group is devided in such a way that the first level show either the component name, it's
  unit name or a name that encompasses the components/units involved.


Index: JVCL.Main.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/generic/JVCL.Main.dtx,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** JVCL.Main.dtx	1 Sep 2002 10:02:00 -0000	1.3
--- JVCL.Main.dtx	6 Sep 2002 17:01:40 -0000	1.4
***************
*** 40,44 ****
  @@Donators
  <GROUP JVCL>
! <TOPICORDER -3>
  Description
    JEDI-VCL would not exists without the donation of components and controls. Below is a list (in
--- 40,44 ----
  @@Donators
  <GROUP JVCL>
! <TOPICORDER -20>
  Description
    JEDI-VCL would not exists without the donation of components and controls. Below is a list (in
***************
*** 48,52 ****
  @@Team
  <GROUP JVCL>
! <TOPICORDER -2>
  Description
    JEDI-VCL is maintained by a group of dedicated people. The team is split up in various areas of
--- 48,52 ----
  @@Team
  <GROUP JVCL>
! <TOPICORDER -15>
  Description
    JEDI-VCL is maintained by a group of dedicated people. The team is split up in various areas of
***************
*** 68,72 ****
  @@Acknowledge
  <GROUP JVCL>
! <TOPICORDER -1>
  Description
    JEDI-VCL would like to thank the following people and organizations for their support in various
--- 68,72 ----
  @@Acknowledge
  <GROUP JVCL>
! <TOPICORDER -10>
  Description
    JEDI-VCL would like to thank the following people and organizations for their support in various
***************
*** 74,76 ****
    <INCLUDE JVCL.Acknowledge.dtx>
  ----------------------------------------------------------------------------------------------------
- 
--- 74,75 ----

[JVCL-Checkins] CVS: dev/help JvCheckBox.dtx,1.3,1.4 JvDSADialogs.dtx,NONE,1.1

[Marcel Bestebroer <jedi_mbe@us...>]

Update of /cvsroot/jvcl/dev/help
In directory usw-pr-cvs1:/tmp/cvs-serv31453/dev/help

Added Files:
	JvCheckBox.dtx JvDSADialogs.dtx 
Log Message:
* Added JvCheckbox and JvDSADialogs documentation


--- NEW FILE: JvDSADialogs.dtx ---
@@$TJvDSADialog
<GROUP JVCL.Dialogs.Custom, JVCL.Info.Dialogs>
<TITLE TJvDSADialog>
  The TJvDSADialog component allows you to make any form a "don't show again" dialog with minimal
  changes, both in usage as well as design.

  Converting a dialog into a DSA dialog involves the following tasks:

  * Create and design the form or use an existing form.
  * Drop a control on the form that has both a "Checked" as well as a "Caption" property. A
    TCheckBox will do fine. There is no need to provide a caption for the check box, as it will be
    set by the DSA backend when the dialog is shown.
  * Drop a TJvDSADialog component on the form. The component will be the link between the VCL form
    and the DSA backend. You need to set DialogID to a registered dialog (you can optionally
    register the dialog in the initialization section of this unit).
  * Use ShowModal to display the form or retrieve the last modal result if the form was previously
    suppressed.

  TJvDSADialog will hook the ShowModal virtual method of the form it is on. This allows the
  component to check the DSA state and either call the original ShowModal method or just return it's
  result. Note that because the ShowModal method of the form the component is on is being hooked, it
  doesn't matter if a custom form is used that happens to override the ShowModal method. This
  overriden method will be called if the dialog is to be displayed.
----------------------------------------------------------------------------------------------------
@@JvDSADialogs.pas
<GROUP JVCL.FileRef>
Summary
  Provides code and a component to manage and create DSA (Don't Show Again) dialogs.
<INCLUDE JVCL.UnitText.dtx>
Author
  Marcel Bestebroer
----------------------------------------------------------------------------------------------------
@@TJvDSADialog
<GROUP TJvDSADialog>
<TITLEIMG TJvDSADialog>
Summary
  Converts a form into a "Don't Show Again" dialog.
Description
  The TJvDSADialog component converts the form it's placed on into a DSA ("Don't Show Again")
  dialog. The component is basically a link between a VCL form and the included DSA backend.

  A quick "how to" for the component can be found <LINK $JVCL.Comps.TJvDSADialogs, here>.
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.ApplySavedState
Summary
  Applies the saved state of the dialog.
Description
  ApplySavedState retrieves all info of the dialog from the DSA storage and applies it to the form.
  By default this will result in the saved ModalResult being applied to the form's ModalResult
  property. In addition, if an OnApplyKeys event is assigned, the event will be called with all
  neccessary information to retrieve custom stored data from the DSA storage.
See Also
  OnApplyKeys, UpdateDSAState
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.CheckControl
Summary
  Reference to the control to use as a DSA state setter.
Description
  CheckControl is a reference to the control to use as a DSA state toggler.

  The control has to have both a "Checked" as well as a "Caption" property. Usually you will use a
  TCheckBox control, but for TJvDSADialog it doesn't matter what kind of control is used (eg. it is
  possible to use a third party's check box equivalent control, even if it's not descending from
  TCustomCheckBox).
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.DialogID
Summary
  Indicates the dialog's ID in the DSA system.
Description
  DialogID indicates the dialog's ID to use with the DSA system. If the specified ID is not
  registered, an exception will be raised as soon as the form is used.
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.GetDSAStateInternal
Summary
  Retrieves the DSA state for the dialog.
Description
  GetDSAStateInternal retrieves the DSA state and ModalResult from the DSA storage.

  If the dialog is suppressed the method will return True and ModalResult will be set to the saved
  ModalResult code. If an event handler is assigned to OnApplyKey, it will be triggered as well.

  If the dialog is not suppressed the method will return False and ModalResult will be set to mrNone
  (0).
Parameters
  ModalResult - variable to retrieve the saved ModalResult value in.
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.GetModalResult
Summary
  Retrieves the ModalResult from the owner form.
Description
  GetModalResult retrieves the ModelResult from the Owner. Since TJvDSADialog can only be placed on
  a TCustomForm descendant, a simple typecast is used to cast the owner to a TCustomForm and
  retrieve the ModalResult value.
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.GetOrgOwner
Summary
  Retrieves the owner of the component.
Description
  GetOrgOwner retrieves the reference to owner (form) of the component. Because the Owner property
  is set to nil before Destroy is called, the unpatching mechanism can not use Owner. To circumvent
  this, the patch method will store a reference to the form which the unpatch method can use.
See Also
  FormPatch, FormUnPatch
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.GetOrgShowModalPtr
Summary
  Retrieves the original ShowModal code pointer.
Description
  GetOrgShowModalPtr retrieves the original ShowModal code pointer as stored by the FormPatch
  method. The pointer is used in two situations:

  1 The dialog was not suppressed and needs to be displayed.
  2 The dialog is being disposed and needs to be unpatched.
See Also
  FormPatch, FormUnPatch
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.GetStorage
Summary
  Retrieves a reference to storage device for this dialog.
Description
  GetStorage will retrieve the reference to the storage device assigned to the dialog. It is the
  read method for the Storage property.

  It's used internally to retrieve and store the DSA state and dialog result.
See Also
  Storage
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.FormPatch
Summary
  Pathes the form for DSA usage.
Description
  FormPatch will patch the form so that it can be used as a DSA dialog. The patch involves the
  following:

  1 Retrieve the VMT index for ShowModal
  2 Store the original pointer for ShowModal using SetOrgShowModalPtr.
  3 Set the pointer for ShowModal to a new ShowModal method declared in an internal form class.
See Also
  FormUnPatch
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.FormUnPatch
Summary
  Unpathes the form for DSA usage.
Description
  FormUnPatch will unpatch the form so that it can no longer be used as a DSA dialog. Unpatch
  involves the following:

  1 Retrieve the VMT index for ShowModal
  2 Set the pointer for ShowModal to the original pointer, retrieved using GetOrgShowModalPtr.
See Also
  FormPatch
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.IsDSAChecked
Summary
  Checks if the DSA state has been set to "suppress".
Description
  IsDSAChecked checks if the DSA state has been set to suppressed state. The base implementation
  does this by checking the CheckControl's Checked property, but descendant can override this to do
  additional checking.
See Also
  CheckControl
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.OnApplyKeys
<COMBINEWITH TJvDSADataEvent>
Summary
  Occurs when the DSA state is read in from the DSA storage.
Description
  Write an OnApplyKeys event handler to retrieve additional (custom) data from the DSA storage 
  related to this dialog. This event (together with OnUpdateKeys) allows you to store and retrieve
  additional information (e.g. the ItemIndex of a combo box) along with the DSA state and modal
  result for the dialog.
Parameters
  Sender  - reference to the TJvDSADialog component.
  DSAInfo - reference to the DSA registration item for the dialog.
  Storage - reference to the storage where the dialog info is stored.
See Also
  OnUpdateKeys
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.OnUpdateKeys
<COMBINEWITH TJvDSADataEvent>
Summary
  Occurs when the DSA state is written to the DSA storage.
Description
  Write an OnUpdateKeys event handler to store additional (custom) data from the DSA storage 
  related to this dialog. This event (together with OnApplyKeys) allows you to store and retrieve
  additional information (e.g. the ItemIndex of a combo box) along with the DSA state and modal
  result for the dialog.
Parameters
  Sender  - reference to the TJvDSADialog component.
  DSAInfo - reference to the DSA registration item for the dialog.
  Storage - reference to the storage where the dialog info is stored.
See Also
  OnApplyKeys
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.OrgOwner
Summary
  References the owner of the component.
Description
  OrgOwner is the reference to the owner (form) of the component. Because the Owner property is set
  to nil before Destroy is called, the unpatching mechanism can not use Owner. To circumvent this,
  the patch method will store a reference to the form which the unpatch method can use.
See Also
  FormPatch, FormUnPatch
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.OrgShowModalPtr
Summary
  Holds the original ShowModal code pointer.
Description
  OrgShowModalPtr holds the original ShowModal code pointer as stored by the FormPatch method. The
  pointer is used in two situations:

  1 The dialog was not suppressed and needs to be displayed.
  2 The dialog is being disposed and needs to be unpatched.
See Also
  FormPatch, FormUnPatch
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.Storage
Summary
  Reference to storage device for this dialog.
Description
  Storage holds the reference to the storage device assigned to the dialog.

  It's used internally to retrieve and store the DSA state and dialog result.
----------------------------------------------------------------------------------------------------
@@TJvDSADialog.UpdateDSAState
Summary
  Stores the DSA state in the DSA storage.
Description
  UpdateDSAState will store the DSA state and ModalResult value in the DSA storage. In addition, if
  an event handler is assigned to OnUpdateKeys it will be triggered to allow storing custom data in
  the DSA storage.
See Also
  ApplySavedState, OnUpdateKeys
----------------------------------------------------------------------------------------------------
@@EJvDSADialog
Summary
  Exception class for TJvDSADialog errors.
Description
  EJvDSADialog is the exception class used for errors using the TJvDSADialog the TJvDSADialog
  component.
----------------------------------------------------------------------------------------------------

[JVCL-Checkins] CVS: dev/help/info JVCL.Info.Dialogs.dtx,NONE,1.1

[Marcel Bestebroer <jedi_mbe@us...>]

Update of /cvsroot/jvcl/dev/help/info
In directory usw-pr-cvs1:/tmp/cvs-serv30893/dev/help/info

Added Files:
	JVCL.Info.Dialogs.dtx 
Log Message:
* Added JvDSADialogs additional info.

--- NEW FILE: JVCL.Info.Dialogs.dtx ---
----------------------------------------------------------------------------------------------------
@@$JVCL.Info.Dialogs
<GROUP JVCL.Info>
<TITLE JvDSADialogs overview>
<TOPICORDER 500>
  <LINK JvDSADialogs.pas, JvDSADialogs> provides routines that allow you to create message dialogs
  with the following possibilities:

  * set different default button, cancel button and/or help button.
  * provide different button captions and results.
  * provide other dialog captions
  * provide a custom icon

  In addition it provides you with procedures to create
  <LINK $JVCL.Info.Dialogs.DSA, "don't show again" dialogs> with the same possibilities as the standard
  dialogs. The state and results of these dialogs can be stored anywhere.
  
  It also provides a VCL component (TJvDSADialog) that will allow you to transform any TCustomForm
  descendant to work as a DSA dialog by simply dropping the component on the form, set a few
  properties and provide check box like control.
----------------------------------------------------------------------------------------------------
@@$JVCL.Info.Dialogs.DSA
<GROUP JVCL.Info.Dialogs>
<TITLE Don't Show Again (DSA) dialogs>
<TOPICORDER -100>
  In addition to the extensions provided by the MessageDlg and MessageDlgEx functions, JvDSADialogs
  also provide you with "Don't show again" dialogs. Throughout the help, these dialogs will be
  referred to as DSA dialogs.

  All DSA related functions/procedures and classes have DSA in their name for better distinction
  between standard dialogs and DSA dialogs.

  The storage of the "don't show again" state and the result of the dialog are stored in an abstract
  storage device, TDSAStorage.

  JVCL standard provides you with storage in the registry, but you can derive new classes from
  TDSAStorage to provide different storage capabilities.

  Each DSA dialog should be numbered, named and registered. By registering, the DSA system knows how
  to identify the dialog in the storage, as well as which storage it should use (in other words:
  different dialogs can be stored in different storage devices).

  The DSAMessageDlg and DSAMessageDlgEx have one additional parameter to provide the dialog ID. 
  Based on the state of this dialog, it's either displayed to the user, or the last result is
  returned.
----------------------------------------------------------------------------------------------------
@@$JVCL.Info.Dialogs.DSA.Chk
<GROUP JVCL.Info.Dialogs.DSA>
<TITLE DSA dialogs check mark texts>
<TOPICORDER -2400>
  For each dialog you can specify which text should be displayed next to the check mark. To keep the
  number of strings to store to a minimum, you must register a check mark text to the system, 
  including a numeric ID. This ID is used to specify the check mark text when you register a dialog.
----------------------------------------------------------------------------------------------------
@@$JVCL.Info.Dialogs.DSA.Reg
<GROUP JVCL.Info.Dialogs.DSA>
<TITLE DSA dialogs registration>
<TOPICORDER -800>
  To be able to use a specific dialog as a DSA dialog, it needs to be registered with the system so
  it can determine/maintain the state of the dialog.

  Because the registration key can be either an integer or a name, depending on the storage, both
  need to be registered, and can only occur once.

  To use a DSA dialog, you'll have to specify the integer ID in the various DSA* methods.
----------------------------------------------------------------------------------------------------
@@$JVCL.Info.Dialogs.DSA.Storage
<GROUP JVCL.Info.Dialogs.DSA>
<TITLE DSA dialogs storage devices>
<TOPICORDER -700>
  To allow you to store the state and values for a DSA dialog in any place, a class hierarchy for
  storage devices is available.

  In addition to the standard devices, you can derive a new class from any of the provided classes
  to create a new storage device.
----------------------------------------------------------------------------------------------------
## Types
----------------------------------------------------------------------------------------------------
@@TDlgCenterKind
<GROUP JVCL.Info.Dialogs.Types>
Summary
  Type to indicate the way a dialog should be centered.
Description
  The TDlgCenterKind is used to indicate the way a dialog should be centered. It's used for the
  Center parameter in the various \ShowMessage and \MessageDlg routines.
@@TDlgCenterKind.dckScreen
  Center the dialog on the screen.
@@TDlgCenterKind.dckMainForm
  Center the dialog on the main form.
@@TDlgCenterKind.dckActiveForm
  Center the dialog on the active form.
----------------------------------------------------------------------------------------------------
## ShowMessage, ShowMessageFmt, MessageDlg and MessageDlgEx
----------------------------------------------------------------------------------------------------
@@ShowMessage
<GROUP JVCL.Info.Dialogs>
Summary
  Display a message box.
Description
  ShowMessage is a replacement for Delphi's \ShowMessage. It allows you to optionally specify how
  the dialog is centered.
Parameters
  Msg -     Contains the message to display.
  Center -  Indicates how the dialog is to be centered. The default is to center on the screen, but
            you can specify to center on the main form or the active form.
See Also
  DSAShowMessage, ShowMessageFmt
----------------------------------------------------------------------------------------------------
@@ShowMessageFmt
<GROUP JVCL.Info.Dialogs>
Summary
  Display a message box.
Description
  ShowMessageFmt is a replacement for Delphi's \ShowMessageFmt. It allows you to optionally specify
  how the dialog is centered.
Parameters
  Msg -     Contains the message to display.
  Params -  Parameters to use for formatting.
  Center -  Indicates how the dialog is to be centered. The default is to center on the screen, but
            you can specify to center on the main form or the active form.
See Also
  DSAShowMessageFmt, ShowMessage
----------------------------------------------------------------------------------------------------
@@MessageDlg
<GROUP JVCL.Info.Dialogs>
Summary
  MessageDlg replacement with additional settings.
Description
  MessageDlg is a replacement for the MessageDlg function in Delphi's Dialog unit. It gives you more
  control over the appearance of the dialog.

  In it's simplest form, it does exactly the same as the MessageDlg function in Delphi's Dialogs
  unit, but has three optional parameters that allow you to choose different default, cancel and/or
  help buttons.

  The second form allows you to provide a different caption of the dialog, but otherwise does the
  same as the first form.

  The third form allows you to provide both a different caption as well as a different image.

  If you need more control over button captions and results, use MessageDlgEx instead.
Parameters
  Msg -           Contains the message to display.
  DlgType -       The dialog type.
  Buttons -       A list of buttons to display.
  HelpCtx -       Help context to use when the help button is clicked or F1 is pressed.
  Center -        Indicates how the dialog is to be centered. The default is to center on the
                  screen, but you can specify to center on the main form or the active form.
  DefaultButton - The button to mark as default. If you do not provide a default button, the
                  MessageDlg mechanism is used to determine the default button.
  CancelButton -  The button to mark as cancel. If you do not provide a cancel button, the
                  MessageDlg mechanism is used to determine the cancel button.
  HelpButton -    The button to mark as help. If you do not provide a help button, the button mbHelp
                  will be used. If such a button does not exist, no button will be marked as help.
  Caption -       The caption of the dialog.
  Picture -       A TGraphic descendant of the image to show or <B>nil</B> if no image should be
                  shown.
Result
  Returns the modal result of the displayed dialog.
Note
  If the user presses Ctrl-C in the dialog, the contents of the dialog is copied to the clipboard.
See Also
  DSAMessageDlg, MessageDlgEx
----------------------------------------------------------------------------------------------------
@@MessageDlgEx
<GROUP JVCL.Info.Dialogs>
Summary
  \MessageDlg replacement with additional settings.
Description
  MessageDlgEx is a replacement for Delphi's \MessageDlg function and an extension of JvDSADialog's
  MessageDlg that gives you more control over the appearance of the dialog.

  MessageDlgEx allows to specify custom button captions and result codes for the dialog. Just as 
  JvDSADialog's MessageDlg, MessageDlgEx has three forms that allow you to customize it's
  appearance.
Parameters
  Msg -           Contains the message to display.
  DlgType -       The dialog type.
  Buttons -       List of button captions.
  Results -       List of result codes.
  HelpCtx -       Help context to use when the help button is clicked or F1 is pressed.
  Center -        Indicates how the dialog is to be centered. The default is to center on the
                  screen, but you can specify to center on the main form or the active form.
  DefaultButton - The button to mark as default. If you do not provide a default button, the first
                  button is marked as default. If you do not want a default button, set this
                  parameter to -1. This parameter is an index into the Buttons/Results array.
  CancelButton -  The button to mark as cancel. If you do not provide a cancel button, the second
                  button is marked as cancel. If you do not want a cancel button, set this parameter
                  to -1. This parameter is an index into the Buttons/Results array.
  HelpButton -    The button to mark as help. If you do not provide a help button, no button will be
                  marked as help. This parameter is an index into the Buttons/Results array.
  Caption -       The caption of the dialog.
  Picture -       A TGraphic descendant of the image to show or <B>nil</B> if no image
                  should be shown.
Result
  Returns the modal result of the displayed dialog.
Note
  If the user presses Ctrl-C in the dialog, the contents of the dialog is copied
  to the clipboard.
See Also
  DSAMessageDlgEx, MessageDlg
----------------------------------------------------------------------------------------------------
## DSAShowMessage, DSAShowMessageFmt, DSAMessageDlg and DSAMessageDlgEx
----------------------------------------------------------------------------------------------------
@@DSAShowMessage
<GROUP JVCL.Info.Dialogs.DSA>
Summary
  Display a message box.
Description
  DSAShowMessage is a replacement for Delphi's \ShowMessage. It allows you to optionally specify how
  the dialog is centered. The user can optionally disable the dialog in the future.
Parameters
  DlgID -   ID of the dialog in the DSA system.
  Msg -     Contains the message to display.
  Center -  Indicates how the dialog is to be centered. The default is to center on the screen, but
            you can specify to center on the main form or the active form.
See Also
  ShowMessage, DSAShowMessageFmt
----------------------------------------------------------------------------------------------------
@@DSAShowMessageFmt
<GROUP JVCL.Info.Dialogs.DSA>
Summary
  Display a message box.
Description
  DSAShowMessageFmt is a replacement for Delphi's \ShowMessageFmt. It allows you to optionally 
  specify how the dialog is centered. The user can optionally disable the dialog in the future.
Parameters
  DlgID -   ID of the dialog in the DSA system.
  Msg -     Contains the message to display.
  Params -  Parameters to use for formatting.
  Center -  Indicates how the dialog is to be centered. The default is to center on the screen, but
            you can specify to center on the main form or the active form.
See Also
  ShowMessageFmt, DSAShowMessage
----------------------------------------------------------------------------------------------------
@@DSAMessageDlg
<GROUP JVCL.Info.Dialogs.DSA>
Summary
  \MessageDlg replacement with additional settings and "Don't show again" capabilities.
Description
  DSAMessageDlg is a replacement for Delphi's \MessageDlg function and an extension to MessageDlg
  that allow the user to optionally disable the dialog in the future.

  In it's simplest form, it does exactly the same as the \MessageDlg function in Delphi's Dialogs
  unit, but has an dialog ID parameter and three optional parameters that allow you to choose
  different default, cancel and/or help buttons.

  The second form allows you to provide a different caption of the dialog, but otherwise does the
  same as the first form.

  The third form allows you to provide both a different caption as well as a different image.

  If you need more control over button captions and results, use DSAMessageDlgEx instead.
Parameters
  DlgID -         ID of the dialog in the DSA system.
  Msg -           Contains the message to display.
  DlgType -       The dialog type.
  Buttons -       A list of buttons to display.
  HelpCtx -       Help context to use when the help button is clicked or F1 is pressed.
  Center -        Indicates how the dialog is to be centered. The default is to center on the
                  screen, but you can specify to center on the main form or the active form.
  DefaultButton - The button to mark as default. If you do not provide a default button, the
                  \MessageDlg mechanism is used to determine the default button.
  CancelButton -  The button to mark as cancel. If you do not provide a cancel button, the
                  \MessageDlg mechanism is used to determine the cancel button.
  HelpButton -    The button to mark as help. If you do not provide a help button, the button mbHelp
                  will be used. If such a button does not exist, no button will be marked as help.
  Caption -       The caption of the dialog.
  Picture -       A TGraphic descendant of the image to show or <B>nil</B> if no image should be
                  shown.
Result
  Returns the modal result of the displayed dialog or the last result if the dialog was suppressed.
Note
  If the user presses Ctrl-C in the dialog, the contents of the dialog is copied to the clipboard.
See Also
  DSAMessageDlgEx, MessageDlg
----------------------------------------------------------------------------------------------------
@@DSAMessageDlgEx
<GROUP JVCL.Info.Dialogs.DSA>
Summary
  \MessageDlg replacement with additional settings and "Don't show again" capabilities.
Description
  DSAMessageDlgEx is an extension to MessageDlgEx that allow the user to optionally disable the
  dialog in the future.
Parameters
  DlgID -         ID of the dialog in the DSA system.
  Msg -           Contains the message to display.
  DlgType -       The dialog type.
  Buttons -       List of button captions.
  Results -       List of result codes.
  HelpCtx -       Help context to use when the help button is clicked or F1 is pressed.
  Center -        Indicates how the dialog is to be centered. The default is to center on the
                  screen, but you can specify to center on the main form or the active form.
  DefaultButton - The button to mark as default. If you do not provide a default button, the first
                  button is marked as default. If you do not want a default button, set this
                  parameter to -1. This parameter is an index into the Buttons/Results array.
  CancelButton -  The button to mark as cancel. If you do not provide a cancel button, the second
                  button is marked as cancel. If you do not want a cancel button, set this parameter
                  to -1. This parameter is an index into the Buttons/Results array.
  HelpButton -    The button to mark as help. If you do not provide a help button, no button will be
                  marked as help. This parameter is an index into the Buttons/Results array.
  Caption -       The caption of the dialog.
  Picture -       A TGraphic descendant of the image to show or <B>nil</B> if no image should be
                  shown.
Result
  Returns the modal result of the displayed dialog or the last result if the dialog was suppressed.
Note
  If the user presses Ctrl-C in the dialog, the contents of the dialog is copied to the clipboard.
See Also
  DSAMessageDlg, MessageDlgEx
----------------------------------------------------------------------------------------------------
@@TDSARegItem
<GROUP JVCL.Info.Dialogs.DSA.Reg>
Summary
  Type used to hold DSA registration information.
Description
  TDSARegItem is a record to hold information about a registered DSA dialog. This type is used
  internally by the registration database and passed on to the storage device when retrieving state
  and values.
  
  It is also used by the events that allow you to store or retrieve custom data associated with a
  dialog.
@@TDSARegItem.ID
  The dialog ID number.
@@TDSARegItem.Name
  The identifying name of the dialog.
@@TDSARegItem.Description
  The description of the dialog, useful for dialogs for restoring DSA states.
@@TDSARegItem.Storage
  The storage device that holds the DSA state and values.
@@TDSARegItem.ChkTextKind
  The ID of the check mark text to use.
----------------------------------------------------------------------------------------------------
## DSA Storage: Base class
----------------------------------------------------------------------------------------------------
@@TDSAStorage
<GROUP JVCL.Info.Dialogs.DSA.Storage>
Summary
  Abstract storage device for DSA state and values.
Description
  TDSAStorage is the abstract base class used for storing DSA states and dialog values in. Do not
  create an instance of this class directly but rather use one of it's descendants.

  When deriving a new class from TDSAStorage, always override all methods.
----------------------------------------------------------------------------------------------------
@@TDSAStorage.CheckMarkTextSuffix
Summary
  Suffix of the check mark caption.
Description
  CheckMarkTextSuffix holds the string to append to the check mark text. Usually this will be an
  empty string, but can be used to append texts such as "in the current queue", which would result
  in "Don't show this dialog again in the current queue." or "Don't ask again in the current
  queue.", depending on the dialogs ChkMarkTextKind settings.

  You should not append a period (.) at the end of this string; this will be done automatically.

  The base class declares this property read-only as this is the most common situation. Descendants
  might set the write specifier to SetCheckMarkCaption to allow changing the check mark text suffix.
See Also
  GetCheckMarkTextSuffix, SetCheckMarkTextSuffix
----------------------------------------------------------------------------------------------------
@@TDSAStorage.GetCheckMarkTextSuffix
Summary
  Retrieve the string to append to the check mark text.
Description
  GetCheckMarkTextSuffix returns the string to append to the check mark text. Usually this will be
  an empty string, but can be used to append texts such as "in the current queue", which would
  result in "Don't show this dialog again in the current queue." or "Don't ask again in the current
  queue.", depending on the dialogs ChkMarkTextKind settings.

  Since the method is declared abstract, descendants must override it.
See Also
  CheckMarkTextSuffix, SetCheckMarkTextSuffix
----------------------------------------------------------------------------------------------------
@@TDSAStorage.GetState
Summary
  Retrieve the current state and result code of the DSA dialog.
Description
  GetState will retrieve the state and result code of the specified DSA dialog from the storage
  device.

  If the dialog was marked to be suppressed, the function will return True and LastResult will hold
  the ModalResult of the dialog when it was last closed.

  If the dialog was not marked to be suppressed, the function will return False and LastResult will
  be set to 0.
Parameters
  DSAInfo -       Registration info of the DSA dialog in question.
  LastResult -    On exit will hold the result code of the dialog when the DSA state was set.
  OnCustomData -  Provide an OnCustomData handler if additional info should be retrieved from the
                  storage. Leave this parameter <B>nil</B> if no additional data is to be retrieved.
See Also
  SetState
----------------------------------------------------------------------------------------------------
@@TDSAStorage.SetCheckMarkTextSuffix
Summary
  Set the string to append to the check mark text.
Description
  SetCheckMarkTextSuffix allows to set the check mark text suffix. Usually this is not wanted and
  most descendant will override this with an empty method or not at all.

  Since the method is declared abstract, descendants must override it if changes in the CheckMark
  text suffix are wanted.
Parameters
  Value - String to set the suffix to. Do not append a period (.) to this string, as this will be
          done when the full check mark text is determined.
See Also
  CheckMarkTextSuffix, GetCheckMarkTextSuffix
----------------------------------------------------------------------------------------------------
@@TDSAStorage.SetState
Summary
  Sets the current state and result code of the DSA dialog.
Description
  SetState will set the state and result code of the specified DSA dialog in the storage device.
Parameters
  DSAInfo -       Registration info of the DSA dialog in question.
  DontShowAgain - Flag to indicate if teh dialog should be suppressed. Some storage devices may
                  elect to remove the reference of this dialog when this parameter is set to False,
                  others may leave the reference and just update the DSA state.
  LastResult -    The result code of the dialog when to store along with the DSA state. By
                  convention, this parameter should be set to 0 if DontShowAgain is False.
                  Depending on the storage device, this might be enforced.
  OnCustomData -  Provide an OnCustomData handler if additional info should be stored in the
                  storage. Leave this parameter <B>nil</B> if no additional data is to be retrieved.
See Also
  GetState
----------------------------------------------------------------------------------------------------
## DSA Storage: registry
----------------------------------------------------------------------------------------------------
@@TDSARegStorage
<GROUP JVCL.Info.Dialogs.DSA.Storage>
Summary
  Registry storage device for DSA state and values.
Description
  TDSARegStorage is the class used for storing DSA states and dialog values in the registry.
  JvDSADialogs creates an instance of this class, retrievable through DSARegStore.

  TDSARegStorage uses <LINK $RegistryandInifiles.Registry, JclRegistry> to communicate with the
  windows registry.

  If the DSA state is reset to show the dialog again, the key for the dialog are removed.

  The dialog's internal name (as specified by the Name parameter for RegisterDSA) is used as a sub
  key for the key specified by the Key property.
----------------------------------------------------------------------------------------------------
@@TDSARegStorage.Create
Summary
  Instantiate and initialize a registry storage device.
Description
  Create instantiates and initializes a registry storage device. The two parameters will be used to
  initialize the RootKey and Key properties.
Parameters
  ARootKey - The HKEY value to initialize the RootKey property to.
  AKey - The value to initialize the Key property to.
----------------------------------------------------------------------------------------------------
@@TDSARegStorage.Key
Summary
  Key path where the info should be stored.
Description
  Key holds the path from RootKey where the DSA info is to be stored. For each dialog a sub key with
  the name of the dialog will be generated, holding at least two values, DSA_State and LastResult.
See Also
  RootKey
----------------------------------------------------------------------------------------------------
@@TDSARegStorage.RootKey
Summary
  Root key for the registry storage.
Description
  RootKey holds the HKEY value of the key the DSA info is to be stored.
See Also
  Key
----------------------------------------------------------------------------------------------------
@@DSARegStore
<GROUP JVCL.Info.Dialogs.DSA.Storage>
Summary
  Retrieves a reference to the default registry storage.
Description
  DSARegStore retrieves a reference to internally create registry storage. The storage is
  initialized to use <B>HKCU\\Software\\<I>Application.Title</I>\\DSA</B> as it's storage.
See Also
  TDSARegStorage
----------------------------------------------------------------------------------------------------
## DSA registration
----------------------------------------------------------------------------------------------------
@@LocateDSAReg
<GROUP JVCL.Info.Dialogs.DSA.Reg>
Summary
  Locates and returns the DSA registration info for a given dialog.
Description
  LocateDSAReg will search the DSA registration database for the given dialog and return it's
  registration info record. If the specified dialog is not registered, EmptyItem will be returned.
See Also
  RegisterDSA, UnregisterDSA
----------------------------------------------------------------------------------------------------
@@RegisterDSA
<GROUP JVCL.Info.Dialogs.DSA.Reg>
Summary
  Register a DSA dialog.
Description
  RegisterDSA registers a new DSA dialog with the system. The given ID and Name may not already
  exist within the registration, but may exist in the storage device.

  If the given ID and Name match an existing dialog, the procedure will do nothing. If either the ID
  or Name are registered, an exception will be raised.
Parameters
  DlgID -         ID of the dialog in the DSA system.
  Name -          Reference name of the dialog. Might be used by the storage device as an
                  identification.
  Description -   Description of the dialog. Could be used by a UI for DSA managment (re-enabling
                  disabled dialogs).
  Storage -       Reference to the storage device that will maintain the DSA state.
  CheckTextKind - The kind of text to display next to the check box. See RegisterDSACheckMarkText
                  and UnregisterDSACheckMarkText for more information.
See Also
  UnregisterDSA
----------------------------------------------------------------------------------------------------
@@UnregisterDSA
<GROUP JVCL.Info.Dialogs.DSA.Reg>
Summary
  Remove a DSA dialog from the system.
Description
  UnregisterDSA removes a DSA dialog from the system.  If the specified dialog ID is not registered,
  the procedure does nothing.

  Removing the DSA dialog does not remove it from the storage device, but the specified ID can not
  be used to invoke an DSA dialog and will result in an exception.
Parameters
  DlgID - ID of the dialog in the DSA system.
See Also
  RegisterDSA
----------------------------------------------------------------------------------------------------
@@DSACount
<GROUP JVCL.Info.Dialogs.DSA.Reg>
Summary
  Returns the number of  DSA dialogs registered.
Description
  DSACount returns the number of DSA dialogs registered with the system.
See Also
  DSAItem, RegisterDSA, UnregisterDSA
----------------------------------------------------------------------------------------------------
@@DSAItem
<GROUP JVCL.Info.Dialogs.DSA.Reg>
Summary
  Retrieves a DSA registration item.
Description
  DSAItem retrieves the registration item at the <B>Index</B>th position in the registration
  database. The index is 0-based and runs from 0 .. DSACount-1.
Parameters
  Index - The item index to retrieve. Valid values lie in the range 0 .. DSACount-1.
See Also
  DSACount, RegisterDSA, UnregisterDSA
----------------------------------------------------------------------------------------------------
## DSA state setting/retrieving
----------------------------------------------------------------------------------------------------
@@GetDSAState
<GROUP JVCL.Info.Dialogs.DSA>
Summary
  Retrieves DSA state.
Description
  GetDSAState retrieves the state of the specified DSA dialog, optionally returning the last
  ModalResult of the dialog.
Parameters
  DlgID -         ID of the dialog in the DSA system.
  ResCode -       If this parameter is specified, it will receive the stored ModalResult value if
                  the dialog is suppressed. Otherwise this parameter will be set to 0. 
  OnCustomData -  Provide an OnCustomData handler if additional info should be retrieved from the
                  storage. Leave this parameter <B>nil</B> if no additional data is to be retrieved.
See Also
  SetDSState
----------------------------------------------------------------------------------------------------
@@SetDSAState
<GROUP JVCL.Info.Dialogs.DSA>
Summary
  Sets DSA state.
Description
  SetDSAState sets the state of the specified DSA dialog.
Parameters
  DlgID -         ID of the dialog in the DSA system.
  DontShowAgain - Flag indicating if the dialog should be enabled or disabled. When set to True, the
                  dialog will be disabled.
  LastResult -    The ModalResult value to store. By default this is set to mrNone.
  OnCustomData -  Provide an OnCustomData handler if additional info should be stored in the
                  storage. Leave this parameter <B>nil</B> if no additional data is to be stored.
See Also
  GetDSState
----------------------------------------------------------------------------------------------------
@@TDSACheckTextKind
<GROUP JVCL.Info.Dialogs.DSA.Chk>
Summary
  ID of check mark text.
Description
  TDSACheckTextKind is the type used to identify the type of check mark text to use. JvDSADialogs
  declares the following types:

  <TABLE>
  Value           Text
  -----           ----
  ctkShow         Don't show this dialog again
  ctkAsk          Don't ask me again
  ctkWarn         Don't warn me again
  </TABLE
See Also
  RegisterDSACheckMarkText, UnregisterDSACheckMarkText
@@ctkShow
  <ALIAS TDSACheckTextKind>
@@ctkAsk
  <ALIAS TDSACheckTextKind>
@@ctkWarn
  <ALIAS TDSACheckTextKind>
----------------------------------------------------------------------------------------------------
@@GetDSACheckMarkText
<GROUP JVCL.Info.Dialogs.DSA.Chk>
Summary
  Retrieves the check mark text for the given ID.
Description
  GetDSACheckMarkText will locate and return the check mark text for the given ID. If the specified
  ID is not registered, an empty string will be returned.
See Also
  RegisterDSACheckMarkText, UnregisterDSACheckMarkText
----------------------------------------------------------------------------------------------------
@@RegisterDSACheckMarkText
<GROUP JVCL.Info.Dialogs.DSA.Chk>
Summary
  Register a check mark text.
Description
  RegisterDSACheckMarkText allows you to register additional check mark texts. When registering a
  DSA dialog you can optionally define the check mark text to use for the dialog.
See Also
  TDSACheckTextKind, UnregisterDSACheckMarkText
----------------------------------------------------------------------------------------------------
@@UnregisterDSACheckMarkText
<GROUP JVCL.Info.Dialogs.DSA.Chk>
Summary
  Unregister a check mark text.
Description
  UnregisterDSACheckMarkText allows you to remove a check mark text. The registered dialogs are not
  checked and if a dialog was assigned to this check mark text, it will default to ctkShow.
See Also
  RegisterDSACheckMarkText, TDSACheckTextKind
----------------------------------------------------------------------------------------------------
@@mbNone
Summary
  Used to identify no button.
Description
  mbNone is used to indentify that no button is to be used as a default, cancel or help button. It's
  primary use is for the DefaultButton, CancelButton and HelpButton parameters for the various
  \MessageDlg routines.
See Also
  mbDefault
----------------------------------------------------------------------------------------------------
@@mbDefault
Summary
  Used to identify default button mapping.
Description
  mbDefault is used to indentify that the default button mapping is to be used to determine the
  default and/or cancel button. It's primary use is for the DefaultButton and CancelButton
  parameters for the various \MessageDlg routines.
See Also
  mbNone
----------------------------------------------------------------------------------------------------

[JVCL-Checkins] CVS: dev/help/info - New directory

[Marcel Bestebroer <jedi_mbe@us...>]

Update of /cvsroot/jvcl/dev/help/info
In directory usw-pr-cvs1:/tmp/cvs-serv30571/info

Log Message:
Directory /cvsroot/jvcl/dev/help/info added to the repository