CAknScrollButton Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <aknscbut.h>

Inherits CAknControl.

Detailed Description

Implements a scroll buttons of a scroll bar.


Public Types
enum	TType { ENudgeLeft, ENudgeUp, ENudgeRight, ENudgeDown, EPageLeft, EPageUp, EPageRight, EPageDown, EHome, ETop, EEnd, EBottom }
	Indicates a Scroll button's type. More...
enum	TTypeOfScrollBar { ENormal = 0x00, EArrowHead = 0x01 }
	Indicates a scroll bar's type. More...
Public Member Functions
IMPORT_C	~CAknScrollButton ()
	Destructor.
IMPORT_C TType	Type () const
	Gets a scroll button's type.
IMPORT_C void	CreateWindowOnlyForArrowsL (const CCoeControl *aParent)
	Creates a window only for arrows.
IMPORT_C TBool	IsNormalScrollBarUsingButton () const
	Determines whether a scroll button is owned by normal scroll bar.
IMPORT_C void	SetTypeOfScrollBarUsingButton (TTypeOfScrollBar aTypeOfScrollBar)
	Sets the type of scroll bar which owns the button.
IMPORT_C void	SetPosition (const TInt aFocusPosition, const TInt aScrollSpan)
	Sets the new focus position in the control and the span length.
void	SetContainerWindowL (const CCoeControl &aControl)
TInt	CountComponentControls () const
CCoeControl *	ComponentControl (TInt aIndex) const
Static Public Member Functions
static IMPORT_C CAknScrollButton *	NewL (TType aType)
	Two-phased constructor.
static IMPORT_C CAknScrollButton *	NewL (TType aType, TTypeOfScrollBar aTypeOfScrollBar)
	Two-phased constructor.
Friends
class	CAknScrollBar

Member Enumeration Documentation

enum CAknScrollButton::TType

Indicates a Scroll button's type.

Enumerator:

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 CAknScrollButton::TTypeOfScrollBar

Indicates a scroll bar's type.

Enumerator:

ENormal	Normal scroll bar.
EArrowHead	Arrow headed scroll bar.

Constructor & Destructor Documentation

IMPORT_C CAknScrollButton::~CAknScrollButton

(

)

Destructor.

Member Function Documentation

CCoeControl* CAknScrollButton::ComponentControl

(

TInt

aIndex

)

const

TInt CAknScrollButton::CountComponentControls

(

)

const

IMPORT_C void CAknScrollButton::CreateWindowOnlyForArrowsL

(

const CCoeControl *

aParent

)

Creates a window only for arrows.

Sets the container window to be this class.

Parameters:

aParent

The control to be the parent of this control.

IMPORT_C TBool CAknScrollButton::IsNormalScrollBarUsingButton

(

)

const

Determines whether a scroll button is owned by normal scroll bar.

Returns:: ETrue if a scroll button is owned by the normal scroll bar, EFalse if not

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

Two-phased constructor.

Parameters:

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

Returns:: A fully constructed CAknScrollButton object.

static IMPORT_C CAknScrollButton* CAknScrollButton::NewL ( TType aType ) [static]

Two-phased constructor.

Parameters:

aType

scroll button's type.

Returns:: A fully constructed CAknScrollButton object.

void CAknScrollButton::SetContainerWindowL

(

const CCoeControl &

aControl

)

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

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

Parameters:

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

IMPORT_C void CAknScrollButton::SetTypeOfScrollBarUsingButton

(

TTypeOfScrollBar

aTypeOfScrollBar

)

Sets the type of scroll bar which owns the button.

Parameters:

aTypeOfScrollBar

The type of the scroll bar.

IMPORT_C TType CAknScrollButton::Type

(

)

const

Gets a scroll button's type.

Returns:: The scroll button's type.

Friends And Related Function Documentation

friend class CAknScrollBar [friend]

The documentation for this class was generated from the following file:

aknscbut.h

CAknScrollButton Class Reference

Capability Information

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation