CEikScrollBarFrame Class Reference

From CCoeControl

Gets the number of controls contained in a compound control.

This method creates double span type scrollbars into this frame. Old scrollbars are deleted or disconnected.

    iSBFrame=new(ELeave) CEikScrollBarFrame(this, NULL, ETrue);
    iSBFrame->SetScrollBarVisibilityL(CEikScrollBarFrame::EOff,
                                      CEikScrollBarFrame::EAuto);
    iSBFrame->CreateDoubleSpanScrollBarsL(ETrue, EFalse);

    Note that double span scrollbar types requires different model classes
    to be used in places of @c TEikScrollBarModel of this scrollbar frame 
    API:s other method calls.
    
    Scrollbar type        Required model (in places of TEikScrollBarModel)
    ---------------       ------------------------------------------------
    EDoubleSpan           TAknDoubleSpanScrollBarModel 
    EArrowHead            TEikScrollBarModel

   // model for double span type scrollbar
   TAknDoubleSpanScrollBarModel vModel; 
   // model for double span type scrollbar
   TAknDoubleSpanScrollBarModel hModel; 
   
   iSBFrame->Tile(vModel, iVRect);

This method creates double span type scrollbars into this frame. Old scrollbars are deleted or disconnected.

This method is used only internally by the CEikScrollBar. Disconnects externally connected scrollbar.

Sets the background drawing for the double spanned scrollbars

This method can be used to enable or disable the drawing of the scrollbar background via mop chain.

Gets the state of the background drawing for the double spanned scrollbars.

This method can be used to get the state of drawing of the scrollbar background via mop chain.

Tell scroll bars and the corner window to redraw if it is visible

Forces any scroll bars and the corner window if it is visible to be redrawn.

Returns a pointer to the scroll bar identified by orientation aOrientation.

Gets a pointer to the horizontal scroll bar.

Initializes a new CEikScrollBarFrameExtension object.

Checks if the vertical scrollbar type is EArrowHead.

Moves the horizontal scroll bar thumb to the position aHorizThumbPos. This function is used to update the scroll bar after an external scroll. The value of aThumbPos should be supplied in terms of the scrolling model, which is presumed not to have changed spans.

Moves the scroll bar thumbs by the specified amounts. This updates the scroll bars after an external scroll. The values of the parameters should be supplied in terms of the horizontal and vertical scrolling models respectively. The scrolling models are presumed not to have changed spans.

Moves the vertical scroll bar thumb to the position aVertThumbPos. This function is used to update the scroll bar after an external scroll. The value of aThumbPos should be supplied in terms of the scrolling model, which is presumed not to have changed spans.

Gets a pointer to the parent window.

Returns the breadth of the scroll bar idenitified by aOrientation, or zero if none exists.

Determines whether the scroll bar specified by aOrientation exists

Sets scrollbar observers.

Gets the visibility of given scrollbar orientation.

This method should be used instead of a deprecated method CEikScrollBarFrame::HScrollBarVisibility() and also can be used instead of CEikScrollBarFrame::VScrollBarVisibility()

Not implemented.

Not implemented.

Sets parent window.

Sets scrollbar frame flags.

Sets scrollbar observers.

Sets the visibility state for both the horizontal and the vertical scroll bars. This is used when tiling.

Sets the type of horizontal scroll bar. Possible values are EArrowHead and EDoubleSpan.

Sets the type of vertical scroll bar. Possible values are EArrowHead and EDoubleSpan.

Moves the vertical scroll bar thumb to the position aFocusPosition. This function is used to update the scroll bar after an external scroll. The value of aFocusPosition should be supplied in terms of the scrolling model, which is presumed not to have changed spans.

Sets the vertical scrollbar mode. Does not actually draw anything until the thumb or focus setting functions are called.

Tiles the vertical EDouble span type scroll bar managed by the frame. The scroll bar is set up according to the scroll bar model and given rectangle which is relative to the parent window of the frame.

 AknLayoutUtils::LayoutVerticalScrollBar(
                                   CEikScrollBarFrame* aScrollBarFrame, 
                                   const TRect& aControlParent, 
                                   const TAknWindowLineLayout& aLayout);

Sets the models of the scrollbars.

Tiles the client area and the scroll bars managed by the frame. The scroll bars are set up according to the scroll bar models; aHModel and aVModel. Ownership is not transferred as a result of passing these parameters as pointers. The result of tiling geometry management is observable through the two rectangles aClientRect and aInclusiveRect. Depending on the tiling layout aLayout and the scroll bar visibility settings, either of these rectangles can be made constant and the other rectangle adjusted accordingly.

For EArrowhead type scrollbar the layout is always fixed, it cannot be altered by using this method.

For EDoublespan type scrollbar the layout can be set also with two helper methods from the AknLayoutUtils class:

 AknLayoutUtils::LayoutVerticalScrollBar(
           CEikScrollBarFrame* aScrollBarFrame, 
           const TRect& aControlParent, 
           const TAknWindowLineLayout& aLayout);
 AknLayoutUtils::LayoutHorizontalScrollBar(
           CEikScrollBarFrame* aScrollBarFrame, 
           const TRect& aControlParent, 
           const TAknWindowLineLayout& aLayout);

Returns the control type of the horizontal scroll bar

Returns the control type of the vertical scroll bar

Determines the vertical scroll bar s visibility. CEikScrollBarFrame::ScrollBarVisibility (CEikScrollBar::TOrientation aOrientation) can be used instead of this method.