Symbian^3 Application Developer Library >

CAknDoubleSpanScrollBar Class Reference

class CAknDoubleSpanScrollBar : public CEikScrollBar

The CAknDoubleSpanScrollBar class is a scroll bar without buttons, but it has a shaft. Additionally it has in its shaft a double span feature which means that there can be another thumb inside the thumb if needed.

This class uses TAknDoubleSpanScrollBarModel instead of TEikScrollBarModel as its internal scrollbar model. TAknDoubleSpanScrollBarModel in binary compatible with TEikScrollBarModel . User must take care that TAknDoubleSpanScrollBarModel is really used in API calls in places where TEikScrollBarModel is declared.

Since
2.6

Inherits from

Public Member Functions
CAknDoubleSpanScrollBar ( CCoeControl *)
~CAknDoubleSpanScrollBar ()
IMPORT_C void ConstructL ( TBool , MEikScrollBarObserver *, const CCoeControl *, TOrientation , TInt , TInt )
IMPORT_C void ConstructL ( MEikScrollBarObserver *, const CCoeControl *, TOrientation , TInt , TInt )
void DrawBackground ( TBool )
TBool DrawBackgroundState ()
TRect FixedLayoutRect ()
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void MakeVisible ( TBool )
void ResetPressedDownHighlight ()
IMPORT_C void SetFixedLayoutRect ( TRect )
IMPORT_C void SetScrollPopupInfoTextL (const TDesC &)
Protected Member Functions
IMPORT_C CCoeControl * ComponentControl ( TInt )
IMPORT_C TInt CountComponentControls ()
Private Member Functions
void CreateButtonL (CAknScrollButton *&, CAknScrollButton::TType)
TRect ExtensionArea ()
IMPORT_C void * ExtensionInterface ( TUid )
void SetButtonPositionL (CAknScrollButton *)
void SetTransparentBackground ( TBool )
IMPORT_C void SizeChanged ()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::Draw(const TRect &)const
CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CEikBorderedControl::HandleResourceChange(TInt)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
CEikScrollBar::CEikScrollBar()
CEikScrollBar::CreateRequiredComponentsL()
CEikScrollBar::DecreaseNudgeButton()const
CEikScrollBar::DefaultScrollBarBreadth()
CEikScrollBar::DestroyButton(CAknScrollButton *&)
CEikScrollBar::IncreaseNudgeButton()const
CEikScrollBar::MinVisibleLength(const TInt)
CEikScrollBar::Model()const
CEikScrollBar::ScrollBarBreadth()const
CEikScrollBar::ScrollBarType()
CEikScrollBar::SetAllButtonsDimmed(TBool)
CEikScrollBar::SetContainingCba(CEikCba *)
CEikScrollBar::SetDecreaseButtonsDimmed(TBool)
CEikScrollBar::SetExtensionAreaType(TScrollBarExtensionAreaType)
CEikScrollBar::SetFocusPosToThumbPos(TInt)
CEikScrollBar::SetIncreaseButtonsDimmed(TBool)
CEikScrollBar::SetLengthAndModelL(TInt,const TEikScrollBarModel *)
CEikScrollBar::SetLengthL(TInt)
CEikScrollBar::SetModel(const TEikScrollBarModel *)
CEikScrollBar::SetModelL(const TEikScrollBarModel *)
CEikScrollBar::SetModelThumbPosition(TInt)
CEikScrollBar::SetScrollBarObserver(MEikScrollBarObserver *)
CEikScrollBar::ThumbPosition()const
CEikScrollBar::~CEikScrollBar()
Inherited Enumerations
CCoeControl:TZoomType
CEikScrollBar:TEikScrollBarFlags
CEikScrollBar:TOrientation
CEikScrollBar:TPointerDownOn
CEikScrollBar:TPrivateScrollBarFlags
CEikScrollBar:TScrollBarExtensionAreaType
CEikScrollBar:TScrollBarType
CEikScrollBar:TShaftRedrawRequired
CEikScrollBar:TWhichButtons
Private Attributes
CCoeControl * iParentControl
TInt iSpare
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder
CEikScrollBar::iButtons
CEikScrollBar::iExtension
CEikScrollBar::iOrientation
CEikScrollBar::iSBLink

Constructor & Destructor Documentation

CAknDoubleSpanScrollBar(CCoeControl *)

IMPORT_C CAknDoubleSpanScrollBar ( CCoeControl * aParentWindow )

Parameters

CCoeControl * aParentWindow

~CAknDoubleSpanScrollBar()

IMPORT_C ~CAknDoubleSpanScrollBar ( )

Member Functions Documentation

ComponentControl(TInt)

IMPORT_C CCoeControl * ComponentControl ( TInt aIndex ) const [protected, virtual]

From CCoeControl

Gets the specified scrollbar component. 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.

Parameters

TInt aIndex The index of the control to get.

ConstructL(TBool, MEikScrollBarObserver *, const CCoeControl *, TOrientation, TInt, TInt)

IMPORT_C void ConstructL ( TBool aWindowOwning,
MEikScrollBarObserver * aScrollBarObserver,
const CCoeControl * aParent,
TOrientation aOrientation,
TInt aLength,
TInt aScrollBarFlags = EEikScrollBarDefaultBehaviour
)

Method for constructing the object.

Since
2.6

Parameters

TBool aWindowOwning True if scrollbar is to be a window owning control.
MEikScrollBarObserver * aScrollBarObserver Same as in CEikScrollBar::ConstructL()
const CCoeControl * aParent Same as in CEikScrollBar::ConstructL()
TOrientation aOrientation Same as in CEikScrollBar::ConstructL()
TInt aLength Same as in CEikScrollBar::ConstructL()
TInt aScrollBarFlags = EEikScrollBarDefaultBehaviour Same as in CEikScrollBar::ConstructL()

ConstructL(MEikScrollBarObserver *, const CCoeControl *, TOrientation, TInt, TInt)

IMPORT_C void ConstructL ( MEikScrollBarObserver * aScrollBarObserver,
const CCoeControl * aParent,
TOrientation aOrientation,
TInt aLength,
TInt aScrollBarFlags = EEikScrollBarDefaultBehaviour
) [virtual]

Second phase constructor of the scroll bar.

Parameters

MEikScrollBarObserver * aScrollBarObserver The scroll bar observer which is to be informed of scroll events by this scroll bar.
const CCoeControl * aParent Parent control for this new scroll bar.
TOrientation aOrientation Orientation of the new scroll bar.
TInt aLength Not used.
TInt aScrollBarFlags = EEikScrollBarDefaultBehaviour Not used.

CountComponentControls()

IMPORT_C TInt CountComponentControls ( ) const [protected, virtual]

From .

Gets the number of controls contained in this scrollbar.

CreateButtonL(CAknScrollButton *&, CAknScrollButton::TType)

void CreateButtonL ( CAknScrollButton *& aButton,
CAknScrollButton::TType aType
) [private, virtual]

Parameters

CAknScrollButton *& aButton
CAknScrollButton::TType aType

DrawBackground(TBool)

void DrawBackground ( TBool aDrawHorizontal )

Parameters

TBool aDrawHorizontal

DrawBackgroundState()

TBool DrawBackgroundState ( )

ExtensionArea()

TRect ExtensionArea ( ) const [private]

Calculates scrollbar's extension area relative to its own position.

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

From CAknControl

Parameters

TUid aInterface

FixedLayoutRect()

TRect FixedLayoutRect ( )
Gets the fixed layoutrect of the scrollbar.
Since
2.6

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl

Called by the framework to handle pointer events.

Parameters

const TPointerEvent & aPointerEvent A pointer event.

MakeVisible(TBool)

IMPORT_C void MakeVisible ( TBool aVisible ) [virtual]

From CCoeControl .

Sets this control as visible or invisible.

If MakeVisible() is used to make a component visible, and the control captures the pointer (see CapturesPointer() ), MakeVisible() throws away any pending pointer events for that control.

Parameters

TBool aVisible ETrue to make the control visible, EFalse to make it invisible.

ResetPressedDownHighlight()

void ResetPressedDownHighlight ( )

Resets pressed down highlight so that default highlight is used when the scrollbar is drawn.

Since
S60 5.2

SetButtonPositionL(CAknScrollButton *)

void SetButtonPositionL ( CAknScrollButton * aButton ) [private, virtual]

Not implemented

Parameters

CAknScrollButton * aButton Not used.

SetFixedLayoutRect(TRect)

IMPORT_C void SetFixedLayoutRect ( TRect aScrollBarRect )

Sets fixed layout to scrollbar. If set, then scrollbar size changes done by the CEikScrollBarFrame class are disabled.

Since
2.6

Parameters

TRect aScrollBarRect Scrollbar rectangle.

SetScrollPopupInfoTextL(const TDesC &)

IMPORT_C void SetScrollPopupInfoTextL ( const TDesC & aText )

Sets scroll popup info text to be shown while dragging with stylus. Popup is shown until next pointer up event. KNullDesC parameter can be used to hide popup earlier.

Since
3.2

Parameters

const TDesC & aText Text to be shown

SetTransparentBackground(TBool)

void SetTransparentBackground ( TBool aTransparentBackground ) [private]

Sets scrollbar background transparency as given in the parameter.

Since
2.6

Parameters

TBool aTransparentBackground If ETrue then scrollbar will have transparent background.

SizeChanged()

IMPORT_C void SizeChanged ( ) [private, virtual]

Member Data Documentation

CCoeControl * iParentControl

CCoeControl * iParentControl [private]

TInt iSpare

TInt iSpare [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.