[JVCL-Checkins] CVS: dev/help JvBmpAnim.dtx,NONE,1.1 JVCL.dox,1.38,1.39

[Marcel B. <jed...@us...>]

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

Modified Files:
	JVCL.dox 
Added Files:
	JvBmpAnim.dtx 
Log Message:
Added JvBMPAnim documentation

--- NEW FILE: JvBmpAnim.dtx ---
@@JvBmpAnim.pas
<GROUP JVCL.FileRef>
Summary
  Contains all code for TJvBmpAnimator.
<INCLUDE JVCL.UnitText.dtx>
Author
  Peter Thörnqvist.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator
<TITLEIMG TJvBmpAnimator>
Summary
  A component for playing a series of bitmaps.
Description
  TJvCustomBmpAnimator is the base component for showing .BMP files in sequence, like the explorer
  logo in Internet Explorer. The animation runs in a loop. To use it you need an imagelist to hold
  the bitmaps, set the speed and the direction, and set the active property to true.
  
  Do not use an instance of TJvCustomBmpAnimator directly but it's descendant TJvBmpAnimator
----------------------------------------------------------------------------------------------------
@@TJvBmpAnimator
##JVCL:Component
<TITLEIMG TJvBmpAnimator>
<GROUP JVCL.Graphics.Animations>
Summary
  A component for playing a series of bitmaps.
Description
  TJvBmpAnimator is a component for showing .BMP files in sequence, like the explorer logo in
  Internet Explorer. The animation runs in a loop. To use it you need an imagelist to hold the
  bitmaps, set the speed and the direction, and set the active property to true.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.AboutJVCL
<INCLUDE JVCL.Main.AboutJVCL.dtx>
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Active
Summary
  Indicates whether the animation is running.
Description
  Set this property to True to start the animation. 
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.AutoSize
Summary
  Indicates whether the width and height of the imagelist should be used.
Description
  Set this proprty to True to use the width and height of the imagelist component which holds the 
  images for the animation. 
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Centered
Summary
  Indicates whether the images should be painted in the center of the area of the component.
Description
  Set this property to true if the images should be painted inside the area indicated by the
  component. Useful if the area is larger than the images are.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Direction
Summary
  Sets the direction of the animation.
Description
  Use this property to specify the direction of the animation.
See Also
  TJvAnimateDirection
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.ImageList
Summary
  Property of type TImagelist, to hold the images.
Description
  Use this property to specify the TImagelist component that holds the images for the animation.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.NumFrames
Summary
  Property to specify the number of frames.
Description
  Use this property to specify the number of frames in the animation. A value of 0 will show all the
  images. 
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Position
Summary
  Property to specify the frame shown when the animation is stopped.
Description
  Set this property to indicate which frame is shown when the animation is stopped.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Speed
Summary
  Property to specify the speed of the animation.
Description
  Use this property to set the speed of the animation. The value indicates the number of frames per
  second.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Min
Summary
  Property to indicate the first frame of the sequence.
Description
  Use this property to set the first frame of the animation.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Max
Summary
  Property to indicate the last frame of the sequence.
Description
  Use this property to set the last frame of the animation.
----------------------------------------------------------------------------------------------------
@@TJvCustomBmpAnimator.Transparent
Summary
  Property for making the background of the component transparent.
Description
  Use this property to make the background of the component transparent.
----------------------------------------------------------------------------------------------------
@@TJvAnimateDirection
Summary
  Type used to determine the animation direction.
Description
  TJvAnimateDirection is the type used to specify the animation direction in the TJvBmpAnimator
  component.
See Also
  TJvCustomBmpAnimator.Direction
@@TJvAnimateDirection.tdBack
  Indicates that the images will be shown from the highest index to the lowest.
@@TJvAnimateDirection.tdForward
  Indicates that the images will be shown from the lowest index to the highest;
@@TJvAnimateDirection.tdBackFwd
  Indicates that the images will be shown from highest index to the lowest and back again.
@@TJvAnimateDirection.tdFwdBack
  Indicates that the images will be shown from lowest index to the highest and back again.
----------------------------------------------------------------------------------------------------

Index: JVCL.dox
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JVCL.dox,v
retrieving revision 1.38
retrieving revision 1.39
diff -C2 -d -r1.38 -r1.39
*** JVCL.dox	8 Sep 2002 13:28:16 -0000	1.38
--- JVCL.dox	9 Sep 2002 17:15:40 -0000	1.39
***************
*** 10,14 ****
  
  [Source Files]
