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 |
TEikScrollBarModel | ( | ) | [inline] |
C++ default constructor. Creates, allocates and initialises a new TEikScrollBarModel.
IMPORT_C | TEikScrollBarModel | ( | TInt | aScrollSpan, |
TInt | aThumbSpan = 0, | |||
TInt | aThumbPosition = 0 | |||
) |
Constructor. Creates, allocates and initialises a new TEikScrollBarModel.
IMPORT_C void | CheckBounds | ( | ) |
Ensures that the thumb position remains within its valid range by altering it if necessary.
IMPORT_C TInt | MaxThumbPos | ( | ) | const |
Gets the maximum position possible for the low edge of the thumb within the total span.
Maximum value possible for iThumbPosition.
TEikScrollBarModel::TEikScrollBarModelType | ScrollBarModelType | ( | ) | const |
Gets type of scroll bar model which is one of the enum values from TEikScrollBarModelType enum.
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.
Whether this scroll bar can be used.
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.
ETrue if the two models are not equal.
const TEikScrollBarModel aModel |
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.
ETrue if the two models are equal.
const TEikScrollBarModel aModel |
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.
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. |
TInt | iThumbPosition |
Position of the low edge of the thumb within 0...iScrollSpan.