diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index f98a7cfedf..c126647859 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -225,16 +225,16 @@ - + Neither maximized nor minimized. - + Minimized to the taskbar. - + Maximized [to the full monitor?] - + Maximized [to the work area? desktop?] @@ -260,78 +260,108 @@ - + - - TCustomHintAction - Base class for THintAction, the action for displaying a Hint + [?] Action taken when a new value is assigned to , + and no OnHint handler is available. + - + The new Hint text. - + The orientation of a ScrollBar. - + Horizontal scrollbar. - + Vertical scrollbar. - + The range of scrollbar increments. - + Scrollbar style. - - + Default. - - + Scrollbar appears flat. - - + Scrollbar sends HotTrack (ThumbTrack?) messages[?] - Exception in Scroll Bar - Exception class for Scroll Bar - + Class for exception in . + + - + - - TControlScrollBar - base class for defining scroll bars on Forms and windows - Control Scroll Bar: Scroll Bar control for adding to windows. - Can be horizontal or vertical.
+ Type of a scrollbar in a . + + +

+ Scrollable controls supply their own integrated scrollbars, + one for horizontal and one for vertical scrolling. + This class allows access to (one of) these integrated scrollbars. +

+ A scrollable control has both a physical (visible) client size, + and a virtual (scrollable) client size. +

+ The Range property reflects the virtual client size, + e.g. the total number of lines in an file. +

+ The Page property then reflects the number of lines, + actually visible in the scrollable control. + It also determines the size of the slider, relative to the total Range. +

+ The Position property then reflects + the number of the first visible line in the scrollable control, + equivalent to the top coordinate of the slider. + The Position can be changed by the user or by code. +

+ Scrollbars usually appear only when Range is higher than Page, + i.e. when not the entire content can be shown at the same time. + See the ScrollBar property of the scrolling control for details. +

+ The Range and Position can be limited to 16 bit (TScrollBarInc) precision internally, + what is sufficient for painting the scrollbar widget, + but may not be enough for the virtual content. + See the actual scrolling control for details. +

- - + + + + + - + The virtual scroll range (FRange - ClientSize), at least zero (never negative). + @@ -358,15 +388,15 @@ - - FControl - local variable to hold the Window Control to which the scroll bar belongs + The associated . + - - ControlHandle - the operating system handle for this control + The Handle of the associated . + @@ -376,11 +406,10 @@ - + The AutoScroll state of the associated . + - - @@ -408,13 +437,7 @@ - - - GetSize - returns the size of the scroll bar - - - - + @@ -425,53 +448,45 @@ - - HandleAllocated - returns True if a handle has been allocated + True when the associated has a handle allocated. + - - - - - - - - - - - + - - AutoCalcRange - method for automatically calculating the range of values for the scroll bar + Determines the Range, based on the physical and virtual size of the associated control. + - - ControlUpdateScrollBars - method to be used by the owner control for updating its scrollbars + Notifies the associated Control of changes. + - - + + + - + Checks and propagates the new range to the Control. + - - + + @@ -479,8 +494,8 @@ - - ScrollHandler - message handler to control scrolling + Handler for the ScrollBar (movement) messages. + @@ -490,16 +505,17 @@ - + Disables AutoScroll - even if the name suggests something different! + - + [AutoScroll not yet implemented?] - + Ignored (assumed to be False) @@ -522,14 +538,7 @@ - - - SetSize - specifies the size of the scroll bar - - - - - + @@ -539,15 +548,7 @@ - - - - - - - - - + @@ -558,47 +559,48 @@ - - UpdateScrollBar - method to update the scroll bar (position etc) + [usage?] update the scroll bar (position etc) - - InvalidateScrollInfo - method to render scroll information non-valid + [usage?] render scroll information non-valid - - GetHorzScrollBar - find the position and properties of the horizontal scroll bar + Get the horizontal scrollbar of Control. + - Returns details of the horizontal scroll bar as a pointer to a structure + + - - GetVertScrollBar - find the position and properties of the vertical scroll bar + Get the vertical scrollbar of Control. + - Returns details of the vertical scroll bar as a pointer to a structure + + - + Determines whether a scrollbar is required. + @@ -607,12 +609,12 @@ - + True when Visible and Range higher than Page. - The identity of the windowed control in which the scroll bar is found + The windowed control in which the scroll bar is found Whether this is a horizontal or a vertical scrollbar @@ -630,110 +632,126 @@ - The object that called this instance of the class + + - Returns current widget state. + Determines the current widget state. - True if scroll bar visible. + True if scrollbar is visible. - Position of the indicator cursor on the scroll bar + The scroll Position, zero if not Visible. + - Returns position of the scroll cursor as an integer - - - - Finds which kind of scroll bar this is: horizontal or vertical - Reads a flag to determine which kind of scroll bar - + The scroll Position, zero if not Visible. - Finds out details of the other scroll bar + Get the ScrollBar of the opposite direction (horz/vert). + - Returns a link to the details of the other scroll bar + - - + The currently remaining extent of the Parent Control, depending on ScrollBar visibility. + + return for vertical scrollbar the clientwidth - - - + for vertical scrollbar the clientwidth - - + The remaining extent of the Parent Control, when the ScrollBar is visible. + + return for vertical scrollbar the clientwidth with the bar, even if Visible=false - - - + for vertical scrollbar the clientwidth with the bar, even if Visible=false + - - + The remaining extent of the Parent Control, when the ScrollBar is not visible. + + return for vertical scrollbar the clientwidth without the bar, even if Visible=true - - - + for vertical scrollbar the clientwidth without the bar, even if Visible=true + - The size of the scrolling increment - The amount by which the scroll indicator moves if the triangle at either end of the bar is selected.
- -Read or write a flag to determine the increment, an integer with a default value of 8 (pixels) + The small Position increment, applicable to the scrollbar arrows. + + The amount by which the Position moves if the triangle at either end of the bar is selected. +
Default is 8 (pixels). + + + + + + The orientation: horizontal or vertical. + + - The size of the paging increment for scrolling - The amount by which the scroll indicator moves if the cursor selects the scroll bar above, below or on either side of the scroll indicator.
-Reads or writes a flag to determine paging increment; default value is 80 pixels + The slider size, + Position increment applicable to the scrollbar area beneath the slider. + + The amount by which the scroll indicator moves if the cursor selects the scroll bar above, below or on either side of the scroll indicator. +
Default is 80 (pixels). + - Position of the scroll bar - Reads or writes a flag with the position; default is zero + Position of the slider, 0..Range-Page. + + The Position reflects the top coordinate of the slider, + which is Range-Page when the slider is at the bottom of the bar. + - Determine whether smooth scrolling is to be implemented - Reads or writes a flag to determine smooth scrolling, and sets a flag is the scrolling status is stored - + Enables smooth scrolling, with automatic adjustment of Increment and Page. + + Smooth scrolling uses an Increment of 10% + and a Page size of 90% of the visible client area[?] + + + + + @@ -741,33 +759,50 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels - The range (extent) of the scroll bar - Reads or writes a flag to determine the range; default is zero + The virtual size of the Parent Control. + + - Determine the size of the scroll bar - Reads or writes a flag to determine the size; by default the size is not stored + The adjustable size of the scroll bar. + The length of the bar is the Width (or Height) of the Parent Control, + the Size is the other (free) coordinate. + - - + Gives feedback while the slider is dragged. + + When it takes an significant amount of time, + to repaint the parent control at a new position, + Tracking should be False to prevent flicker; + then the control is updated only when the slider is released. - Can the scroll bar be made visible? - Reads or writes flag to determine visibility, and sets a flag if the property is stored. -The Handle object (widget) is made visible if (Visible=true) and (Range>Page). -To get the current visible state of the widget use the method IsScrollBarVisible. - + Definitely hides the scrollbar when False (default True). + + +

+ The scrollbar widget is visible only if (Visible=True) and (Range>Page). +

+ Set Visible to False to disallow the user to scroll the content, + while the content still can be scrolled by code. +

+ Use IsScrollBarVisible to get the current visible state of the widget. +

+ + + + - + Class of a Window Control that has one or more scroll bars.