CEikScrollBar Class Reference

class CEikScrollBar : public CEikBorderedControl

The CEikScrollBar class implements a scroll bar. Scroll bars are used when the contents of a view require a greater area than can be physically displayed. Scroll bars allow a user to move different parts of the content into the view and to indicate what proportion of the total contents are visible at any one time.

Nested Classes and Structures

Public Member Functions
CEikScrollBar()
~CEikScrollBar()
IMPORT_C voidConstructL(MEikScrollBarObserver *, const CCoeControl *, TOrientation, TInt, TInt)
CAknScrollButton *DecreaseNudgeButton()
IMPORT_C TIntDefaultScrollBarBreadth()
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
CAknScrollButton *IncreaseNudgeButton()
IMPORT_C voidMakeVisible(TBool)
IMPORT_C TIntMinVisibleLength(const TInt)
const TEikScrollBarModel *Model()
IMPORT_C TIntScrollBarBreadth()
TScrollBarType ScrollBarType()
IMPORT_C voidSetAllButtonsDimmed(TBool)
IMPORT_C voidSetContainingCba(CEikCba *)
IMPORT_C voidSetDecreaseButtonsDimmed(TBool)
IMPORT_C voidSetExtensionAreaType(TScrollBarExtensionAreaType)
IMPORT_C voidSetFocusPosToThumbPos(TInt)
IMPORT_C voidSetIncreaseButtonsDimmed(TBool)
IMPORT_C voidSetLengthAndModelL(TInt, const TEikScrollBarModel *)
IMPORT_C voidSetLengthL(TInt)
IMPORT_C voidSetModel(const TEikScrollBarModel *)
IMPORT_C voidSetModelL(const TEikScrollBarModel *)
IMPORT_C voidSetModelThumbPosition(TInt)
voidSetScrollBarObserver(MEikScrollBarObserver *)
IMPORT_C TIntThumbPosition()
Protected Member Functions
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C TIntCountComponentControls()
voidCreateRequiredComponentsL()
voidDestroyButton(CAknScrollButton *&)
IMPORT_C voidSetButtonPositionL(CAknScrollButton *)
Private Member Functions
voidAddExternalFrameL(CEikScrollBarFrame *)
CEikCba *Cba()
IMPORT_C voidCreateButtonL(CAknScrollButton *&, CAknScrollButton::TType)
voidDisconnectExternalFrames()
voidDoSetModel(const TEikScrollBarModel *)
IMPORT_C void *ExtensionInterface(TUid)
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
voidRemoveExternalFrame(CEikScrollBarFrame *)
IMPORT_C voidReserved_2()
voidSizeChanged()
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
Public Member Enumerations
enumTEikScrollBarFlags {
EEikScrollBarDefaultBehaviour = SLafScrollBar::EEikScrollBarDefaultBehaviour, EEikScrollBarNoNudgeButtons = SLafScrollBar::EEikScrollBarNoNudgeButtons, EEikScrollBarHasPageButtons = SLafScrollBar::EEikScrollBarHasPageButtons, EEikScrollBarHasHomeEndButtons = SLafScrollBar::EEikScrollBarHasHomeEndButtons, EEikScrollBarNoShaftOrThumb = SLafScrollBar::EEikScrollBarNoShaftOrThumb, EEikScrollBarShaftButNoThumb = SLafScrollBar::EEikScrollBarShaftButNoThumb, EButtonsAtStartOfShaft = SLafScrollBar::EButtonsAtStartOfShaft, EButtonsAtEndOfShaft = SLafScrollBar::EButtonsAtEndOfShaft, EButtonsEitherSideOfShaft = SLafScrollBar::EButtonsEitherSideOfShaft, ENoAutoDimming = SLafScrollBar::ENoAutoDimming, EEnableNudgeButtons = 0x0200, EDisableExpandedTouchArea = 0x0400
}
enumTOrientation { EVertical = SLafScrollBar::EVertical, EHorizontal = SLafScrollBar::EHorizontal }
enumTScrollBarExtensionAreaType { ENormalExpandedTouchArea, EScaleExpandedTouchArea, ENoExpandedTouchArea }
enumTScrollBarType { ENormalScrollBar = 0x0, EArrowHead = 0x200, EDoubleSpan = 0x400 }
Protected Member Enumerations
enumTPointerDownOn {
ENone, EHomeButton, EDecreasePageButton, EDecreaseNudgeButton, EDecreaseShaft, EThumb, EIncreaseShaft, EIncreaseNudgeButton, EIncreasePageButton, EEndButton
}
enumTPrivateScrollBarFlags { ENoComponentsToDisplay = 0x10000, EIncreaseButtonsDimmed = 0x20000, EDecreaseButtonsDimmed = 0x40000 }
enumTShaftRedrawRequired { ENoRedrawRequired, ERedrawShaft }
enumTWhichButtons { EIncreaseOnly, EDecreaseOnly, EAll }
Inherited Enumerations
CCoeControl:TZoomType
Public Member Type Definitions
typedef TEikScrollBarFlags TAknScrollBarFlags
Public Attributes
TDblQueLink iSBLink
Protected Attributes
SEikScrollBarButtons iButtons
CEikScrollBarExtensionImpl *iExtension
TOrientation iOrientation
Private Attributes
TEikScrollBarModel iModel
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder

