Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Classes

~CExtScrollItemWnd Destructor.
CExtScrollItemWnd Constructor.
Create Creates a scrollable window. The method is also used for creating windows associated with the classes derived from CExtScrollItemWnd.
RegisterScrollItemWndClass Static method that registers the window class information for the CExtScrollItemWnd class. It is automatically called by the CExtScrollItemWnd constructor. This makes possible to use the scrollable window as a user-defined control in dialog resources.
SiwAutohideScrollBarGet Returns a boolean value specifying whether the scroll bar should be hidden when the size of the scrollable contents is less than or equal to the size of the currently displayed page.
SiwAutohideScrollBarSet Sets a boolean flag specifying whether the scroll bar should be hidden when the size of the scrollable contents is less than or equal to the size of the currently displayed page. Returns the previous value of the flag.
SiwFireCacheChanging Invokes the OnSiwCacheChanged() overridable method with current and new scrolling information, which specifies whether the contents should be completely reloaded in a grid-like control. The method is used for reloading visible items in a cacheable grid control.
SiwGetStyle Returns basic scrolling window styles.
SiwGetStyleEx Returns extended scrolling window styles.
SiwModifyStyle Modifies the basic scrolling window styles.
SiwModifyStyleEx Modifies the extended scrolling window styles.
SiwPreferHorizontalWalkGet Returns how the walking algorithm passes around scrolling window items, which is used for item painting and hit-testing. The true value indicates that the items are passed around by columns, the false value � by rows.
SiwPreferHorizontalWalkSet Sets the way of how the walking algorithm should pass around scrolling window items, which is used for item painting and hit-testing. The true value specifies that the items should be passed around by columns, the false value � by rows.
SiwScrollTypeHGet Returns which strategy is used for the horizontal scrolling.
SiwScrollTypeHSet Sets the strategy for the horizontal scrolling.
SiwScrollTypeVGet Returns the strategy used for the vertical scrolling.
SiwScrollTypeVSet Sets the strategy for the vertical scrolling.
SiwThumbTrackEnabledGet Returns a boolean value that specifies whether the scrollable contents should be continuously redrawn while dragging the scroll box button (a.k.a. a thumb button).
SiwThumbTrackEnabledSet Sets a boolean value that specifies whether the scrollable contents should be continuously redrawn while dragging the scroll box button (a.k.a. a thumb button) and returns the previous value of the bEnabled parameter.

Overridables

OnSiwCacheChanged Called when the state of the horizontal and/or vertical scroll bar has changed. The current and previous scrolling states can be obtained with two CExtScrollItemCacheInfo objects. Their methods allow you to compare these objects and identify any kind of change in the states of the scroll bars. The Prof-UIS grid control in conjunction with the grid data provider component uses these CExtScrollItemCacheInfo objects to detect any change of the cell data cache. The OnSiwCacheChanged() method allows you to implement minimum possible data uploading to display corresponding cells on the current page.
OnSiwCalcItemSize Returns the default size of any item in pixels. The cx/cy member of CSize is used in the Prof-UIS grid control when all columns/rows are of an equal size.
OnSiwCalcPageMetrics Returns a size of the scrolling page in scrolling units (pixels or items).
OnSiwDrawFocusRect Called to paint the focus rectangle.
OnSiwGetFrozenRange Returns the number of frozen rows (at top and bottom) and frozen columns (on left and right).
OnSiwGetDefaultFont Returns a reference to the font object that is used for drawing text of the data items (e.g., for drawing text in the cells of the Prof-UIS grid control).
OnSiwGetLighterOrDarkerBrush Returns a reference to the brush object that is lighter/darker than the solid brush with the fill color of the system dialog (COLOR_3DFACE). The Prof-UIS grid control uses such brushes for painting the mouse hover, cell selection, and focus-based highlighting effects for the cells.
OnSiwGetReadOnlyBackgroundColor Returns the default background color of the read-only parts of scrollable windows. In a grid window, the method is used for retrieving the default background color of read-only grid cells.
OnSiwGetSysColor Called to return the color value corresponding to the specified system color index. This virtual method allows you to replace the system colors with user-defined values.
OnSiwGetVisibleRange Returns a rectangle that contains zero-based numbers of columns and rows which are completely or partially visible on the currently displayed page.
OnSiwPaintBackground Called to paint the background of data items.
OnSiwPaintForeground Called to paint all the visible data items.
OnSiwQueryFocusedControlState Returns true if the scrolling window has focus; otherwise, false.
OnSiwQueryItemExtentH Returns a width of the column in pixels. The width includes the extra space on the left and on the right of the column. The extra space may be used for previewing data like previewing e-mail messages in the Microsoft Outlook grid control.
OnSiwQueryItemExtentV Returns a height of the row in pixels. The height includes the extra space at the top and at the bottom of the row. The extra space may be used for previewing data like previewing e-mail messages in the Microsoft Outlook grid control.
OnSiwQueryVirtualBOF Returns true if the first item in the data range is visible on the currently displayed page; false otherwise. The method is called only when the virtual scrolling strategy is applied. If both OnSiwQueryVirtualBOF() and OnSiwQueryVirtualEOF() methods return true, the scrolling is not available for all the items are visible on the currently displayed page. If only OnSiwQueryVirtualBOF() returns true, the scroll bar box is at the home position. If only OnSiwQueryVirtualEOF() returns true, the scroll bar box is at the end position. If both methods return false, the thumb statically resides at the center of the scroll bar.
OnSiwQueryVirtualEOF Returns true if the last item in the data range is visible on the currently displayed page; false otherwise. The method is called only when the virtual scrolling strategy is applied. If both OnSiwQueryVirtualBOF and OnSiwQueryVirtualEOF methods return true, the scrolling is not available for all the items are visible on the currently displayed page. If only OnSiwQueryVirtualBOF returns true, the scroll bar box is at the home position. If only OnSiwQueryVirtualEOF returns true, the scroll bar box is at the end position. If both methods return false, the thumb statically resides at the center of the scroll bar.
OnSiwVirtualEndTestH Called when the virtual scrolling strategy is used in the horizontal direction to test whether the specified column number is the last in the data range.
OnSiwVirtualEndTestV Called when the virtual scrolling strategy is used in the vertical direction to test whether the specified row number is the last in the data range.
OnSiwWalkCell Called by the walking algorithm, when the visible items are passed around by columns/rows. To implement some other way of hit-testing and painting, any control derived from the CExtScrollItemWnd class may override this method. If the method returns false, the passing around the visible data items should be ceased.
OnSiwWalkItemsH Called by the walking algorithm, when the visible items are passed around in the row. The default implementation invokes the OnSiwWalkCell() method for all the items in the row. If the method returns false, the passing around the visible data items should be ceased.
OnSiwWalkItemsV Called by the walking algorithm, when the visible items are passed around in the column. The default implementation invokes the OnSiwWalkCell method for all the items in the column. If the method returns false, the passing around the visible data items should be ceased.

See Also

CExtScrollItemWnd Overview | Hierarchy Chart