! Count=64
  File0=generic\eventstypes.pas
  File1=..\..\jvcl\source\JvAddPrinter.pas
--- 10,14 ----
  
  [Source Files]
! Count=65
  File0=generic\eventstypes.pas
  File1=..\..\jvcl\source\JvAddPrinter.pas
***************
*** 28,78 ****
  File15=..\..\jvcl\source\JvBitBtn.pas
  File16=..\..\jvcl\source\JvBlinkingLabel.pas
! File17=..\..\jvcl\source\JvBMPListBox.pas
! File18=..\..\jvcl\source\JvCaesarCipher.pas
! File19=..\..\jvcl\source\JvCalendar.pas
! 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]
--- 28,79 ----
  File15=..\..\jvcl\source\JvBitBtn.pas
  File16=..\..\jvcl\source\JvBlinkingLabel.pas
! File17=..\..\jvcl\source\JvBmpAnim.pas
! File18=..\..\jvcl\source\JvBMPListBox.pas
! File19=..\..\jvcl\source\JvCaesarCipher.pas
! File20=..\..\jvcl\source\JvCalendar.pas
! File21=..\..\jvcl\source\JvCaptionButton.pas
! File22=..\..\jvcl\source\JvCaptionPanel.pas
! File23=..\..\jvcl\source\JvCheckBox.pas
! File24=..\..\jvcl\source\JvColorCombo.pas
! File25=..\..\jvcl\source\JvComponent.pas
! File26=..\..\jvcl\source\JvDataEmbedded.pas
! File27=..\..\jvcl\source\JvDateTimePicker.pas
! File28=..\..\jvcl\source\JvDSADialogs.pas
! File29=..\..\jvcl\source\JvEdit.pas
! File30=..\..\jvcl\source\JvFileInfo.pas
! File31=..\..\jvcl\source\JvInspDB.pas
! File32=..\..\jvcl\source\JvInspector.pas
! File33=..\..\jvcl\source\JvListBox.pas
! File34=..\..\jvcl\source\JvScreenCanvas.pas
! File35=..\..\jvcl\source\JvScreenResolution.pas
! File36=..\..\jvcl\source\JvScrollBar.pas
! File37=..\..\jvcl\source\JvScrollBox.pas
! File38=..\..\jvcl\source\JvScrollingLabel.pas
! File39=..\..\jvcl\source\JvScrollText.pas
! File40=..\..\jvcl\source\JvSearchFiles.pas
! File41=..\..\jvcl\source\JvSerialDlg.pas
! File42=..\..\jvcl\source\JvShape.pas
! File43=..\..\jvcl\source\JvSHFileOp.pas
! File44=..\..\jvcl\source\JvSizeablePanel.pas
! File45=..\..\jvcl\source\JvSlider.pas
! File46=..\..\jvcl\source\JvSoundControl.pas
! File47=..\..\jvcl\source\JvSpacer.pas
! File48=..\..\jvcl\source\JvSpecialImage.pas
! File49=..\..\jvcl\source\JvSpecialLabel.pas
! File50=..\..\jvcl\source\JvSpecialProgress.pas
! File51=..\..\jvcl\source\JvSpeedButton.pas
! File52=..\..\jvcl\source\JvSplitter.pas
! File53=..\..\jvcl\source\JvStarfield.pas
! File54=..\..\jvcl\source\JvStaticText.pas
! File55=..\..\jvcl\source\JvStatusBar.pas
! File56=..\..\jvcl\source\JvStringGrid.pas
! File57=..\..\jvcl\source\JvSyncSplitter.pas
! File58=..\..\jvcl\source\JvSysComp.pas
! File59=..\..\jvcl\source\JvSystemPopup.pas
! File60=..\..\jvcl\source\JvTextcontainer.pas
! File61=..\..\jvcl\source\JvThreadTimer.pas
! File62=..\..\jvcl\source\JvTimeLimit.pas
! File63=..\..\jvcl\source\JvToolBar.pas
! File64=..\..\jvcl\source\JvTrayIcon.pas
  
  [Source Include Directories]
***************
*** 80,84 ****
  
  [Description Files]
! Count=76
  File0=generated includes\JVCL.FuncRef.dtx
  File1=generic\JVCL.Acknowledge.dtx
--- 81,85 ----
  
  [Description Files]