Constructor & Destructor Documentation

CEikScrollBar()

IMPORT_CCEikScrollBar()

C++ default constructor.

~CEikScrollBar()

IMPORT_C~CEikScrollBar()

Destructor.

Member Functions Documentation

AddExternalFrameL(CEikScrollBarFrame *)

voidAddExternalFrameL(CEikScrollBarFrame *aFrame)[private]

Parameters

CEikScrollBarFrame * aFrame

Cba()

CEikCba *Cba()const [private]

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.

The component control with an index of aIndex.

Parameters

TInt aIndexThe index of the control to get.

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.

Parameters

MEikScrollBarObserver * aScrollBarObserverThe scroll bar observer which is to be informed of scroll events by this scroll bar.
const CCoeControl * aParentParent control for this new scroll bar.
TOrientation aOrientationOrientation of the new scroll bar.
TInt aLengthNot used.
TInt aScrollBarFlags = EEikScrollBarDefaultBehaviourNot used.

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [protected, virtual]

From .

Gets the number of controls contained in this scrollbar.

The number of component controls contained by this scrollbar.

CreateButtonL(CAknScrollButton *&, CAknScrollButton::TType)

IMPORT_C voidCreateButtonL(CAknScrollButton *&aButton,
CAknScrollButton::TTypeaType
)[private, virtual]

Parameters

CAknScrollButton *& aButton
CAknScrollButton::TType aType

CreateRequiredComponentsL()

voidCreateRequiredComponentsL()[protected]

Allocates and constructs all the required components of the scrollbar.

DecreaseNudgeButton()

CAknScrollButton *DecreaseNudgeButton()const [inline]

Gets handle to the controls that draw arrows in the both ends of spanned scrollbar. These arrows are for pen support to enable exact moving of the scrollbar with pen. The arrow is tapped with the pen to move the scrollbar with one step.

Pointer to the decreace button.

DefaultScrollBarBreadth()

IMPORT_C TIntDefaultScrollBarBreadth()[static]

Gets the default width of the scroll bar.

Default scroll bar breadth.

DestroyButton(CAknScrollButton *&)

voidDestroyButton(CAknScrollButton *&aButton)[protected]

Destroys a button.

Parameters

CAknScrollButton *& aButtonA button that will be destroyed.

DisconnectExternalFrames()

voidDisconnectExternalFrames()[private]

DoSetModel(const TEikScrollBarModel *)

voidDoSetModel(const TEikScrollBarModel *aModel)[private]

Parameters

const TEikScrollBarModel * aModel

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)[private, virtual]

Parameters

CCoeControl * aControl
TCoeEvent aEventType

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl

Called by the framework to handle pointer events.

Parameters

const TPointerEvent & aPointerEventA pointer event.

IncreaseNudgeButton()

CAknScrollButton *IncreaseNudgeButton()const [inline]

Gets handle to the controls that draw arrows in the both ends of spanned scrollbar. These arrows are for pen support to enable exact moving of the scrollbar with pen. The arrow is tapped with the pen to move the scrollbar with one step.

Pointer to the increace button.

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.

Parameters

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

MinVisibleLength(const TInt)

IMPORT_C TIntMinVisibleLength(const TIntaScrollBarFlags)[static]

Not implemented.

Zero.

Parameters

const TInt aScrollBarFlagsNot used.

Model()

const TEikScrollBarModel *Model()const [inline]

Gets the scroll bar model used by this scroll bar.

RemoveExternalFrame(CEikScrollBarFrame *)

voidRemoveExternalFrame(CEikScrollBarFrame *aFrame)[private]

Parameters

