TAknDoubleSpanScrollBarModel Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None


#include <eikscrlb.h>

Inherits TEikScrollBarModel.


Public Member Functions

IMPORT_C  TAknDoubleSpanScrollBarModel ()
  Default constructor.
IMPORT_C  TAknDoubleSpanScrollBarModel (const TEikScrollBarModel &aEikModel)
  Constructor which converts TEikScrollBarModel into TAknDoubleSpanScrollBarModel.
IMPORT_C void  SetScrollSpan (TInt aValue)
  Set methods for model attributes.
IMPORT_C void  SetFocusPosition (TInt aValue)
IMPORT_C void  SetWindowSize (TInt aValue)
IMPORT_C void  SetFieldSize (TInt aValue)
IMPORT_C void  SetFieldPosition (TInt aValue)
IMPORT_C TInt  ScrollSpan () const
  Get methods for model attributes.
IMPORT_C TInt  FocusPosition () const
IMPORT_C TInt  WindowSize () const
IMPORT_C TInt  FieldSize () const
IMPORT_C TInt  FieldPosition () const

Static Public Member Functions

static TBool  ModelIsSupported ()
  This method can be used to query if this model type is supported by the device.

Constructor & Destructor Documentation

IMPORT_C TAknDoubleSpanScrollBarModel::TAknDoubleSpanScrollBarModel  ) 
 

Default constructor.

IMPORT_C TAknDoubleSpanScrollBarModel::TAknDoubleSpanScrollBarModel const TEikScrollBarModel aEikModel  ) 
 

Constructor which converts TEikScrollBarModel into TAknDoubleSpanScrollBarModel.

Parameters:
aEikModel  a model that will be converted.
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.


Member Function Documentation

IMPORT_C TInt TAknDoubleSpanScrollBarModel::FieldPosition  )  const
 
IMPORT_C TInt TAknDoubleSpanScrollBarModel::FieldSize  )  const
 
IMPORT_C TInt TAknDoubleSpanScrollBarModel::FocusPosition  )  const
 
static TBool TAknDoubleSpanScrollBarModel::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

Returns:
ETrue if this model is supported by the devices scrollbar system. Otherwise EFalse is returned.
IMPORT_C TInt TAknDoubleSpanScrollBarModel::ScrollSpan  )  const
 

Get methods for model attributes.

These MUST be used instead of getting base class model values directly.

Returns:
Values from range 0x1FFF7FFF to -0x1FFF7FFF. Values are internally stored with 15 bit accuracy, this means that the returned value may differ from the value which was set using the corresponding set method. Difference can be about 0x3FFF in the high end of the range.
IMPORT_C void TAknDoubleSpanScrollBarModel::SetFieldPosition TInt  aValue  ) 
 
IMPORT_C void TAknDoubleSpanScrollBarModel::SetFieldSize TInt  aValue  ) 
 
IMPORT_C void TAknDoubleSpanScrollBarModel::SetFocusPosition TInt  aValue  ) 
 
IMPORT_C void TAknDoubleSpanScrollBarModel::SetScrollSpan TInt  aValue  ) 
 

Set methods for model attributes.

These MUST be used instead of setting base class model values directly.

Parameters:
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.
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 !!!! }

IMPORT_C void TAknDoubleSpanScrollBarModel::SetWindowSize TInt  aValue  ) 
 
IMPORT_C TInt TAknDoubleSpanScrollBarModel::WindowSize  )  const
 

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

Copyright © Nokia Corporation 2001-2008
Back to top