Menu
▾
▴
[JVCL-Checkins] CVS: dev/help JvScrollPanel.dtx,NONE,1.1
|
From: Remko B. <rem...@us...> - 2002-10-22 00:01:22
|
Update of /cvsroot/jvcl/dev/help In directory usw-pr-cvs1:/tmp/cvs-serv14953 Added Files: JvScrollPanel.dtx Log Message: Added JvScrollPanel --- NEW FILE: JvScrollPanel.dtx --- ---------------------------------------------------------------------------------------------------- @@JvScrollPanel.pas <GROUP JVCL.FileRef> Summary Contains the TJvScrollingWindow and TJvDivider components. <INCLUDE JVCL.UnitText.dtx> Author Peter Thörnqvist ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel Summary Base class for scrollable panels. Description TJvCustomScrollPanel is a base class for scrollable panels. Do not create instances of TJvCustomScrollPanel. Use the generic descendent TJvScrollingWindow, or create your own descendent class. ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.AboutJVCL <INCLUDE JVCL.Main.AboutJVCL.dtx> ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.AutoArrange Summary Determines whether the controls on the scrolling panel are automatically rearranged if ScrollDirection changes. Description If AutoArrange is True and ScrollDirection changes then the control swaps the Left and Top values, and the Width and Height values of all controls in the scrolling panel. See Also ScrollDirection ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.AutoHide Summary Indicates whether the scroll buttons hide automatically on the scrolling panel control if it is large enough to display all of its controls. Description If AutoHide is True the scroll bars hide automatically when necessary. For example, if the user scrolls the control so that all of its controls are visible, the scroll buttons hide. If AutoHide is False, the scroll buttons dont hide automatically. See Also AutoRepeat, ScrollAmoun ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.AutoRepeat Summary Determines whether the scroll panel continues to be scrolled at regular intervals while a scroll button is in the depressed state. Description If AutoRepeat is set to False, the scroll panel scrolls only once while a scroll button is depressed. If AutoRepeat is set to True, the scroll panel continues to be scrolled at regular intervals while a scroll button is in the depressed state. The default value is False See Also AutoHide, ScrollAmount ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.Flat Summary Determines whether the scroll buttons have a three-dimensional (3-D) look with borders or two-dimensional look without borders. Description When Flat is True, the scroll buttons appear flat and do not have borders separating them. When Flat is False, the buttons are clearly defined. ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.OnScrolled <COMBINEWITH TJvScrolledEvent> Summary Occurs after the user has scrolled the scrolling panel. Description \Write an OnScrolled event handler to take specific action when the user finishes scrolling the scrolling panel. Parameters Sender - The scrolling panel control that has been scrolled. Kind - Specifies the kind of scroll. See Also OnScrolling, ScrollAmount ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.OnScrolling <COMBINEWITH TJvScrollingEvent> Summary Occurs when the user tries to scroll the scrolling panel by pressing a scroll button. Description \Write an OnScrolling event handler to conditionally prevent the user from scrolling the scrolling panel. Set AllowChange to False to disallow any scroling of the scrolling panel. Parameters Sender - The scrolling panel control the user tries to scroll. AllowChange - Indicates whether the scroll should be permitted. Kind - Specifies the kind of scroll. See Also OnScrolled, ScrollAmount ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.ScrollAmount Summary Determines how much the position of controls in the scrolling panel changes when the user clicks the scroll buttons on the scrolling panel. Description Set ScrollAmount to specify how much to change the position of controls in the scrolling panel, when the user clicks on the scroll buttons. Property ScrollDirection determines whether the scroll is horizontally or vertically. See Also ScrollDirection ---------------------------------------------------------------------------------------------------- @@TJvCustomScrollPanel.ScrollDirection <COMBINEWITH TJvScrollDirection> <AUTOLINK OFF> Summary Specifies how the user can scroll the scrolling panel. Description <AUTOLINK ON> Set ScrollDirection to specify how the user can scroll the scrolling panel. The possible values of ScrollDirection are: <TABLE> Value Meaning ----- ------- sdHorizontal The user can scroll the scrolling panel horizontally. sdVertical The user can scroll the scrolling panel vertically. </TABLE> <AUTOLINK OFF> See Also AutoHide, ScrollAmount ---------------------------------------------------------------------------------------------------- @@TJvDivideKind <TITLE TJvDivideKind type> ---------------------------------------------------------------------------------------------------- @@TJvDivider ##JVCL:Component <TITLEIMG TJvDivider> <GROUP JVCL.Graphics.Shapes> Summary Represents a spacer. Description Use TJvDivider to act as a spacer or divider. For example on a TJvScrollingWindow, so it can group controls on the scrolling panel both visually and functionally. See Also TJvScrollingWindow ---------------------------------------------------------------------------------------------------- @@TJvDivider.Kind <COMBINEWITH TJvDivideKind> <AUTOLINK OFF> Summary Determines the shape of the control. Description <AUTOLINK ON> Kind specifies whether the control is a divider or a seperator. These are the possible values for Kind: <TABLE> Value Meaning ----- ------- dkDivider The control displays a line at the center of the client area. dkSeparator The control fills an empty space. </TABLE> <AUTOLINK OFF> See Also Vertical ---------------------------------------------------------------------------------------------------- @@TJvDivider.Vertical Summary Determines whether the divider is oriented vertically or horizontally. Description Property Vertical has only meaning if Kind is dkDivider. It then specifies whether the line at the center of the client area is oriented vertically or horizontally. See Also Kind ---------------------------------------------------------------------------------------------------- @@TJvScrollDirection <TITLE TJvScrollDirection type> <AUTOLINK OFF> ---------------------------------------------------------------------------------------------------- @@TJvScrolledEvent <TITLE TJvScrolledEvent type> ---------------------------------------------------------------------------------------------------- @@TJvScrollingEvent <TITLE TJvScrollingEvent type> ---------------------------------------------------------------------------------------------------- @@TJvScrollingWindow ##JVCL:Component <TITLEIMG TJvScrollingWindow> <GROUP JVCL.Bars.MenusAndTools,JVCL.PanelsBevelsAndGroups.Panels> Summary Represents a scrolling toolbar. Description Use TJvScrollingWindow to create a scrollable container for controls. TJvScrollingWindow represents a horizontally or vertically oriented toolbar that contains scroll buttons to scroll it's content. Use property <LINK TJvCustomScrollPanel.ScrollDirection,ScrollDirection> to specify whether the user can scroll the content horizontally or vertically. You can use component TJvDivider to act as a spacer or divider, so it can group controls on the scrolling panel both visually and functionally. See Also TJvDivider ---------------------------------------------------------------------------------------------------- @@TJvScrollKind <TITLE TJvScrollKind type> Summary Represents different kinds of scroll actions. Description TJvScrollKind represents different kinds of scroll actions a user can perform on a scrolling panel. The following table gives the possible values: @@TJvScrollKind.sbUp The contents of a scrolling panel is scrolled up. @@TJvScrollKind.sbDown The contents of a scrolling panel is scrolled down. @@TJvScrollKind.sbLeft The contents of a scrolling panel is scrolled to the left. @@TJvScrollKind.sbRight The contents of a scrolling panel is scrolled to the right. |