CEikScrollBarFrame * aFrame

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

ScrollBarBreadth()

IMPORT_C TIntScrollBarBreadth()const

Gets the height of a horizontal scrollbar or width of a vertical scrollbar.

Scroll bar breadth.

ScrollBarType()

TScrollBarType ScrollBarType()

Gets the scroll bar type.

Value of the enum TScrollBarType.

SetAllButtonsDimmed(TBool)

IMPORT_C voidSetAllButtonsDimmed(TBoolaDimmed)

Not implemented.

Parameters

TBool aDimmedNot used.

SetButtonPositionL(CAknScrollButton *)

IMPORT_C voidSetButtonPositionL(CAknScrollButton *aButton)[protected, virtual]

Not implemented

Parameters

CAknScrollButton * aButtonNot used.

SetContainingCba(CEikCba *)

IMPORT_C voidSetContainingCba(CEikCba *aCba)

Sets command button area. This function should only be used by CEikCba.

panic

EEikPanicScrollBarExtensionNotCreated Extension of the scroll bar not created.

Parameters

CEikCba * aCbaCommand button area.

SetDecreaseButtonsDimmed(TBool)

IMPORT_C voidSetDecreaseButtonsDimmed(TBoolaDimmed)

Not implemented.

Parameters

TBool aDimmedNot used.

SetExtensionAreaType(TScrollBarExtensionAreaType)

IMPORT_C voidSetExtensionAreaType(TScrollBarExtensionAreaTypeaType)

Not implemented.

Parameters

TScrollBarExtensionAreaType aTypeThe extension area to use.

SetFocusPosToThumbPos(TInt)

IMPORT_C voidSetFocusPosToThumbPos(TIntaFocusPosition)

Not implemented.

Parameters

TInt aFocusPositionNot used.

SetIncreaseButtonsDimmed(TBool)

IMPORT_C voidSetIncreaseButtonsDimmed(TBoolaDimmed)

Not implemented.

Parameters

TBool aDimmedNot used.

SetLengthAndModelL(TInt, const TEikScrollBarModel *)

IMPORT_C voidSetLengthAndModelL(TIntaLength,
const TEikScrollBarModel *aModel
)

Change the model at once to avoid a double update of the scroll bar.

Parameters

TInt aLengthNot used.
const TEikScrollBarModel * aModelNew scroll bar model.

SetLengthL(TInt)

IMPORT_C voidSetLengthL(TIntaLength)

Not implemented.

Parameters

TInt aLengthNot used.

SetModel(const TEikScrollBarModel *)

IMPORT_C voidSetModel(const TEikScrollBarModel *aModel)

Change the scrollbar model.

Parameters

const TEikScrollBarModel * aModelThe new model to use.

SetModelL(const TEikScrollBarModel *)

IMPORT_C voidSetModelL(const TEikScrollBarModel *aModel)

Change the scrollbar model.

Parameters

const TEikScrollBarModel * aModelThe new model to use.

SetModelThumbPosition(TInt)

IMPORT_C voidSetModelThumbPosition(TIntaThumbPos)

Not implemented.

Parameters

TInt aThumbPosNot used.

SetScrollBarObserver(MEikScrollBarObserver *)

voidSetScrollBarObserver(MEikScrollBarObserver *aScrollBarObserver)

Allows scroll bar observer to be changed also after the construction. This function is not exported, but the applications can use it via CEikScrollBarFrame::SetScrollBarFrameObserver function.

Parameters

MEikScrollBarObserver * aScrollBarObserverNew observer replacing the previous (if any).

SizeChanged()

voidSizeChanged()[private, virtual]

ThumbPosition()

IMPORT_C TIntThumbPosition()const

Gets the position within the scroll bar model. This function would normally be called by an MEikScrollBarObserver implementation in response to a scroll bar event.

Current position within the scroll bar model s range.

Member Enumerations Documentation

Enum TEikScrollBarFlags

Scroll bar initialisation flags. The default is for the scroll bar to have both a shaft and a thumb.

Enumerators

EEikScrollBarDefaultBehaviour = SLafScrollBar::EEikScrollBarDefaultBehaviour
EEikScrollBarNoNudgeButtons = SLafScrollBar::EEikScrollBarNoNudgeButtons

Does not display nudge buttons.

EEikScrollBarHasPageButtons = SLafScrollBar::EEikScrollBarHasPageButtons

Has buttons which move it a page at a time.

EEikScrollBarHasHomeEndButtons = SLafScrollBar::EEikScrollBarHasHomeEndButtons

