CAknScrollButton Class Reference

class CAknScrollButton : public CAknControl

Implements a scroll buttons of a scroll bar.

Series 60 0.9

Inherits from

CAknScrollButton
- CAknControl
  - CCoeControl
    - CBase

Public Member Functions
	~CAknScrollButton()
CCoeControl *	ComponentControl(TInt)
TInt	CountComponentControls()
IMPORT_C void	CreateWindowOnlyForArrowsL(const CCoeControl *)
IMPORT_C TBool	IsNormalScrollBarUsingButton()
IMPORT_C CAknScrollButton *	NewL(TType)
IMPORT_C CAknScrollButton *	NewL(TType, TTypeOfScrollBar)
void	SetContainerWindowL(const CCoeControl &)
IMPORT_C void	SetPosition(const TInt, const TInt)
IMPORT_C void	SetTypeOfScrollBarUsingButton(TTypeOfScrollBar)
IMPORT_C TType	Type()

Private Member Functions
	CAknScrollButton(TType)
void	ConstructL()
void	ConstructL(TTypeOfScrollBar)
void	Draw(const TRect &)
void	DrawIndicator()
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::GetColorUseListL(CArrayFix< TCoeColorUse > &)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::HandlePointerEventL(const TPointerEvent &)
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HandleResourceChange(TInt)
	CCoeControl::HasBorder()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::MakeVisible(TBool)
	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::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	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::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Public Member Enumerations
enum	TType { ENudgeLeft, ENudgeUp, ENudgeRight, ENudgeDown, EPageLeft, EPageUp, EPageRight, EPageDown, EHome, ETop, EEnd, EBottom }
enum	TTypeOfScrollBar { ENormal = 0x00, EArrowHead = 0x01 }

Inherited Enumerations
	CCoeControl:TZoomType

Private Attributes
TInt	iFlag
TRect	iOldRect
CAknScrollIndicator *	iScrollIndicator
TType	iType

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Constructor & Destructor Documentation

CAknScrollButton(TType)

CAknScrollButton

(

TType

aType

)

[private]

Parameters

TType aType

~CAknScrollButton()

IMPORT_C

~CAknScrollButton

(

)

Destructor.

Member Functions Documentation

ComponentControl(TInt)

CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [virtual]

Parameters

TInt aIndex

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(TTypeOfScrollBar)

void

ConstructL

(

TTypeOfScrollBar

aTypeOfScrollBar

)

[private]

Parameters

TTypeOfScrollBar aTypeOfScrollBar

CountComponentControls()

TInt

CountComponentControls

(

)

const [virtual]

CreateWindowOnlyForArrowsL(const CCoeControl *)

IMPORT_C void

CreateWindowOnlyForArrowsL

(

const CCoeControl *

aParent

)

Creates a window only for arrows. Sets the container window to be this class.

Parameters

const CCoeControl * aParent

The control to be the parent of this control.

Draw(const TRect &)

void

Draw

(

const TRect &

aRect

)

const [private, virtual]

Parameters

const TRect & aRect

DrawIndicator()

void

DrawIndicator

(

)

const [private]

IsNormalScrollBarUsingButton()

IMPORT_C TBool

IsNormalScrollBarUsingButton

(

)

const

Determines whether a scroll button is owned by normal scroll bar. ETrue if a scroll button is owned by the normal scroll bar, EFalse if not

NewL(TType)

IMPORT_C CAknScrollButton *

NewL

(

TType

aType

)

[static]

Two-phased constructor. A fully constructed CAknScrollButton object.

Parameters

TType aType

scroll button's type.

NewL(TType, TTypeOfScrollBar)

IMPORT_C CAknScrollButton *	NewL	(	TType	aType,
			TTypeOfScrollBar	aTypeOfScrollBar
		)	[static]

Two-phased constructor. A fully constructed CAknScrollButton object.

Parameters

TType aType	scroll button's type.
TTypeOfScrollBar aTypeOfScrollBar	scroll bar type, this information is needed at construction time when creating button for double span scroll bar (ie. the parameter is ENormal)

SetContainerWindowL(const CCoeControl &)

void

SetContainerWindowL

(

const CCoeControl &

aControl

)

[virtual]

Parameters

const CCoeControl & aControl

SetPosition(const TInt, const TInt)

IMPORT_C void	SetPosition	(	const TInt	aFocusPosition,
			const TInt	aScrollSpan
		)

Sets the new focus position in the control and the span length.

Parameters

const TInt aFocusPosition	The new focus position.
const TInt aScrollSpan	The new span length.

SetTypeOfScrollBarUsingButton(TTypeOfScrollBar)

IMPORT_C void

SetTypeOfScrollBarUsingButton

(

TTypeOfScrollBar

aTypeOfScrollBar

)

Sets the type of scroll bar which owns the button.

Parameters

TTypeOfScrollBar aTypeOfScrollBar

The type of the scroll bar.

SizeChanged()

void

SizeChanged

(

)

[private, virtual]

Type()

IMPORT_C TType

Type

(

)

const

Gets a scroll button's type. The scroll button's type.

Member Enumerations Documentation

Enum TType

Indicates a Scroll button's type

Enumerators

ENudgeLeft	Scroll button to move the display to the left.
ENudgeUp	Scroll button to move the display up.
ENudgeRight	Scroll button to move the display to the right.
ENudgeDown	Scroll button to move the display down.
EPageLeft	Scroll button to move the display page to the left.
EPageUp	Scroll button to move the display page up.
EPageRight	Scroll button to move the display page to the right.
EPageDown	Scroll button to move the display page down.
EHome	Scroll button to move the display to the home position.
ETop	Scroll button to move the display to the top.
EEnd	Scroll button to move the display to the end position.
EBottom	Scroll button to move the display to the bottom.

Enum TTypeOfScrollBar

Indicates a scroll bar's type.

Enumerators

ENormal = 0x00	Normal scroll bar
EArrowHead = 0x01	Arrow headed scroll bar

Member Data Documentation

TInt iFlag

TInt

iFlag

[private]

TRect iOldRect

TRect

iOldRect

[private]

CAknScrollIndicator * iScrollIndicator

CAknScrollIndicator *

iScrollIndicator

[private]

TType iType

TType

iType

[private]