Symbian^3 Application Developer Library >

TAknDoubleSpanScrollBarModel Class Reference

class TAknDoubleSpanScrollBarModel : public TEikScrollBarModel

Inherits from

Public Member Functions
TAknDoubleSpanScrollBarModel ()
TAknDoubleSpanScrollBarModel (const TEikScrollBarModel &)
IMPORT_C TInt FieldPosition ()
IMPORT_C TInt FieldSize ()
IMPORT_C TInt FocusPosition ()
TBool ModelIsSupported ()
IMPORT_C TInt ScrollSpan ()
IMPORT_C void SetFieldPosition ( TInt )
IMPORT_C void SetFieldSize ( TInt )
IMPORT_C void SetFocusPosition ( TInt )
IMPORT_C void SetScrollSpan ( TInt )
IMPORT_C void SetWindowSize ( TInt )
IMPORT_C TInt WindowSize ()
Private Member Functions
TInt CheckMinMaxValue ( TInt )
TInt16 FieldPositionValue ()
TInt16 FieldSizeValue ()
TInt16 FocusPositionValue ()
TInt16 HighBytes ( TInt )
TInt16 LowBytes ( TInt )
TInt16 PrepareScaledValue ( TInt )
void ReScale ( TUint16 )
TUint16 Scale ()
TInt16 ScrollSpanValue ()
void SetFieldPositionValue ( TInt16 )
void SetFieldSizeValue ( TInt16 )
void SetFocusPositionValue ( TInt16 )
void SetHighBytes ( TInt &, TInt16 )
void SetLowBytes ( TInt &, TInt16 )
void SetScale ( TUint16 )
void SetScrollBarModelType ( TEikScrollBarModelType )
void SetScrollSpanValue ( TInt16 )
void SetWindowSizeValue ( TInt16 )
TInt16 WindowSizeValue ()
Inherited Functions
TEikScrollBarModel::CheckBounds()
TEikScrollBarModel::MaxThumbPos()const
TEikScrollBarModel::ScrollBarModelType()const
TEikScrollBarModel::ScrollBarUseful()const
TEikScrollBarModel::TEikScrollBarModel()
TEikScrollBarModel::TEikScrollBarModel(TInt,TInt,TInt)
TEikScrollBarModel::operator!=(const TEikScrollBarModel)const
TEikScrollBarModel::operator==(const TEikScrollBarModel)const
Inherited Enumerations
TEikScrollBarModel:TEikScrollBarModelType
Inherited Attributes
TEikScrollBarModel::iScrollSpan
TEikScrollBarModel::iThumbPosition
TEikScrollBarModel::iThumbSpan

Constructor & Destructor Documentation

TAknDoubleSpanScrollBarModel()

IMPORT_C TAknDoubleSpanScrollBarModel ( )

Default constructor.

TAknDoubleSpanScrollBarModel(const TEikScrollBarModel &)

IMPORT_C TAknDoubleSpanScrollBarModel ( const TEikScrollBarModel & aEikModel )

Constructor which converts TEikScrollBarModel into TAknDoubleSpanScrollBarModel .

Since
2.6
Allowed range for TEikScrollBarModel values is from 0x1FFF7FFF to -0x1FFF7FFF. Values outside the allowed range will be truncated to max or min value. Value will be internally stored with 15 bit accuracy, this means that the actual stored value may differ from the value given as parameter.

Values will be converted as:

TEikScrollBarModel TAknDoubleSpanScrollBarModel ------------------ ---------------------------- iScrollSpan -> ScrollSpan iThumbPosition -> FocusPosition iThumbSpan -> WindowSize 0 -> FieldPosition 0 -> FieldSize

Values will be internally stored with 15 bit accuracy, this means that the actual stored value may differ from the value given inside parameter.

Parameters

const TEikScrollBarModel & aEikModel a model that will be converted.

Member Functions Documentation

CheckMinMaxValue(TInt)

TInt CheckMinMaxValue ( TInt aValue ) [private]

Checks if given parameter is between internal min and max values.

Since
2.6

Parameters

TInt aValue Value to be checked.

FieldPosition()

IMPORT_C TInt FieldPosition ( ) const

FieldPositionValue()

TInt16 FieldPositionValue ( ) const [private]

FieldSize()

IMPORT_C TInt FieldSize ( ) const

FieldSizeValue()

TInt16 FieldSizeValue ( ) const [private]

FocusPosition()

IMPORT_C TInt FocusPosition ( ) const

FocusPositionValue()

TInt16 FocusPositionValue ( ) const [private]

HighBytes(TInt)

TInt16 HighBytes ( TInt aInt ) const [private]

Gets two highest bytes from TInt and constructs TInt16 from those.

Since
2.6

Parameters

TInt aInt Value from which the highest bytes are extracted.

LowBytes(TInt)

TInt16 LowBytes ( TInt aInt ) const [private]

Gets two lowest bytes from TInt and constructs TInt16 from those.

Since
2.6

Parameters

TInt aInt Value from which the lowest bytes are extracted.

ModelIsSupported()

TBool ModelIsSupported ( ) [static]

This method can be used to query if this model type is supported by the device. If model is not supported then this model and the behaviour of ALL methods defaults to TEikScrollBarModel behaviour with following rules:

TAknDoubleSpanScrollBarModel TEikScrollBarModel ---------------------------- ------------------ ScrollSpan methods -> iScrollSpan FocusPosition methods -> iThumbPosition WindowSize methods -> iThumbSize FieldPosition methods -> N/A FieldSize methods -> N/A

Since
2.6

PrepareScaledValue(TInt)

TInt16 PrepareScaledValue ( TInt aNonScaledValue ) [private]

Constructs a scaled TInt16 value from given TInt value. Changes internal member variable values using ReScale() -method if needed.

Since
2.6

Parameters

TInt aNonScaledValue Value which will be changed to scaled one.

ReScale(TUint16)

void ReScale ( TUint16 aNewScale ) [private]

Changes the used scale value and updates all stored attribute values if needed.

Since
2.6

Parameters

TUint16 aNewScale New value to be used scaling.

Scale()

TUint16 Scale ( ) const [private]

Gets the internal scale value.

Since
2.6

ScrollSpan()

IMPORT_C TInt ScrollSpan ( ) const

Get methods for model attributes. These MUST be used instead of getting base class model values directly.

Since
2.6

ScrollSpanValue()

TInt16 ScrollSpanValue ( ) const [private]

Get methods for model attributes values without scaling.

Since
2.6

SetFieldPosition(TInt)

IMPORT_C void SetFieldPosition ( TInt aValue )

Parameters

TInt aValue

SetFieldPositionValue(TInt16)

void SetFieldPositionValue ( TInt16 aValue ) [private]

Parameters

TInt16 aValue

SetFieldSize(TInt)

IMPORT_C void SetFieldSize ( TInt aValue )

Parameters

TInt aValue

SetFieldSizeValue(TInt16)

void SetFieldSizeValue ( TInt16 aValue ) [private]

Parameters

TInt16 aValue

SetFocusPosition(TInt)

IMPORT_C void SetFocusPosition ( TInt aValue )

Parameters

TInt aValue

SetFocusPositionValue(TInt16)

void SetFocusPositionValue ( TInt16 aValue ) [private]

Parameters

TInt16 aValue

SetHighBytes(TInt &, TInt16)

void SetHighBytes ( TInt & aInt,
TInt16 aValue
) [private]

Sets two highest bytes of TInt.

Since
2.6

Parameters

TInt & aInt TInt of which the highest bytes are set.
TInt16 aValue Value for the highest bytes.

SetLowBytes(TInt &, TInt16)

void SetLowBytes ( TInt & aInt,
TInt16 aValue
) [private]

Sets two lowest bytes of TInt.

Since
2.6

Parameters

TInt & aInt TInt of which the lowest bytes are set.
TInt16 aValue Value for the lowest bytes.

SetScale(TUint16)

void SetScale ( TUint16 aScale ) [private]

Sets the internal scale value.

Since
2.6

Parameters

TUint16 aScale New internal scaling value.

SetScrollBarModelType(TEikScrollBarModelType)

void SetScrollBarModelType ( TEikScrollBarModelType aModelType ) [private]

Sets the scrollbar type.

Since
2.6

Parameters

TEikScrollBarModelType aModelType Scrollbar type. Supported types are EEikScrollBarModel and EAknDoubleSpanScrollBarModel.

SetScrollSpan(TInt)

IMPORT_C void SetScrollSpan ( TInt aValue )

Set methods for model attributes. These MUST be used instead of setting base class model values directly.

Since
2.6
This inaccuracy means that e.g. following can happen: TInt value1 = 23456789; TInt value2 = 0;

model.SetScrollSpan(value1); value2 = model.ScrollSpan(); if (value1 != value2) { // we can end up here !!!! }

Parameters

TInt aValue Value to be stored. Allowed range 0x1FFF7FFF to -0x1FFF7FFF. Value outside the allowed range will be truncated to max or min value. Value will be internally stored with 15 bit accuracy, this means that the actual stored value may differ from the value given as parameter.

SetScrollSpanValue(TInt16)

void SetScrollSpanValue ( TInt16 aValue ) [private]

Set methods for model attributes values without scaling.

Since
2.6

Parameters

TInt16 aValue Value without scaling to be stored.

SetWindowSize(TInt)

IMPORT_C void SetWindowSize ( TInt aValue )

Parameters

TInt aValue

SetWindowSizeValue(TInt16)

void SetWindowSizeValue ( TInt16 aValue ) [private]

Parameters

TInt16 aValue

WindowSize()

IMPORT_C TInt WindowSize ( ) const

WindowSizeValue()

TInt16 WindowSizeValue ( ) const [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.