CEikScrollBarFrame Class Reference

Defines that is the horizontal or the vertical (spanned) scroll bar visible.

Applicaple only for spanned scroll bars.

Enumerator:

EHVisible	Horizontal spanned scroll bar visible.
EVVisible	Vertical spanned scroll bar visible.

Determines how the scroll bar frame manages scroll bars.

Enumerator:

EComponent	The scroll bar frame creates, destroys and recreates, scroll bars according to the visibility mode. The scroll bar frame also acts as an intermediary with its owning control so that the scroll bars can be treated as component controls.
EFloating	The scroll bar frame creates, destroys and recreates, scroll bars according to the visibility mode. In this case, the scroll bars are not treated as component controls. Instead, the scroll bars are geometry managed in windows floating above the control window and their position is determined in relation to the frame’s position on the screen.
EApplicationScrollBar	The scroll bar frame uses the central application scroll bar as held in the environment. This scroll bar is neither owned by the frame nor treated as a component control of the frame’s owner.

Defines where the scroll bar is located.

Enumerator:

EBottomOrRight	Scroll bar located at the bottom, or to the right of the scroll bar frame.
ETopOrLeft	Scroll bar located at the top, or to the left of the scroll bar frame.

Defines the type of scroll bar.

Enumerator:

ENormalScrollBar	Scroll bar complete with shaft. Not used.
EArrowHead	Floating arrow head scroll bar, without shaft. Legacy type.
EDoubleSpan	Spanned scroll bar.

C++ default constructor.

Constructor.

Constructs a scroll bar frame object.

Parameters:

	aParentWindow	The scroll bar’s parent control.
	aObserver	The scroll bar observer.
	aPreAlloc	Not used.

Destructor.

Constructor.

Internal only to Eikcoctl.lib use. Parameter aDoubleSpan offers possibility to optimize scroll bar loading (if ETrue, arrowhead scroll bar will never be loaded).

Parameters:

	aParentWindow	The scroll bar’s parent control.
	aObserver	The scroll bar observer.
	aPreAlloc	Not used.
	aDoubleSpan	If ETrue, spanned scroll bar is created.

From CCoeControl.

Gets the component specified by index. Within a compound control, each component control is identified by an index, where the index depends on the order the controls were added: the first is given an index of 0, the next an index of 1, and so on.

Returns:

The component control with an index of aIndex

From CCoeControl.

Gets the number of controls contained in a compound control.

Returns:

The number of component controls contained in this control.

This method creates double span type scrollbars into this frame.

Old scrollbars are deleted or disconnected.

Parameters:

	aWindowOwning	Tells wheter created scrollbar should be a window owning control or not. Selection for this is relevant especially because skinned scrollbar draws its background using its parent windows background context.
	aRemote	True if this method should instead of creating own scrollbar try to connect to a remote scrollbar frame and start using its scrollbars. Connecting is done using through object provider mechanism, so the object supply chain must be valid. Also if true, then parameter aWindowOwning will be ignored.
	aVertical	If ETrue vertical scrollbar will be created to scrollbar frame.
	aHorizontal	If ETrue horizontal scrollbar will be created to scrollbar frame.

Leave:

KErrNotFound Parent object doesn't have scrollbar frame.

This method creates double span type scrollbars into this frame.

Old scrollbars are deleted or disconnected.

Parameters:

	aWindowOwning	Tells wheter created scrollbar should be a window owning control or not. Selection for this is relevant especially because skinned scrollbar draws
	aRemote	True if this method should instead of creating own scrollbar try to connect to a remote scrollbar frame and start using its scrollbars. Connecting is done using through object provider mechanism, so the object supply chain must be valid. Also if true, then parameter aWindowOwning will be ignored.

    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);

Defines the scroll bar’s visibility.

Scroll bar not visible.

Scroll bar visible.

Scroll bar visible if required.

This method is used only internally by the CEikScrollBar.

Disconnects externally connected scrollbar.

Parameters:

aScrollBar

Scrollbar to be disconnected.

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.

Parameters:

	aDrawHorizontal	sets the state of the background drawing of the horizontal scrollbar.
	aDrawVertical	sets the state of the background drawing of the vertical scrollbar.

Returns:

Success of the call, KErrNotSupported if the scrollbars are not doublespan scrollbars.

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.

Parameters:

	aDrawHorizontal	gets the state of the background drawing of the horizontal scrollbar.
	aDrawVertical	gets the state of the background drawing of the vertical scrollbar.

Returns:

Success of the call, KErrNotSupported if the scrollbars are not doublespan scrollbars.

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.

Parameters:

aOrientation

The orientation of the scroll bar for which you wish to obtain a pointer.

Returns:

A pointer to the scroll bar with orientation aOrientation if the scrollbar is visible.

Gets a pointer to the horizontal scroll bar.

Returns:

A pointer to the horizontal scroll bar.

Initializes a new CEikScrollBarFrameExtension object.

Parameters:

	aParentWindow	The scroll bar’s parent control.
	aObserver	The scroll bar observer.

Checks if the vertical scrollbar type is EArrowHead.

Parameters:

aFlag

Not used.

Returns:

ETrue if the type of the scrollbar 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.

Parameters:

aHorizThumbPos

The required thumb position.

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.

Parameters:

	aDeltaX	The amount to move the horizontal scroll bar.
	aDeltaY	The amount to move the vertical scroll bar.

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.

Parameters:

aVertThumbPos

The required thumb position.

Gets a pointer to the parent window.

Returns:

A pointer to the parent window.

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

Parameters:

aOrientation

The orientation of the scroll bar for which you wish to obtain the breadth.

Returns:

The specified scroll bar's breadth. This is zero if none exists.

Determines whether the scroll bar specified by aOrientation exists.

Parameters:

aOrientation

The scroll bar’s orientation.

Returns:

ETrue if the specified scroll bar exists otherwise EFalse.

Sets scrollbar observers.

Parameters:

aObserver

The scroll bar observer.

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()

Parameters:

aOrientation

The orientation of a scrollbar in the frame.

Returns:

The visibility of requested scrollbar.

Not implemented.

Parameters:

aAdjusts

Not used.

Not implemented.

Parameters:

aAdjusts

Not used.

Sets parent window.

Parameters:

aParentWindow

A pointer to the parent window.

Sets scrollbar frame flags.

Parameters:

aMask

Bitmask of the bits that are to be set.

Sets scrollbar observers.

Parameters:

aObserver

The scroll bar observer.

Sets the visibility state for both the horizontal and the vertical scroll bars.

This is used when tiling.

Parameters:

	aHVisibility	Horizontal scroll bar visibility.
	aVVisibility	Vertical scroll bar visibility.

Sets the type of horizontal scroll bar.

Possible values are EArrowHead and EDoubleSpan.

Parameters:

aType

Type of the scrollbar.

Sets the type of vertical scroll bar.

Possible values are EArrowHead and EDoubleSpan.

Parameters:

aType

Type of the scrollbar.

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.

Parameters:

aFocusPosition

The required thumb position.

Sets the models of the scrollbars.

Parameters:

	aHModel	The model of the horizontal scrollbar.
	aVModel	The model of the vertical scrollbar.

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.

Parameters:

	aVModel	Vertical scrollbar model.
	aVScrollBar	Vertical scrollbar rectangle.

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

Sets the vertical scrollbar mode.

Does not actually draw anything until the thumb or focus setting functions are called.

Parameters:

aVModel

Model for the vertical scrollbar.

Returns:

EFalse.

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);

Parameters:

	aHModel	Horizontal scroll bar model.
	aVModel	Vertical scroll bar model.
	aClientRect	Client rectangle.
	aInclusiveRect	A rectangle that includes the area to be scrolled and the scroll bars themselves.
	aLayout	Tiling layout.

Returns:

ETrue if the non-constant rectangle is adjusted, otherwise EFalse.

Returns the control type of the horizontal scroll bar.

Returns:

Type of the scrollbar.

Returns the control type of the vertical scroll bar.

Returns:

Type of the scrollbar.

Returns a pointer to the vertical scroll bar.

Returns:

A pointer to the vertical scroll bar.

Determines the vertical scroll bar’s visibility.

CEikScrollBarFrame::ScrollBarVisibility (CEikScrollBar::TOrientation aOrientation) can be used instead of this method.

Returns:

Visibility for vertical scroll bar.

Struct object.