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.

Constructor & Destructor Documentation

TEikScrollBarModel()

TEikScrollBarModel()[inline]

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

TEikScrollBarModel(TInt, TInt, TInt)

IMPORT_CTEikScrollBarModel(TIntaScrollSpan,
TIntaThumbSpan = 0,
TIntaThumbPosition = 0
)

Constructor. Creates, allocates and initialises a new TEikScrollBarModel.

Parameters

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

Member Functions Documentation

CheckBounds()

IMPORT_C voidCheckBounds()

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

MaxThumbPos()

IMPORT_C TIntMaxThumbPos()const

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

Maximum value possible for iThumbPosition.

ScrollBarModelType()

TEikScrollBarModel::TEikScrollBarModelType ScrollBarModelType()const

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

ScrollBarUseful()

IMPORT_C TBoolScrollBarUseful()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.

Whether this scroll bar can be used.

operator!=(const TEikScrollBarModel)

TBool operator!=(const TEikScrollBarModelaModel)const [inline]

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

ETrue if the two models are not equal.

Parameters

const TEikScrollBarModel aModel

operator==(const TEikScrollBarModel)

IMPORT_C TBooloperator==(const TEikScrollBarModelaModel)const

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

ETrue if the two models are equal.

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.