Menu
▾
▴
[JVCL-Checkins] CVS: dev/help JvID3v2Base.dtx,1.2,1.3 JvId3v2Types.dtx,1.4,1.5 JvSpacer.dtx,1.12,1.13 JvStringGrid.dtx,1.18,1.19 JvToolBar.dtx,1.13,1.14 JvTrayIcon.dtx,1.17,1.18 JvTypes.dtx,1.9,1.10
|
From: Remko B. <rem...@us...> - 2003-08-31 22:23:19
|
Update of /cvsroot/jvcl/dev/help
In directory sc8-pr-cvs1:/tmp/cvs-serv7144
Modified Files:
JvID3v2Base.dtx JvId3v2Types.dtx JvSpacer.dtx JvStringGrid.dtx
JvToolBar.dtx JvTrayIcon.dtx JvTypes.dtx
Log Message:
Updated
Index: JvID3v2Base.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvID3v2Base.dtx,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** JvID3v2Base.dtx 31 Jul 2003 22:50:14 -0000 1.2
--- JvID3v2Base.dtx 31 Aug 2003 22:23:12 -0000 1.3
***************
*** 1,4 ****
--- 1,8 ----
##Package: MM
##Status: Locked (Remko Bonte)
+ ## Length -> \Length
+ ## Check -> \Check
+ ## Version 2.x -> 2.x.0
+ ## Check Version 2.2.??
----------------------------------------------------------------------------------------------------
@@JvID3v2Base.pas
***************
[...3224 lines suppressed...]
+ Description for meModeExt1
+ @@TJvMPEGModeExtension.meModeExt2
+ Description for meModeExt2
+ @@TJvMPEGModeExtension.meModeExt3
+ Description for meModeExt3
+ ----------------------------------------------------------------------------------------------------
+ @@TJvMPEGVersion
+ <TITLE TJvMPEGVersion type>
+ Summary
+ Enumerates MPEG versions.
+ Description
+ The TJvMPEGVersion type is used to specify a specific MPEG version.
+ @@TJvMPEGVersion.mvVersion25
+ MPEG version 2.5
+ @@TJvMPEGVersion.mvReserved
+ An undefined MPEG version
+ @@TJvMPEGVersion.mvVersion2
+ MPEG version 2
+ @@TJvMPEGVersion.mvVersion1
+ MPEG version 1
Index: JvId3v2Types.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvId3v2Types.dtx,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** JvId3v2Types.dtx 31 Jul 2003 22:50:14 -0000 1.4
--- JvId3v2Types.dtx 31 Aug 2003 22:23:13 -0000 1.5
***************
*** 12,16 ****
<TITLE ID3_FrameIDToString function>
Summary
! Converts a frame identifier to a string.
Description
ID3_FrameIDToString converts a frame identifier to a string containing the alphanumerical
--- 12,16 ----
<TITLE ID3_FrameIDToString function>
Summary
! Converts a frame identifier to a frame name.
Description
ID3_FrameIDToString converts a frame identifier to a string containing the alphanumerical
***************
*** 18,25 ****
For example: ID3_FrameIDToString(fiComment, 4) returns 'COMM'.
-
- \Returns the alphanumerical representation of that frame identifier.
Parameters
! ID - \Description for this parameter
See Also
<LINK ID3_StringToFrameID>
--- 18,25 ----
For example: ID3_FrameIDToString(fiComment, 4) returns 'COMM'.
Parameters
! ID - The frame identifier to convert.
! Size - Specifies the size of the resulting string. Use 3 for version 2.2.0 frame names and
! 4 for version 2.3.0 and version 2.4.0 frame names.
See Also
<LINK ID3_StringToFrameID>
***************
*** 46,52 ****
Converts a string to a genre identifier.
Description
! Write here a description
Parameters
! AGenre - \Description for this parameter
InclWinampGenres - Specifies whether to include the genres introduced by Winamp.
See Also
--- 46,53 ----
Converts a string to a genre identifier.
Description
! Use the ID3_GenreToID function to convert a string to a genre identifier (offset of a genre in
! a <LINK TJvID3Genre_Table,predefined list>).
Parameters
! AGenre - The genre string to convert.
InclWinampGenres - Specifies whether to include the genres introduced by Winamp.
See Also
***************
*** 58,64 ****
Converts a genre identifier to a string.
Description
! Write here a description
Parameters
! ID - \Description for this parameter
InclWinampGenres - Specifies whether to include the genres introduced by Winamp.
See Also
--- 59,66 ----
Converts a genre identifier to a string.
Description
! Use the ID3_IDToGenre function to convert a genre identifier (offset of a genre in
! a <LINK TJvID3Genre_Table,predefined list>) to a string.
Parameters
! ID - The genre identifier to convert.
InclWinampGenres - Specifies whether to include the genres introduced by Winamp.
See Also
***************
*** 68,76 ****
<TITLE ID3_LongGenreToID function>
Summary
! Converts a string to a genre identifier.
Description
! Write here a description
Parameters
! ALongGenre - \Description for this parameter
InclWinampGenres - Specifies whether to include the genres introduced by Winamp.
See Also
--- 70,91 ----
<TITLE ID3_LongGenreToID function>
Summary
! Converts a prefix of a string to a genre identifier.
Description
! Use the ID3_LongGenreToID function to convert a prefix of a string to a genre identifier
! (offset of a genre in a <LINK TJvID3Genre_Table,predefined list>).
!
! For example:
! <TABLE>
! Calling Returns Meaning
! ------------------------------------- ------- -------
! ID3_LongGenreToID('Pop or something') 13 Pop
! ID3_LongGenreToID('Pop/Funk ??') 62 Pop/Funk
! ID3_LongGenreToID('Pop-Folk alike') 53 Pop-Folk
! ID3_LongGenreToID('Rock') 17 Rock
! ID3_LongGenreToID('Rocks') 255 ??
! ID3_LongGenreToID('Rock & Roll') 78 Rock & Roll
! </TABLE>
Parameters
! ALongGenre - The genre string to convert.
InclWinampGenres - Specifies whether to include the genres introduced by Winamp.
See Also
***************
*** 80,88 ****
<TITLE ID3_StringToFrameID function>
Summary
! Converts a string to a frame identifier.
Description
! Write here a description
Parameters
! S - \Description for this parameter
See Also
<LINK ID3_FrameIDToString>
--- 95,106 ----
<TITLE ID3_StringToFrameID function>
Summary
! Converts a frame name to a frame identifier.
Description
! ID3_FrameIDToString converts a frame identifier to a string containing the alphanumerical
! representation of that frame identifier.
!
! For example: ID3_StringToFrameID('COMM') returns fiComment.
Parameters
! S - Specifies the frame name.
See Also
<LINK ID3_FrameIDToString>
***************
*** 218,238 ****
TJvID3FrameHeaderFlags is a set of TJvID3FrameHeaderFlag values.
@@TJvID3FrameHeaderFlag.fhfOnTagAlterDiscardFrame
! Description for fhfOnTagAlterDiscardFrame
@@TJvID3FrameHeaderFlag.fhfOnFileAlterDiscardFrame
! Description for fhfOnFileAlterDiscardFrame
@@TJvID3FrameHeaderFlag.fhfReadOnly
! Description for fhfReadOnly
@@TJvID3FrameHeaderFlag.fhfIsCompressed
! Description for fhfIsCompressed
! Not implemented by TJvID3Controller.
@@TJvID3FrameHeaderFlag.fhfIsEncrypted
! Description for fhfIsEncrypted
! Not implemented by TJvID3Controller.
@@TJvID3FrameHeaderFlag.fhfContainsGroupInformation
! Description for fhfContainsGroupInformation
@@TJvID3FrameHeaderFlag.fhfUnsynchronisationApplied
! Description for fhfUnsynchronisationApplied
@@TJvID3FrameHeaderFlag.fhfDataLengthIndicator
! Description for fhfDataLengthIndicator
----------------------------------------------------------------------------------------------------
@@TJvID3FrameHeaderFlags
--- 236,268 ----
TJvID3FrameHeaderFlags is a set of TJvID3FrameHeaderFlag values.
@@TJvID3FrameHeaderFlag.fhfOnTagAlterDiscardFrame
! Tells the tag parser to discard the frame if it is unknown and the tag is altered in any way.
! This applies to all kinds of alterations, including adding more padding and reordering
! the frames. If this flag is not included, the frame should be preserved.
@@TJvID3FrameHeaderFlag.fhfOnFileAlterDiscardFrame
! Tells the tag parser to discard the frame if it is unknown and the file, excluding the tag,
! is altered. This does not apply when the audio is completely replaced with other audio data.
! If this flag is not included, the frame should be preserved.
@@TJvID3FrameHeaderFlag.fhfReadOnly
! Tells the software that the contents of this frame are intended to be read only. Changing
! the contents might break something, e.g. a signature. If the contents are changed, without
! knowledge of why the frame was flagged read only and without taking the proper means to
! compensate, e.g. recalculating the signature, the flag must be removed.
@@TJvID3FrameHeaderFlag.fhfIsCompressed
! Indicates that the frame is compressed. fhfDataLengthIndicator must also be included.
! <b>Compression is not implemented by TJvID3Controller.</b>
@@TJvID3FrameHeaderFlag.fhfIsEncrypted
! Indicates that the frame is encrypted. If set, the <LINK TJvID3Frame.EncryptionID,EncryptionID> property
! of the frame is valid and indicates with which method it was encrypted. See description of
! the ENCR frame for more information about encryption method registration.
! fhfDataLengthIndicator must also be included.
! <b>Encryption is not implemented by TJvID3Controller.</b>
@@TJvID3FrameHeaderFlag.fhfContainsGroupInformation
! Indicates that this frame belongs in a group with other frames. If set, the <LINK TJvID3Frame.GroupID,
! GroupID> property of the frame is valid; every frame with the same group identifier belongs to the
! same group.
@@TJvID3FrameHeaderFlag.fhfUnsynchronisationApplied
! Indicates that unsynchronisation was applied to this frame.
@@TJvID3FrameHeaderFlag.fhfDataLengthIndicator
! Indicates that a data length indicator has been added to the frame.
----------------------------------------------------------------------------------------------------
@@TJvID3FrameHeaderFlags
***************
*** 608,614 ****
<TITLE TJvID3ImageEncodingRestriction type>
Summary
! Write here a summary (1 line)
Description
! Image encoding restrictions
@@TJvID3ImageEncodingRestriction.ierNoRestrictions
No restrictions
--- 638,644 ----
<TITLE TJvID3ImageEncodingRestriction type>
Summary
! Enumerates image encoding restrictions.
Description
! The TJvID3ImageEncodingRestriction type is used to specify a specific image encoding restriction.
@@TJvID3ImageEncodingRestriction.ierNoRestrictions
No restrictions
***************
*** 619,625 ****
<TITLE TJvID3ImageSizeRestriction type>
Summary
! Write here a summary (1 line)
Description
! Image size restrictions
@@TJvID3ImageSizeRestriction.isrNoRestrictions
No restrictions.
--- 649,655 ----
<TITLE TJvID3ImageSizeRestriction type>
Summary
! Enumerates image size restrictions.
Description
! The TJvID3ImageSizeRestriction type is used to specify a specific image size restriction.
@@TJvID3ImageSizeRestriction.isrNoRestrictions
No restrictions.
***************
*** 634,640 ****
<TITLE TJvID3PictureType type>
Summary
! Write here a summary (1 line)
Description
! Use the TJvID3PictureType type to
@@TJvID3PictureType.ptOther
Other
--- 664,670 ----
<TITLE TJvID3PictureType type>
Summary
! Enumerates picture types.
Description
! Use the TJvID3PictureType type to specify a specific picture type.
@@TJvID3PictureType.ptOther
Other
***************
*** 682,692 ****
@@TJvID3Restrictions
Summary
! Write here a summary (1 line)
Description
For some applications it might be desired to restrict a tag in more
! ways than imposed by the ID3v2 specification. Note that the
presence of these restrictions does not affect how the tag is
! decoded, merely how it was restricted before encoding. If this flag
! is set the tag is restricted as follows:
@@TJvID3Restrictions.RTagSize
Tag size restrictions
--- 712,721 ----
@@TJvID3Restrictions
Summary
! Contains tag restrictions.
Description
For some applications it might be desired to restrict a tag in more
! ways than imposed by the ID3 v2 specification. Note that the
presence of these restrictions does not affect how the tag is
! decoded, merely how it was restricted before encoding.
@@TJvID3Restrictions.RTagSize
Tag size restrictions
***************
*** 702,719 ****
@@TJvID3StringPair
Summary
! Write here a summary (1 line)
Description
! Use the TJvID3StringPair type to
@@TJvID3StringPair.SA
! Description for SA
@@TJvID3StringPair.SW
! Description for SW
----------------------------------------------------------------------------------------------------
@@TJvID3TagSizeRestriction
<TITLE TJvID3TagSizeRestriction type>
Summary
! Write here a summary (1 line)
Description
! Tag size restrictions
@@TJvID3TagSizeRestriction.tsrMax128Frames_1MB
No more than 128 frames and 1 MB total tag size.
--- 731,748 ----
@@TJvID3StringPair
Summary
! Contains an ANSI and an unicode string.
Description
! The TJvID3StringPair type is used to store an ANSI and an unicode string together.
@@TJvID3StringPair.SA
! The ANSI string.
@@TJvID3StringPair.SW
! The unicode string.
----------------------------------------------------------------------------------------------------
@@TJvID3TagSizeRestriction
<TITLE TJvID3TagSizeRestriction type>
Summary
! Enumerates tag size restrictions.
Description
! The TJvID3TagSizeRestriction type is used to specify a specific tag size restriction.
@@TJvID3TagSizeRestriction.tsrMax128Frames_1MB
No more than 128 frames and 1 MB total tag size.
***************
*** 728,734 ****
<TITLE TJvID3TextEncodingRestriction type>
Summary
! Write here a summary (1 line)
Description
! Text encoding restrictions
@@TJvID3TextEncodingRestriction.terNoRestrictions
No restrictions
--- 757,763 ----
<TITLE TJvID3TextEncodingRestriction type>
Summary
! Enumerates text encoding restrictions.
Description
! The TJvID3TextEncodingRestriction type is used to specify a specific text encoding restriction.
@@TJvID3TextEncodingRestriction.terNoRestrictions
No restrictions
***************
*** 739,745 ****
<TITLE TJvID3TextFieldsSizeRestriction type>
Summary
! Write here a summary (1 line)
Description
! Text fields size restrictions
@@TJvID3TextFieldsSizeRestriction.tfszNoRestrictions
No restrictions
--- 768,774 ----
<TITLE TJvID3TextFieldsSizeRestriction type>
Summary
! Enumerates Text fields size restrictions.
Description
! The TJvID3TextFieldsSizeRestriction type is used to specify a specific text fields size restriction.
@@TJvID3TextFieldsSizeRestriction.tfszNoRestrictions
No restrictions
Index: JvSpacer.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvSpacer.dtx,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** JvSpacer.dtx 17 Aug 2003 11:45:54 -0000 1.12
--- JvSpacer.dtx 31 Aug 2003 22:23:13 -0000 1.13
***************
*** 38,42 ****
* csAcceptsControls and csSetCaption are removed from ControlStyle.
Parameters
! aOwner - The owner for the instance of TJvSpacer.
----------------------------------------------------------------------------------------------------
@@TJvSpacer.SetBounds
--- 38,42 ----
* csAcceptsControls and csSetCaption are removed from ControlStyle.
Parameters
! AOwner - The owner for the instance of TJvSpacer.
----------------------------------------------------------------------------------------------------
@@TJvSpacer.SetBounds
Index: JvStringGrid.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvStringGrid.dtx,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** JvStringGrid.dtx 17 Aug 2003 22:31:29 -0000 1.18
--- JvStringGrid.dtx 31 Aug 2003 22:23:13 -0000 1.19
***************
*** 113,118 ****
OnCaptionClick event.
Parameters
! aCol - Indicates the column index of the cell that is clicked.
! aRow - Indicates the row index of the cell that is clicked.
See Also
OnCaptionClick
--- 113,118 ----
OnCaptionClick event.
Parameters
! AColumn - Indicates the column index of the cell that is clicked.
! ARow - Indicates the row index of the cell that is clicked.
See Also
OnCaptionClick
***************
*** 201,205 ****
event and finally calls DefaultDrawCell.
Parameters
! ACol - Indicate the column index of the cell that should be drawn.
ARow - Indicate the row index of the cell that should be drawn.
Rect - Indicates the location of the cell on the canvas.
--- 201,205 ----
event and finally calls DefaultDrawCell.
Parameters
! AColumn - Indicate the column index of the cell that should be drawn.
ARow - Indicate the row index of the cell that should be drawn.
Rect - Indicates the location of the cell on the canvas.
***************
*** 216,222 ****
OnExitCell event.
Parameters
! edittext - The text of the cell that loses the input focus.
! aCol - Indicate the column index of the cell that loses the input focus.
! aRow - Indicate the row index of the cell that loses the input focus.
See Also
OnExitCell
--- 216,222 ----
OnExitCell event.
Parameters
! EditText - The text of the cell that loses the input focus.
! AColumn - Indicate the column index of the cell that loses the input focus.
! ARow - Indicate the row index of the cell that loses the input focus.
See Also
OnExitCell
***************
*** 528,536 ****
DefaultDrawCell. SetCanvasProperties fires the OnSetCanvasProperties event.
Parameters
! ACol - Indicate the column index of the cell that is about to be drawn.
! ARow - Indicate the row index of the cell that is about to be drawn.
! Rect - Indicates the location of the cell on the canvas.
! State - Indicates whether the cell has input focus, whether the cell is selected, and whether the cell
! is a fixed (nonscrolling) cell.
See Also
DefaultDrawCell, OnSetCanvasProperties
--- 528,536 ----
DefaultDrawCell. SetCanvasProperties fires the OnSetCanvasProperties event.
Parameters
! AColumn - Indicate the column index of the cell that is about to be drawn.
! ARow - Indicate the row index of the cell that is about to be drawn.
! Rect - Indicates the location of the cell on the canvas.
! State - Indicates whether the cell has input focus, whether the cell is selected, and whether the cell
! is a fixed (nonscrolling) cell.
See Also
DefaultDrawCell, OnSetCanvasProperties
Index: JvToolBar.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvToolBar.dtx,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** JvToolBar.dtx 29 Aug 2003 11:19:06 -0000 1.13
--- JvToolBar.dtx 31 Aug 2003 22:23:13 -0000 1.14
***************
*** 36,40 ****
Parameters
AOwner - A component, typically the form, that is responsible for freeing the toolbar.
- See Also
----------------------------------------------------------------------------------------------------
@@TJvToolBar.AboutJVCL
--- 36,39 ----
***************
*** 51,55 ****
@@TJvToolBar.Menu
Summary
! Indicates the menu that the toolbar must reproduce
Description
This property is an overlaod of the inherited property from TToolBar. However, it accepts
--- 50,54 ----
@@TJvToolBar.Menu
Summary
! Indicates the menu that the toolbar must reproduce.
Description
This property is an overlaod of the inherited property from TToolBar. However, it accepts
Index: JvTrayIcon.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvTrayIcon.dtx,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** JvTrayIcon.dtx 31 Jul 2003 22:50:15 -0000 1.17
--- JvTrayIcon.dtx 31 Aug 2003 22:23:13 -0000 1.18
***************
*** 1,4 ****
##Package: Custom
! ##Status: Needs review
----------------------------------------------------------------------------------------------------
@@JvTrayIcon.pas
--- 1,4 ----
##Package: Custom
! ##Status: Completed
----------------------------------------------------------------------------------------------------
@@JvTrayIcon.pas
***************
*** 56,61 ****
Use the Animated, Delay and Icons properties to set up an animation in the tray. When Animated is
! set to True, TJvTrayIcon will start iterating through the image list specified by Icons and display
! each icon for Delay milliseconds in the notification area. Set Animated to False to stop the animation.
Call BalloonHint to display a cartoon-style "balloon" with a stem pointing to the icon in the
--- 56,61 ----
Use the Animated, Delay and Icons properties to set up an animation in the tray. When Animated is
! set to true, TJvTrayIcon will start iterating through the image list specified by Icons and display
! each icon for Delay milliseconds in the notification area. Set Animated to false to stop the animation.
Call BalloonHint to display a cartoon-style "balloon" with a stem pointing to the icon in the
***************
*** 71,75 ****
determine whether this system supports balloon ToolTips.
Returns
! Returns True if the Shell32.dll on this system is version 5.0 or later. Returns False if the
Shell32.dll is a pre-5.0 version.
See Also
--- 71,75 ----
determine whether this system supports balloon ToolTips.
Returns
! Returns true if the Shell32.dll on this system is version 5.0 or later. Returns false if the
Shell32.dll is a pre-5.0 version.
See Also
***************
*** 81,92 ****
Description
Examine Active at runtime to determine if it an icon is shown in the taskbar notification area or
! not. Active is False by default, meaning there is no notification icon shown in the taskbar
notification area.
! Setting Active to True adds the icon specified by Icon to the tray at runtime. If Animated is also
! set to True, TJvTrayIcon uses the images in the image list specified by Icons to periodically change
the notification icon. Property Delay specifies the amount of time between icon changes.
! Setting Active to False (the default), removes the notification icon from the taskbar notification
area.
See Also
--- 81,92 ----
Description
Examine Active at runtime to determine if it an icon is shown in the taskbar notification area or
! not. Active is false by default, meaning there is no notification icon shown in the taskbar
notification area.
! Setting Active to true adds the icon specified by Icon to the tray at runtime. If Animated is also
! set to true, TJvTrayIcon uses the images in the image list specified by Icons to periodically change
the notification icon. Property Delay specifies the amount of time between icon changes.
! Setting Active to false (the default), removes the notification icon from the taskbar notification
area.
See Also
***************
*** 97,106 ****
Indicates whether the icon is animated.
Description
! Set Animated to True to let TJvTrayIcon iterate through the icons in the image list specified by
Icons and display each icon in that list - one at a time - in the notification area. Property
Delay specifies the amount of time each icon is shown in the tray.
! Set Animated to False to stop the animation.
! You must also set Active to True to activate the animation.
See Also
Active, Delay, Icons, OnAnimate
--- 97,106 ----
Indicates whether the icon is animated.
Description
! Set Animated to true to let TJvTrayIcon iterate through the icons in the image list specified by
Icons and display each icon in that list - one at a time - in the notification area. Property
Delay specifies the amount of time each icon is shown in the tray.
! Set Animated to false to stop the animation.
! You must also set Active to true to activate the animation.
See Also
Active, Delay, Icons, OnAnimate
***************
*** 114,120 ****
calling the HideApplication method.
Parameters
! Message - Represents the Windows message.
Returns
! Returns True if it processes the message, and False if it does not.
See Also
HideApplication, Visibility
--- 114,120 ----
calling the HideApplication method.
Parameters
! Msg - Represents the Windows message.
Returns
! Returns true if it processes the message, and false if it does not.
See Also
HideApplication, Visibility
***************
*** 125,135 ****
Description
Use the ApplicationVisible property to control the visibility of the application and the
! application's taskbar button. If ApplicationVisible is set to True, TJvTrayIcon restores the
application to it's normal size, if it was minimized, and shows the application's button on the taskbar.
! If ApplicationVisible is set to False, TJvTrayIcon minimizes the application and removes the application's
button on the taskbar.
! Calling the ShowApplication method sets the ApplicationVisible property to True. Calling the
! HideApplication method sets it to False.
Note
This is a protected property.
--- 125,135 ----
Description
Use the ApplicationVisible property to control the visibility of the application and the
! application's taskbar button. If ApplicationVisible is set to true, TJvTrayIcon restores the
application to it's normal size, if it was minimized, and shows the application's button on the taskbar.
! If ApplicationVisible is set to false, TJvTrayIcon minimizes the application and removes the application's
button on the taskbar.
! Calling the ShowApplication method sets the ApplicationVisible property to true. Calling the
! HideApplication method sets it to false.
Note
This is a protected property.
***************
*** 150,153 ****
--- 150,155 ----
application attempts to display a balloon ToolTip. If the system minimum timeout is ten seconds,
the first ToolTip displays for an additional three seconds before being replaced by the second ToolTip.
+ You can override this behaviour by setting parameter CancelPrevious to true, which will cancel the
+ currently visible - if any - balloon.
The ToolTip will disappear when clicked, but you can also specify a time-out value. Use the
***************
*** 165,169 ****
value and values that are too small default to the minimum value. The system minimum
and maximum timeout values are currently set at 10 seconds and 30 seconds, respectively.
! CancelPrevious - Description for this parameter
See Also
AcceptBalloons, OnBalloonClick, OnBalloonHide, OnBalloonShow
--- 167,171 ----
value and values that are too small default to the minimum value. The system minimum
and maximum timeout values are currently set at 10 seconds and 30 seconds, respectively.
! CancelPrevious - Specifies whether to cancel the previous balloon.
See Also
AcceptBalloons, OnBalloonClick, OnBalloonHide, OnBalloonShow
***************
*** 174,178 ****
Description
Delay determines how frequently a refresh of the tray icon occurs. If Active and Animated are set
! to True, TJvTrayIcon will iterate through the icons in the image list specified by property Icons.
Each time the specified time passes, TJvTrayIcon changes the tray icon to the next icon in the image
list.
--- 176,180 ----
Description
Delay determines how frequently a refresh of the tray icon occurs. If Active and Animated are set
! to true, TJvTrayIcon will iterate through the icons in the image list specified by property Icons.
Each time the specified time passes, TJvTrayIcon changes the tray icon to the next icon in the image
list.
***************
*** 188,192 ****
Description
Call DoCheckCrash to check whether the taskbar notification area has been recreated. If so, and Active
! is set to True, DoCheckCrash re-adds the icon to the tray.
See Also
Active
--- 190,194 ----
Description
Call DoCheckCrash to check whether the taskbar notification area has been recreated. If so, and Active
! is set to true, DoCheckCrash re-adds the icon to the tray.
See Also
Active
***************
*** 303,307 ****
Description
Use Icon to assign a specific icon to represent the application. TJvTrayIcon displays Icon on
! the Windows task bar notification area, when Active is set to True.
To avoid icon distortion, be aware that notification area icons have different levels of support
--- 305,309 ----
Description
Use Icon to assign a specific icon to represent the application. TJvTrayIcon displays Icon on
! the Windows task bar notification area, when Active is set to true.
To avoid icon distortion, be aware that notification area icons have different levels of support
***************
*** 329,333 ****
Description
Use Icons to supply a list of icons that are used for the animation in the task bar notification
! area. When Active and Animated are set to True, TJvTrayIcon will iterate through the icons in the
image list specified by Icons and display each icon in that list for Delay milliseconds in the
notification area.
--- 331,335 ----
Description
Use Icons to supply a list of icons that are used for the animation in the task bar notification
! area. When Active and Animated are set to true, TJvTrayIcon will iterate through the icons in the
image list specified by Icons and display each icon in that list for Delay milliseconds in the
notification area.
***************
*** 340,344 ****
Description
\Write an OnAnimate event handler to take specific action whenever TJvTrayIcon changes the tray icon
! in response to animate events. When Animated is set to True, TJvTrayIcon iterates through the icons
in the image list specified by Icons and displays each icon in that list - one at a time - in the
notification area. Property Delay specifies the amount of time each icon is shown in the tray.
--- 342,346 ----
Description
\Write an OnAnimate event handler to take specific action whenever TJvTrayIcon changes the tray icon
! in response to animate events. When Animated is set to true, TJvTrayIcon iterates through the icons
in the image list specified by Icons and displays each icon in that list - one at a time - in the
notification area. Property Delay specifies the amount of time each icon is shown in the tray.
***************
*** 487,492 ****
Specifies whether the hiding and restoring of the application should be animated.
Description
! Set Snap to True to make the hiding and restoring of the application appear suddenly. Set Snap to
! False to make it appear animated.
Use Visibility to automate the hiding and restoring of the application.
--- 489,494 ----
Specifies whether the hiding and restoring of the application should be animated.
Description
! Set Snap to true to make the hiding and restoring of the application appear suddenly. Set Snap to
! false to make it appear animated.
Use Visibility to automate the hiding and restoring of the application.
***************
*** 511,516 ****
Determines if the application is shown in the task manager.
Description
! Set VisibleInTaskList to True to show the application in the windows task manager application. Set
! VisibleInTaskList to False to remove the application from the task manager; the application prevent
itself from being closed when the user logs off. The application close only when the system is shut
down.
--- 513,518 ----
Determines if the application is shown in the task manager.
Description
! Set VisibleInTaskList to true to show the application in the windows task manager application. Set
! VisibleInTaskList to false to remove the application from the task manager; the application prevent
itself from being closed when the user logs off. The application close only when the system is shut
down.
***************
*** 597,611 ****
Use this flag at run-time to show or hide the application. For example removing
! this flag from Visibility will hide the application. Use this
flag at design-time to indicate whether the application and the application button
must be visible when the application starts up.
@@TTrayVisibility.tvVisibleTaskList
(Windows 95, 98 and me.) Shows the application in the windows task manager
! application. This is default behaviour. If this flag is not set, <LINK TJvTrayIcon,TJvTrayIcon>
removes the application from the task manager; the application prevent itself
from being closed when the user logs off. The application close only when the
system is shut down.
@@TTrayVisibility.tvAutoHide
! Automatically removes the application button on the taskbar if the user minimizes the application.
@@TTrayVisibility.tvVisibleDesign
Shows the tray icon in the traybar notification area at design-time.
--- 599,613 ----
Use this flag at run-time to show or hide the application. For example removing
! this flag from <LINK TJvTrayIcon.Visibility,Visibility> will hide the application. Use this
flag at design-time to indicate whether the application and the application button
must be visible when the application starts up.
@@TTrayVisibility.tvVisibleTaskList
(Windows 95, 98 and me.) Shows the application in the windows task manager
! application. This is default behaviour. If this flag is not set, <LINK TJvTrayIcon>
removes the application from the task manager; the application prevent itself
from being closed when the user logs off. The application close only when the
system is shut down.
@@TTrayVisibility.tvAutoHide
! Automatically removes the application button from the taskbar when the user minimizes the application.
@@TTrayVisibility.tvVisibleDesign
Shows the tray icon in the traybar notification area at design-time.
Index: JvTypes.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvTypes.dtx,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** JvTypes.dtx 30 Jul 2003 23:03:51 -0000 1.9
--- JvTypes.dtx 31 Aug 2003 22:23:13 -0000 1.10
***************
*** 1,4 ****
##Package: Core
! ##Status: Generated
----------------------------------------------------------------------------------------------------
@@JvTypes.pas
--- 1,4 ----
##Package: Core
! ##Status: Partially documented
----------------------------------------------------------------------------------------------------
@@JvTypes.pas
***************
*** 15,18 ****
--- 15,28 ----
Write here a description
----------------------------------------------------------------------------------------------------
+ @@FourDigitYear
+ <TITLE FourDigitYear function>
+ 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
+ ----------------------------------------------------------------------------------------------------
@@PJvAniTag
<TITLE PJvAniTag type>
***************
*** 32,35 ****
--- 42,95 ----
pointers to records etc.
(Value = 0..100 ; - for reference)
+ ----------------------------------------------------------------------------------------------------
+ @@TCharSet
+ <TITLE TCharSet 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 = TSysCharSet ; - for reference)
+ ----------------------------------------------------------------------------------------------------
+ @@TDateOrder
+ <TITLE TDateOrder type>
+ Summary
+ Write here a summary (1 line)
+ Description
+ Write here a description
+ @@TDateOrder.doMDY
+ Description for doMDY
+ @@TDateOrder.doDMY
+ Description for doDMY
+ @@TDateOrder.doYMD
+ Description for doYMD
+ ----------------------------------------------------------------------------------------------------
+ @@TDayOfWeekName
+ <TITLE TDayOfWeekName type>
+ Summary
+ Enumerates the days of the week.
+ Description
+ Use the TDayOfWeekName type to specify a specific day of the week.
+
+ TDaysOfWeek is a set of TDayOfWeekName values.
+ @@TDayOfWeekName.Sun
+ Sunday.
+ @@TDayOfWeekName.Mon
+ Monday.
+ @@TDayOfWeekName.Tue
+ Tuesday.
+ @@TDayOfWeekName.Wed
+ Wednesday.
+ @@TDayOfWeekName.Thu
+ Thursday.
+ @@TDayOfWeekName.Fri
+ Friday.
+ @@TDayOfWeekName.Sat
+ Saturday.
+ ----------------------------------------------------------------------------------------------------
+ @@TDaysOfWeek
+ <TITLE TDaysOfWeek type>
+ <COMBINE TDayOfWeekName>
---------------------------------------------------------------------------------------------------
@@TJvAniHeader
***************
*** 225,228 ****
--- 285,312 ----
Remove the 'See Also' section if there are no references
----------------------------------------------------------------------------------------------------
+ ----------------------------------------------------------------------------------------------------
+ @@TJvDriveType
+ <TITLE TJvDriveType type>
+ Summary
+ The type of available drives.
+ Description
+ TJvDriveType describes all possible drive types on a computer.
+ @@TJvDriveType.dtUnknown
+ The type of the drive could not be determined.
+ @@TJvDriveType.dtRemovable
+ The drive is a removable drive. This can be a floppy, a tape drive, a zip disk or similar.
+ @@TJvDriveType.dtFixed
+ The drive is a fixed drive.
+ @@TJvDriveType.dtRemote
+ The drive is a networked drive on a LAN or WAN.
+ @@TJvDriveType.dtCDROM
+ The drive is a CD-ROM or DVD or similar.
+ @@TJvDriveType.dtRamDisk
+ The drive is a reserved memory space and not a real, persistent drive.
+ ----------------------------------------------------------------------------------------------------
+ @@TJvDriveTypes
+ <TITLE TJvDriveTypes type>
+ <COMBINE TJvDriveType>
+ ----------------------------------------------------------------------------------------------------
@@TJvDropEvent
<TITLE TJvDropEvent type>
***************
*** 337,340 ****
--- 421,451 ----
Description for grMount
----------------------------------------------------------------------------------------------------
+ @@TJvImageAlign
+ <TITLE TJvImageAlign type>
+ Summary
+ Type used to specify the alignment of images in relation to other objects, like text.
+ Description
+ Use tJvImageAlign to specify where an image is drawn in a control in relation to other items, like text.
+ @@TJvImageAlign.iaLeft
+ Images are aligned to the left of other items.
+ @@TJvImageAlign.iaCentered
+ Images are centered in the control and aligned above other items.
+ ----------------------------------------------------------------------------------------------------
+ @@TJvImageSize
+ <TITLE TJvImageSize type>
+ Summary
+ Type used to set the size of images.
+ Type used to specify the available image sizes for lookout pages and buttons.
+ Description
+ TJvImageSize is the type of the TJvDriveCombo.ImageSize and TJvDriveList.ImageSize properties and
+ is used to specify the size of the displayed icons in the list.
+ The TJvImageSize is used as the ImageSize property for TJvLookoutPage and TJvLookOutButton objects.
+ @@TJvImageSize.isSmall
+ The images should be small (typically 16x16 px).
+ Display images from the SmallImages list.
+ @@TJvImageSize.isLarge
+ The images should be large (typically 32x32 px).
+ Display images from the LargeImages list.
+ ----------------------------------------------------------------------------------------------------
@@TJvKeyFoundEvent
<TITLE TJvKeyFoundEvent type>
***************
*** 513,534 ****
@@TJvRegKey
<TITLE TJvRegKey type>
Summary
! Write here a summary (1 line)
Description
! Write here a description
@@TJvRegKey.hkClassesRoot
! Description for hkClassesRoot
@@TJvRegKey.hkCurrentUser
! Description for hkCurrentUser
@@TJvRegKey.hkLocalMachine
! Description for hkLocalMachine
@@TJvRegKey.hkUsers
! Description for hkUsers
@@TJvRegKey.hkCurrentConfig
! Description for hkCurrentConfig
@@TJvRegKey.hkPerformanceData
! Description for hkPerformanceData
@@TJvRegKey.hkDynData
! Description for hkDynData
----------------------------------------------------------------------------------------------------
@@TJvRegKeys
--- 624,653 ----
@@TJvRegKey
<TITLE TJvRegKey type>
+ @@TJvRegKey
Summary
! Indicates a root key.
Description
! Use the TJvRegKey type to specify a specific root key.
!
! TJvRegKeys is a set of TJvRegKey values.
@@TJvRegKey.hkClassesRoot
! The HKEY_CLASSES_ROOT key, used to define types (or classes) of documents and the properties
! associated with those types.
@@TJvRegKey.hkCurrentUser
! The HKEY_CURRENT_USER key, used for preferences of the current user.
@@TJvRegKey.hkLocalMachine
! The HKEY_LOCAL_MACHINE key, used to define the physical state of the computer,
@@TJvRegKey.hkUsers
! The HKEY_USERS key, used for defining the default user configuration for new users on the local
! computer and the user configuration for the current user.
@@TJvRegKey.hkCurrentConfig
! The HKEY_CURRENT_CONFIG key, contains information about the current hardware profile of the
! local computer system.
@@TJvRegKey.hkPerformanceData
! The HKEY_PERFORMANCE_DATA key, allows you to access performance data.
! Not supported on Windows Me/98/95.
@@TJvRegKey.hkDynData
! The HKEY_DYN_DATA key, allows you to collect performance data.
! Only supported on Windows Me/98/95.
----------------------------------------------------------------------------------------------------
@@TJvRegKeys
***************
*** 636,637 ****
--- 755,776 ----
pointers to records etc.
(Value = array [ 0.. MaxPixelCount - 1 ] of TRGBTriple ; - for reference)
+ ----------------------------------------------------------------------------------------------------
+ @@TSetOfChar
+ <TITLE TSetOfChar 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 = set of Char ; - for reference)
+ ----------------------------------------------------------------------------------------------------
+ @@TTickCount
+ <TITLE TTickCount 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 = Cardinal ; - for reference)
|