Has buttons which move it its entire extent.

EEikScrollBarNoShaftOrThumb = SLafScrollBar::EEikScrollBarNoShaftOrThumb

Central area is empty.

EEikScrollBarShaftButNoThumb = SLafScrollBar::EEikScrollBarShaftButNoThumb

Central area has no scroll thumb.

EButtonsAtStartOfShaft = SLafScrollBar::EButtonsAtStartOfShaft

Buttons are placed at the start of the bar.

EButtonsAtEndOfShaft = SLafScrollBar::EButtonsAtEndOfShaft

Buttons are placed at the end of the bar.

EButtonsEitherSideOfShaft = SLafScrollBar::EButtonsEitherSideOfShaft

Buttons are placed at either end of the bar (EButtonsAtStartOfShaft | EButtonsAtEndOfShaft).

ENoAutoDimming = SLafScrollBar::ENoAutoDimming

Buttons do not automatically dim when scroll bar is at its maximum extent.

EEnableNudgeButtons = 0x0200

Enable the nudge buttons.

EDisableExpandedTouchArea = 0x0400

Disable the expanded touch area.

Enum TOrientation

Scroll bar orientation.

Enumerators

EVertical = SLafScrollBar::EVertical

Scroll bar is oriented vertically.

EHorizontal = SLafScrollBar::EHorizontal

Scroll bar is oriented horizontally.

Enum TPointerDownOn

Determines where on a scroll bar a pointer down event occurred.

Enumerators

ENone

No pointer down event occurred on the scroll bar.

EHomeButton

A pointer down event occurred on the home button.

EDecreasePageButton

A pointer down event occurred on the decrease page button.

EDecreaseNudgeButton

A pointer down event occurred on the decrease nudge button.

EDecreaseShaft

A pointer down event occurred on the decrease shaft button.

EThumb

A pointer down event occurred on the scroll bar thumb.

EIncreaseShaft

A pointer down event occurred on the increase shaft button.

EIncreaseNudgeButton

A pointer down event occurred on the increase nudge button.

EIncreasePageButton

A pointer down event occurred on the increase page button.

EEndButton

A pointer down event occurred on the end button.

Enum TPrivateScrollBarFlags

Flags to determine whether there are visible components and whether to dim the increase, or decrease, buttons.

Enumerators

ENoComponentsToDisplay = 0x10000

There are no visible components in the scroll bar.

EIncreaseButtonsDimmed = 0x20000

Dim the increase buttons.

EDecreaseButtonsDimmed = 0x40000

Dim the decrease buttons.

Enum TScrollBarExtensionAreaType

Type of the scroll extension area.

Enumerators

ENormalExpandedTouchArea

Normal scrollbar extension area.

EScaleExpandedTouchArea

Scale scrollbar extension area.

ENoExpandedTouchArea

none scrollbar extension area.

Enum TScrollBarType

Type of the scroll bar.

Enumerators

ENormalScrollBar = 0x0

Normal scrollbar.

EArrowHead = 0x200

Used scrollbar type is an old one. (arrows in the CBA-area)

EDoubleSpan = 0x400

The created scrollbar is the current and commonly used in Series 60 platform, spanned scrollbar. (scrollable bar on the right side of the control, like in windows etc.).

Enum TShaftRedrawRequired

Determines whether to redraw the scroll bar shaft.

Enumerators

ENoRedrawRequired

Do not redraw the scroll bar shaft.

ERedrawShaft

Redraw the scroll bar shaft.

Enum TWhichButtons

Determines which buttons are displayed.

Enumerators

EIncreaseOnly

Display the increase buttons only.

EDecreaseOnly

Display the decrease buttons only.

EAll

Display all buttons.

Member Type Definitions Documentation

Typedef TAknScrollBarFlags

typedef TEikScrollBarFlags TAknScrollBarFlags

Member Data Documentation

SEikScrollBarButtons iButtons

SEikScrollBarButtons iButtons[protected]

Scroll bar buttons struct.

CEikScrollBarExtensionImpl * iExtension

CEikScrollBarExtensionImpl *iExtension[protected]

A pointer to CEikScrollBarExtensionImpl class.

TEikScrollBarModel iModel

TEikScrollBarModel iModel[private]

TOrientation iOrientation

TOrientation iOrientation[protected]

Scroll bar orientation.

TDblQueLink iSBLink

TDblQueLink iSBLink

Not used, but cannot be removed due binary compatibility issues.