! Count=77
  File0=generated includes\JVCL.FuncRef.dtx
  File1=generic\JVCL.Acknowledge.dtx
***************
*** 109,160 ****
  File26=JvBitBtn.dtx
  File27=JvBlinkingLabel.dtx
! File28=JvBMPListBox.dtx
! File29=JvCaesarCipher.dtx
! File30=JvCalendar.dtx
! File31=JvCaptionButton.dtx
! File32=JvCaptionPanel.dtx
! File33=JvCheckBox.dtx
! File34=JvColorCombo.dtx
! File35=JvComponent.dtx
! File36=JvDataEmbedded.dtx
! File37=JvDateTimePicker.dtx
! File38=JvDSADialogs.dtx
! File39=JvEdit.dtx
! File40=JvFileInfo.dtx
! File41=JvInspData.dtx
! File42=JvInspector.dtx
! File43=JvInspItem.dtx
! File44=JvListBox.dtx
! File45=JvScreenCanvas.dtx
! File46=JvScreenResolution.dtx
! File47=JvScrollBar.dtx
! File48=JvScrollBox.dtx
! File49=JvScrollingLabel.dtx
! File50=JvScrollText.dtx
! File51=JvSearchFiles.dtx
! File52=JvSerialDlg.dtx
! File53=JvShape.dtx
! File54=JvSHFileOp.dtx
! File55=JvSizeablePanel.dtx
! File56=JvSlider.dtx
! File57=JvSoundControl.dtx
! File58=JvSpacer.dtx
! File59=JvSpecialImage.dtx
! File60=JvSpecialLabel.dtx
! File61=JvSpecialProgress.dtx
! File62=JvSpeedButton.dtx
! File63=JvSplitter.dtx
! File64=JvStarfield.dtx
! File65=JvStaticText.dtx
! File66=JvStatusBar.dtx
! File67=JvStringGrid.dtx
! File68=JvSyncSplitter.dtx
! File69=JvSysComp.dtx
! File70=JvSystemPopup.dtx
! File71=JvTextcontainer.dtx
! File72=JvThreadTimer.dtx
! File73=JvTimeLimit.dtx
! File74=JvToolBar.dtx
! File75=JvTrayIcon.dtx
  
  [Description Include Directories]
--- 110,162 ----
  File26=JvBitBtn.dtx
  File27=JvBlinkingLabel.dtx
! File28=JvBmpAnim.dtx
! File29=JvBMPListBox.dtx
! File30=JvCaesarCipher.dtx
! File31=JvCalendar.dtx
! File32=JvCaptionButton.dtx
! File33=JvCaptionPanel.dtx
! File34=JvCheckBox.dtx
! File35=JvColorCombo.dtx
! File36=JvComponent.dtx
! File37=JvDataEmbedded.dtx
! File38=JvDateTimePicker.dtx
! File39=JvDSADialogs.dtx
! File40=JvEdit.dtx
! File41=JvFileInfo.dtx
! File42=JvInspData.dtx
! File43=JvInspector.dtx
! File44=JvInspItem.dtx
! File45=JvListBox.dtx
! File46=JvScreenCanvas.dtx
! File47=JvScreenResolution.dtx
! File48=JvScrollBar.dtx
! File49=JvScrollBox.dtx
! File50=JvScrollingLabel.dtx
! File51=JvScrollText.dtx
! File52=JvSearchFiles.dtx
! File53=JvSerialDlg.dtx
! File54=JvShape.dtx
! File55=JvSHFileOp.dtx
! File56=JvSizeablePanel.dtx
! File57=JvSlider.dtx
! File58=JvSoundControl.dtx
! File59=JvSpacer.dtx
! File60=JvSpecialImage.dtx
! File61=JvSpecialLabel.dtx
! File62=JvSpecialProgress.dtx
! File63=JvSpeedButton.dtx
! File64=JvSplitter.dtx
! File65=JvStarfield.dtx
! File66=JvStaticText.dtx
! File67=JvStatusBar.dtx
! File68=JvStringGrid.dtx
! File69=JvSyncSplitter.dtx
! File70=JvSysComp.dtx
! File71=JvSystemPopup.dtx
! File72=JvTextcontainer.dtx
! File73=JvThreadTimer.dtx
! File74=JvTimeLimit.dtx
! File75=JvToolBar.dtx
! File76=JvTrayIcon.dtx
  
  [Description Include Directories]