Collapse all Symbian^3 Product Developer Library

TEikScrollBarModel Class Reference

class TEikScrollBarModel

Scroll bar models encapsulate the range of integers which a scroll bar can represent, from zero to n, and the current position of the scroll bar thumb within that range.

Supported from Symbian 5.0.

Public Member Functions
	TEikScrollBarModel()
	TEikScrollBarModel(TInt, TInt, TInt)
IMPORT_C void	CheckBounds()
IMPORT_C TInt	MaxThumbPos()
TEikScrollBarModel::TEikScrollBarModelType	ScrollBarModelType()
IMPORT_C TBool	ScrollBarUseful()
TBool	operator!=(const TEikScrollBarModel)
IMPORT_C TBool	operator==(const TEikScrollBarModel)

Public Member Enumerations
enum	TEikScrollBarModelType { EEikScrollBarModel = 0x00000000, EAknDoubleSpanScrollBarModel = 0x80000000 }

Public Attributes
TInt	iScrollSpan
TInt	iThumbPosition
TInt	iThumbSpan

Constructor & Destructor Documentation

TEikScrollBarModel()

TEikScrollBarModel

(

)

[inline]

C++ default constructor. Creates, allocates and initialises a new TEikScrollBarModel.

TEikScrollBarModel(TInt, TInt, TInt)

IMPORT_C	TEikScrollBarModel	(	TInt	aScrollSpan,
			TInt	aThumbSpan = 0,
			TInt	aThumbPosition = 0
		)

Constructor. Creates, allocates and initialises a new TEikScrollBarModel.

Parameters

TInt aScrollSpan	The span of this model, numbered from zero.
TInt aThumbSpan = 0	Number of positions spanned by the thumb.In default this is zero.
TInt aThumbPosition = 0	Position of the thumb within the model span. In default this is zero.

Member Functions Documentation

CheckBounds()

IMPORT_C void

CheckBounds

(

)

Ensures that the thumb position remains within its valid range by altering it if necessary.

MaxThumbPos()

IMPORT_C TInt

MaxThumbPos

(

)

const

Gets the maximum position possible for the low edge of the thumb within the total span.

ScrollBarModelType()

TEikScrollBarModel::TEikScrollBarModelType

ScrollBarModelType

(

)

const

Gets type of scroll bar model which is one of the enum values from TEikScrollBarModelType enum.

ScrollBarUseful()

IMPORT_C TBool

ScrollBarUseful

(

)

const

Tests whether the scroll bar model is useful. Scroll bar models are only useful if their thumb span is smaller than their entire span.

operator!=(const TEikScrollBarModel)

TBool

operator!=

(

const TEikScrollBarModel

aModel

)

const [inline]

Tests two models for inequality. The two models are the current model and the model specified by aModel.

Parameters

const TEikScrollBarModel aModel

operator==(const TEikScrollBarModel)

IMPORT_C TBool

operator==

(

const TEikScrollBarModel

aModel

)

const

Tests two models for equality. The two models are the current model and the model specified by aModel.

Parameters

const TEikScrollBarModel aModel

Member Enumerations Documentation

Enum TEikScrollBarModelType

Type of scroll bar model. The different models store the scrolling information in different way, so correct model must be used with correct scrollbar type.

Enumerators

EEikScrollBarModel = 0x00000000	This model type is for storing data for the arrowhead scrollbar.
EAknDoubleSpanScrollBarModel = 0x80000000	This model type is for storing data for the spanned scrollbar.

Member Data Documentation

TInt iScrollSpan

TInt	iScrollSpan

Entire range of integers for this model.

TInt iThumbPosition

TInt	iThumbPosition

Position of the low edge of the thumb within 0...iScrollSpan.

TInt iThumbSpan

TInt	iThumbSpan

Range spanned by the thumb.