CAknDoubleSpanScrollBar Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikscrlb.h>

Inherits CEikScrollBar.

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.


Public Member Functions
IMPORT_C	CAknDoubleSpanScrollBar (CCoeControl *aParentWindow)
IMPORT_C	~CAknDoubleSpanScrollBar ()
IMPORT_C void	SetFixedLayoutRect (TRect aScrollBarRect)
	Sets fixed layout to scrollbar.
IMPORT_C void	ConstructL (TBool aWindowOwning, MEikScrollBarObserver aScrollBarObserver, const CCoeControl aParent, TOrientation aOrientation, TInt aLength, TInt aScrollBarFlags=EEikScrollBarDefaultBehaviour)
	Method for constructing the object.
IMPORT_C void	SetScrollPopupInfoTextL (const TDesC &aText)
	Sets scroll popup info text to be shown while dragging with stylus.
TRect	FixedLayoutRect ()
	Gets the fixed layoutrect of the scrollbar.
IMPORT_C void	ConstructL (MEikScrollBarObserver aScrollBarObserver, const CCoeControl aParent, TOrientation aOrientation, TInt aLength, TInt aScrollBarFlags=EEikScrollBarDefaultBehaviour)
IMPORT_C void	MakeVisible (TBool aVisible)
	From `CCoeControl`.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From `CCoeControl`.
TBool	DrawBackgroundState ()
void	DrawBackground (TBool aDrawHorizontal)
Protected Member Functions
IMPORT_C CCoeControl *	ComponentControl (TInt aIndex) const
	From `CCoeControl`.
IMPORT_C TInt	CountComponentControls () const
	From .

Constructor & Destructor Documentation

IMPORT_C CAknDoubleSpanScrollBar::CAknDoubleSpanScrollBar

(

CCoeControl *

aParentWindow

)

IMPORT_C CAknDoubleSpanScrollBar::~CAknDoubleSpanScrollBar

(

)

Member Function Documentation

IMPORT_C CCoeControl* CAknDoubleSpanScrollBar::ComponentControl ( TInt aIndex ) const [protected]

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:

aIndex

The index of the control to get.

Returns:: The component control with an index of aIndex.

Reimplemented from CEikScrollBar.

IMPORT_C void CAknDoubleSpanScrollBar::ConstructL	(	MEikScrollBarObserver *	aScrollBarObserver,
		const CCoeControl *	aParent,
		TOrientation	aOrientation,
		TInt	aLength,
		TInt	aScrollBarFlags = `EEikScrollBarDefaultBehaviour`
	)

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

Method for constructing the object.

Parameters:

	aWindowOwning	True if scrollbar is to be a window owning control.
	aScrollBarObserver	Same as in CEikScrollBar::ConstructL()
	aParent	Same as in CEikScrollBar::ConstructL()
	aOrientation	Same as in CEikScrollBar::ConstructL()
	aLength	Same as in CEikScrollBar::ConstructL()
	aScrollBarFlags	Same as in CEikScrollBar::ConstructL()

IMPORT_C TInt CAknDoubleSpanScrollBar::CountComponentControls ( ) const [protected]

From .

Gets the number of controls contained in this scrollbar.

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

Reimplemented from CEikScrollBar.

void CAknDoubleSpanScrollBar::DrawBackground

(

TBool

aDrawHorizontal

)

TBool CAknDoubleSpanScrollBar::DrawBackgroundState

(

)

TRect CAknDoubleSpanScrollBar::FixedLayoutRect

(

)

Gets the fixed layoutrect of the scrollbar.

Returns:: Scrollbar rectangle.

IMPORT_C void CAknDoubleSpanScrollBar::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Called by the framework to handle pointer events.

Parameters:

aPointerEvent

A pointer event.

Reimplemented from CEikScrollBar.

IMPORT_C void CAknDoubleSpanScrollBar::MakeVisible

(

TBool

aVisible

)

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:

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

Reimplemented from CEikScrollBar.

IMPORT_C void CAknDoubleSpanScrollBar::SetFixedLayoutRect

(

TRect

aScrollBarRect

)

Sets fixed layout to scrollbar.

If set, then scrollbar size changes done by the CEikScrollBarFrame class are disabled.

Parameters:

aScrollBarRect

Scrollbar rectangle.

IMPORT_C void CAknDoubleSpanScrollBar::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.

Parameters:

aText

Text to be shown

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

eikscrlb.h

CAknDoubleSpanScrollBar Class Reference

Capability Information

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation