CAknDoubleSpanScrollBar Class Reference

#include <mw/eikscrlb.h>

class CAknDoubleSpanScrollBar : public CEikScrollBar

Inherits from

Public Member Functions
CAknDoubleSpanScrollBar(CCoeControl *)
~CAknDoubleSpanScrollBar()
IMPORT_C voidConstructL(TBool, MEikScrollBarObserver *, const CCoeControl *, TOrientation, TInt, TInt)
virtual IMPORT_C voidConstructL(MEikScrollBarObserver *, const CCoeControl *, TOrientation, TInt, TInt)
voidDrawBackground(TBool)
TBool DrawBackgroundState()
TRect FixedLayoutRect()
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
virtual IMPORT_C voidMakeVisible(TBool)
voidResetPressedDownHighlight()
IMPORT_C voidSetFixedLayoutRect(TRect)
IMPORT_C voidSetScrollPopupInfoTextL(const TDesC &)
Protected Member Functions
virtual IMPORT_C CCoeControl *ComponentControl(TInt)
virtual IMPORT_C TIntCountComponentControls()
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder
CEikScrollBar::iButtons
CEikScrollBar::iExtension
CEikScrollBar::iOrientation
CEikScrollBar::iSBLink
Inherited Enumerations
CCoeControl:TZoomType
CEikScrollBar:TEikScrollBarFlags
CEikScrollBar:TOrientation
CEikScrollBar:TPointerDownOn
CEikScrollBar:TPrivateScrollBarFlags
CEikScrollBar:TScrollBarExtensionAreaType
CEikScrollBar:TScrollBarType
CEikScrollBar:TShaftRedrawRequired
CEikScrollBar:TWhichButtons
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::CCoeControlArray
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::CEikScrollBarFrame
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 Type Definitions
CEikScrollBar::TAknScrollBarFlags

Detailed Description

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

Constructor & Destructor Documentation

CAknDoubleSpanScrollBar ( CCoeControl * )

IMPORT_CCAknDoubleSpanScrollBar(CCoeControl *aParentWindow)

~CAknDoubleSpanScrollBar ( )

IMPORT_C~CAknDoubleSpanScrollBar()

Member Function Documentation

ComponentControl ( TInt )

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)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.

ParameterDescription
aIndexThe index of the control to get.

Returns: The component control with an index of aIndex.

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

IMPORT_C voidConstructL(TBoolaWindowOwning,
MEikScrollBarObserver *aScrollBarObserver,
const CCoeControl *aParent,
TOrientationaOrientation,
TIntaLength,
TIntaScrollBarFlags = EEikScrollBarDefaultBehaviour
)

Method for constructing the object.

Since
2.6
ParameterDescription
aWindowOwningTrue if scrollbar is to be a window owning control.
aScrollBarObserverSame as in CEikScrollBar::ConstructL()
aParentSame as in CEikScrollBar::ConstructL()
aOrientationSame as in CEikScrollBar::ConstructL()
aLengthSame as in CEikScrollBar::ConstructL()
aScrollBarFlagsSame as in CEikScrollBar::ConstructL()

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

IMPORT_C voidConstructL(MEikScrollBarObserver *aScrollBarObserver,
const CCoeControl *aParent,
TOrientationaOrientation,
TIntaLength,
TIntaScrollBarFlags = EEikScrollBarDefaultBehaviour
)[virtual]

Second phase constructor of the scroll bar.

ParameterDescription
aScrollBarObserverThe scroll bar observer which is to be informed of scroll events by this scroll bar.
aParentParent control for this new scroll bar.
aOrientationOrientation of the new scroll bar.
aLengthNot used.
aScrollBarFlagsNot used.

CountComponentControls ( )

IMPORT_C TIntCountComponentControls()const [protected, virtual]

From .

Gets the number of controls contained in this scrollbar.

Returns: The number of component controls contained by this scrollbar.

DrawBackground ( TBool )

voidDrawBackground(TBoolaDrawHorizontal)

DrawBackgroundState ( )

TBool DrawBackgroundState()

FixedLayoutRect ( )

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

Returns: Scrollbar rectangle.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl

Called by the framework to handle pointer events.

ParameterDescription
aPointerEventA pointer event.

MakeVisible ( TBool )

IMPORT_C voidMakeVisible(TBoolaVisible)[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.

ParameterDescription
aVisibleETrue to make the control visible, EFalse to make it invisible.

ResetPressedDownHighlight ( )

voidResetPressedDownHighlight()

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

Since
S60 5.2

SetFixedLayoutRect ( TRect )

IMPORT_C voidSetFixedLayoutRect(TRectaScrollBarRect)

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

Since
2.6
ParameterDescription
aScrollBarRectScrollbar rectangle.

SetScrollPopupInfoTextL ( const TDesC & )

IMPORT_C voidSetScrollPopupInfoTextL(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
ParameterDescription
aTextText to be shown