[JVCL-Checkins] CVS: dev/help JvGif.dtx,1.5,1.6

[Peter T. <pe...@us...>]

Update of /cvsroot/jvcl/dev/help
In directory sc8-pr-cvs1:/tmp/cvs-serv13315/help

Modified Files:
	JvGif.dtx 
Log Message:
- Partially finished

Index: JvGif.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvGif.dtx,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** JvGif.dtx	30 Jul 2003 22:57:34 -0000	1.5
--- JvGif.dtx	20 Sep 2003 10:16:14 -0000	1.6
***************
*** 1,8 ****
  ##Package: MM
! ##Status: Generated
  ----------------------------------------------------------------------------------------------------
  @@JvGIF.pas
  Summary
!   Contains the TJvGIF component.
  <INCLUDE JVCL.UnitText.dtx>
  Author
--- 1,8 ----
  ##Package: MM
! ##Status: Partially finished
  ----------------------------------------------------------------------------------------------------
  @@JvGIF.pas
  Summary
!   Contains the TJvGIFImage graphic class that encapsulates a GIF graphic.
  <INCLUDE JVCL.UnitText.dtx>
  Author
***************
*** 12,129 ****
  <TITLE CF_GIF variable>
  Summary
!   Write here a summary (1 line)
  Description
!   Write here a description
  ----------------------------------------------------------------------------------------------------
  @@GIFLoadCorrupted
  <TITLE GIFLoadCorrupted variable>
  Summary
!   Write here a summary (1 line)
  Description
!   Write here a description
  ----------------------------------------------------------------------------------------------------
  @@GIFVersionName
  <TITLE GIFVersionName function>
  Summary
!   Write here a summary (1 line)
  Description
!   Write here a description
  Parameters
!   Version - Description for this parameter
! See Also
!   List here other properties, methods (comma seperated)
!   Remove the 'See Also' section if there are no references
! ----------------------------------------------------------------------------------------------------
! @@JvGif_Dummy
! <TITLE JvGif_Dummy procedure>
! Summary
!   Write here a summary (1 line)
! Description
!   Write here a description
  See Also
-   List here other properties, methods (comma seperated)
-   Remove the 'See Also' section if there are no references
  ----------------------------------------------------------------------------------------------------
  @@TDisposalMethod
  <TITLE TDisposalMethod type>
  Summary
!   Write here a summary (1 line)
  Description
!   Write here a description
  @@TDisposalMethod.dmUndefined
!   Description for dmUndefined
  @@TDisposalMethod.dmLeave
!   Description for dmLeave
  @@TDisposalMethod.dmRestoreBackground
!   Description for dmRestoreBackground
  @@TDisposalMethod.dmRestorePrevious
!   Description for dmRestorePrevious
  @@TDisposalMethod.dmReserved4
!   Description for dmReserved4
  @@TDisposalMethod.dmReserved5
!   Description for dmReserved5
  @@TDisposalMethod.dmReserved6
!   Description for dmReserved6
  @@TDisposalMethod.dmReserved7
!   Description for dmReserved7
! ----------------------------------------------------------------------------------------------------
! @@TGIFBits
! <TITLE TGIFBits type>
! Summary
!   Write here a summary (1 line)
! Description
!   Write here a description
!   You don't have to document already described items such as sets,
!   pointers to records etc.
! (Value = 1..8 ; - for reference)
! ---------------------------------------------------------------------------------------------------
! @@TGIFColorItem
! <TITLE TGIFColorItem type>
! Summary
!   Write here a summary (1 line)
! Description
!   Write here a description
! @@TGIFColorItem.Red
!   Description for Red
! @@TGIFColorItem.Green
!   Description for Green
! @@TGIFColorItem.Blue
!   Description for Blue
! ---------------------------------------------------------------------------------------------------
! @@TGIFColorTable
! <TITLE TGIFColorTable type>
! Summary
!   Write here a summary (1 line)
! Description
!   Write here a description
! @@TGIFColorTable.Count
!   Description for Count
! @@TGIFColorTable.Colors
!   Description for Colors
  ----------------------------------------------------------------------------------------------------
- @@TGIFData
- Summary
-   Write here a summary (1 line)
- Description
-   Write here a description
- ----------------------------------------------------------------------------------------------------
- @@TGIFItem
- Summary
-   Write here a summary (1 line)
- Description
-   Write here a description
  ----------------------------------------------------------------------------------------------------
  @@TGIFVersion
  <TITLE TGIFVersion type>
  Summary
!   Write here a summary (1 line)
  Description
!   Write here a description
  @@TGIFVersion.gvUnknown
!   Description for gvUnknown
  @@TGIFVersion.gv87a
!   Description for gv87a
  @@TGIFVersion.gv89a
!   Description for gv89a
  ----------------------------------------------------------------------------------------------------
  @@TJvGIFFrame
--- 12,76 ----
  <TITLE CF_GIF variable>
  Summary
!   Clipboard format for GIF images.
  Description
!   The CF_GIF clipboard format is registered by calling the RegisterClipboardFormat procedure
!   passing in 'GIF Image' as the identifier for the format.
  ----------------------------------------------------------------------------------------------------
  @@GIFLoadCorrupted
  <TITLE GIFLoadCorrupted variable>
  Summary
!   Determines if errors are reported when a GIF image is loaded.
  Description
!   GIFLoadCorrupted is a global variable that controls whether errors and exceptions are reported when an
!   invalid image is loaded into a TJvGIFImage graphic. By default, this value is true.
  ----------------------------------------------------------------------------------------------------
  @@GIFVersionName
  <TITLE GIFVersionName function>
  Summary
!   Returns the version string for a specific GIF version.
  Description
!   Call GIFVersionName to retrieve the string name of a specific GIF version. Currently, this function
!   returns either '87a' or '89a'. If the requested version is gvUnknown, the string #0#0#0 is returned instead.
  Parameters
!   Version - The version to get a string for.
  See Also
  ----------------------------------------------------------------------------------------------------
  @@TDisposalMethod
  <TITLE TDisposalMethod type>
  Summary
!   Specifies how the graphic is to be treated after a frame has been been displayed.
  Description
!   TDisposalMethod is the type of the DisposalMethod property of a TJvGIFFrame and defines how the GIF image
!   is to be updated after a frame has been displayed.
  @@TDisposalMethod.dmUndefined
!   The disposal method is not defined. This value indicates a GIF87a image.
  @@TDisposalMethod.dmLeave
!   Leave frame on-screen.
  @@TDisposalMethod.dmRestoreBackground
!   Restore the background.
  @@TDisposalMethod.dmRestorePrevious
!   Restore the previous frame.
  @@TDisposalMethod.dmReserved4
!   Reserved. Do not use.
  @@TDisposalMethod.dmReserved5
!   Reserved. Do not use.
  @@TDisposalMethod.dmReserved6
!   Reserved. Do not use.
  @@TDisposalMethod.dmReserved7
!   Reserved. Do not use.
  ----------------------------------------------------------------------------------------------------
  ----------------------------------------------------------------------------------------------------
  @@TGIFVersion
  <TITLE TGIFVersion type>
  Summary
!   Defines the available GIF versions as an enumeration.
  Description
!   TGIFVersion
  @@TGIFVersion.gvUnknown
!   The version is unknown.
  @@TGIFVersion.gv87a
!   The GIF87a version
  @@TGIFVersion.gv89a
!   The GIF89a version
  ----------------------------------------------------------------------------------------------------
  @@TJvGIFFrame