/*

* Copyright (c) 1997-2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

#if !defined(__EIKSCRLB_H__)

#define __EIKSCRLB_H__

#if !defined(__EIKBCTRL_H__)

#include <eikbctrl.h>

#endif

#if !defined(__EIKSBOBS_H__)

#include <eiksbobs.h>

#endif

#if !defined(__AKNSCBUT_H__)

#include <aknscbut.h>

#endif

#include <lafpublc.h>

class CEikCba;

class CAknDoubleSpanScrollIndicator;

class CEikScrollBarExtensionImpl;

class CEikScrollBarExtension;

class CAknDoubleSpanScrollBarExtension;

const TInt KEikScrollEventFromVBar=0;

const TInt KEikScrollEventFromHBar=0x01;

const TInt KEikScrollEventBarMask=0x01;

// sets all bits in EButtonsXxx range

const TInt KButtonPositionMask=KLafScrollBarButtonPositionMask; 

// sets all bits in determining which components exist

const TInt KDisplayComponentsMask=0x1f; 

/**

 * 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.

 */

class TEikScrollBarModel

    {

public:

    /**

     * C++ default constructor. Creates, allocates and initialises a new @c 

     * TEikScrollBarModel.

     */

    inline TEikScrollBarModel();

    /**

     * Constructor. Creates, allocates and initialises a new @c 

     * TEikScrollBarModel.

     *

     * @param aScrollSpan The span of this model, numbered from zero.

     * @param aThumbSpan Number of positions spanned by the thumb.In default

     *        this is zero.

     * @param aThumbPosition Position of the thumb within the model span. In

     *        default this is zero.

     */	

    IMPORT_C TEikScrollBarModel(TInt aScrollSpan,

                                TInt aThumbSpan=0,

                                TInt aThumbPosition=0);

    /**

     * Tests two models for equality. The two models are the current model and

     * the model specified by @c aModel.

     *

     * @param The model against which the current model is tested. 

     *

     * @return @c ETrue if the two models are equal.

     */	

    IMPORT_C TBool operator==(const TEikScrollBarModel aModel) const;

    /**

     * Tests two models for inequality. The two models are the current model 

     * and the model specified by @c aModel.

     *

     * @param The model against which the current model is tested. 

     * @return @c ETrue if the two models are not equal.

     */	

    inline TBool operator!=(const TEikScrollBarModel aModel) const; 

public:

    /** 

     * Tests whether the scroll bar model is useful. Scroll bar models are only

     * useful if their thumb span is smaller than their entire span.

     *

     * @return Whether this scroll bar can be used.

     */

    IMPORT_C TBool ScrollBarUseful() const;

    /**

     * Gets the maximum position possible for the low edge of the thumb within

     * the total span.

     *

     * @return Maximum value possible for @c iThumbPosition.

     */

    IMPORT_C TInt MaxThumbPos() const;

    /**

     * Ensures that the thumb position remains within its valid range by

     * altering it if necessary.

     */

    IMPORT_C void CheckBounds();

    /** 

     * 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.

     */

    enum TEikScrollBarModelType

        {

        /** This model type is for storing data for the arrowhead scrollbar. */

        EEikScrollBarModel               = 0x00000000,

        /** This model type is for storing data for the spanned scrollbar. */

        EAknDoubleSpanScrollBarModel     = 0x80000000

        };        

    /**

     * Gets type of scroll bar model which is one of the enum values from @c 

     * TEikScrollBarModelType enum.

     */

    TEikScrollBarModel::TEikScrollBarModelType ScrollBarModelType() const;

public:

    /** Entire range of integers for this model. */

    TInt iScrollSpan;

    /** Range spanned by the thumb. */

    TInt iThumbSpan;

    /** Position of the low edge of the thumb within 0...@c iScrollSpan. */

    TInt iThumbPosition;            

    };

inline TEikScrollBarModel::TEikScrollBarModel() {}

inline TBool TEikScrollBarModel::operator!=(const TEikScrollBarModel aModel) const { return !(*this==aModel); }

//

// TAknDoubleSpanScrollBarModel class

//

// This class is binary compatible with TEikScrollBarModel and can

// be used in places where TEikScrollBarModel is used but few restrictions exist:

//

// - Base class (TEikScrollBarModel) public members must NOT be accessed directly.

// - Base class (TEikScrollBarModel) public methods must NOT be called.

//

// If this model is not supported by the scrollbar system, then values are stored

// as in the base class for compatibility resons. See ModelIsSupported()-method 

// documentation for more information.

//

class TAknDoubleSpanScrollBarModel : public TEikScrollBarModel

	{

public:

   /**

    * Default constructor.

    */

    IMPORT_C TAknDoubleSpanScrollBarModel();

   /**

    * Constructor which converts TEikScrollBarModel into TAknDoubleSpanScrollBarModel.

    *

    * @since    2.6

    * @param    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.

    *

    */

    IMPORT_C TAknDoubleSpanScrollBarModel(const TEikScrollBarModel& aEikModel);

   /**

    *  Set methods for model attributes. These MUST be used instead of setting

    *  base class model values directly.

    *

    *  @since    2.6

    *  @param    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 SetScrollSpan(TInt aValue);    // Size of the scrolled list. 

    IMPORT_C void SetFocusPosition(TInt aValue); // Position of the current field in the list.

    IMPORT_C void SetWindowSize(TInt aValue);    // Size of the visible part of the list. 

    IMPORT_C void SetFieldSize(TInt aValue);     // Size of the current field. (Optional double span)

    IMPORT_C void SetFieldPosition(TInt aValue); // Position inside the current field. (Optional double span)  

   /**

    *  Get methods for model attributes. These MUST be used instead of getting

    *  base class model values directly.

    *

    * @since    2.6

    * @return   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 TInt ScrollSpan() const;    // Size of the scrolled list.

    IMPORT_C TInt FocusPosition() const; // Position of the current field in the list.

    IMPORT_C TInt WindowSize() const;    // Size of the visible part of the list. 

    IMPORT_C TInt FieldSize() const;     // Size of the current field. (Optional double span)

    IMPORT_C TInt FieldPosition() const; // Position inside the current field. (Optional double span)

   /**

    * 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

    * @return   ETrue if this model is supported by the devices scrollbar system. Otherwise EFalse is

    *           returned.

    *

    */

    static TBool ModelIsSupported();

private:   

   /**

    * Gets the internal scale value. 

    *

    * @since    2.6

    * @return   Internal scaling value.

    *

    */

    TUint16 Scale() const;

   /**

    * Sets the internal scale value. 

    *

    * @since    2.6

    * @param    aScale  New internal scaling value.

    *

    */

    void SetScale(TUint16 aScale);    

private:   

   /**

    *  Get methods for model attributes values without scaling.

    *

    *  @since    2.6

    *  @return   Stored value without scaling. 

    *

    */

    TInt16 ScrollSpanValue() const;

    TInt16 FocusPositionValue() const;

    TInt16 FieldPositionValue() const;

    TInt16 FieldSizeValue() const;

    TInt16 WindowSizeValue() const;

   /**

    *  Set methods for model attributes values without scaling.

    *

    *  @since    2.6

    *  @param    aValue Value without scaling to be stored. 

    *

    */

    void SetScrollSpanValue(TInt16 aValue);

    void SetFocusPositionValue(TInt16 aValue);

    void SetFieldPositionValue(TInt16 aValue);

    void SetFieldSizeValue(TInt16 aValue);

    void SetWindowSizeValue(TInt16 aValue);

   /**

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

    *

    *  @since    2.6

    *  @param    aInt  Value from which the lowest bytes are extracted.     

    *  @return   TInt16 constructed from two lowest bytes.

    */

    TInt16 LowBytes(TInt aInt) const;

   /**

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

    *

    *  @since    2.6

    *  @param    aInt  Value from which the highest bytes are extracted.     

    *  @return   TInt16 constructed from two highest bytes.

    */    

    TInt16 HighBytes(TInt aInt) const;

   /**

    *  Sets two lowest bytes of TInt.

    *

    *  @since    2.6

    *  @param    aInt    TInt of which the lowest bytes are set.     

    *  @param    aValue  Value for the lowest bytes.     

    */    

    void SetLowBytes(TInt& aInt, TInt16 aValue);

   /**

    *  Sets two highest bytes of TInt.

    *

    *  @since    2.6

    *  @param    aInt    TInt of which the highest bytes are set.     

    *  @param    aValue  Value for the highest bytes.     

    */        

    void SetHighBytes(TInt& aInt, TInt16 aValue);

   /**

    *  Constructs a scaled TInt16 value from given TInt value. Changes

    *  internal member variable values using ReScale()-method if needed.

    *

    *  @since    2.6

    *  @param    aNonScaledValue    Value which will be changed to scaled one.

    *  @return   Scaled value.

    */        

    TInt16 PrepareScaledValue(TInt aNonScaledValue);

   /**

    *  Changes the used scale value and updates all stored attribute values

    *  if needed.

    *

    *  @since    2.6

    *  @param    aNewScale    New value to be used scaling.

    *

    */        

    void ReScale(TUint16 aNewScale);

   /**

    *  Sets the scrollbar type.

    *

    *  @since    2.6

    *  @param    aModelType    Scrollbar type. Supported types are 

    *                          EEikScrollBarModel and EAknDoubleSpanScrollBarModel.

    *

    */        

    void SetScrollBarModelType(TEikScrollBarModelType aModelType);

   /**

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

    *

    *  @since    2.6

    *  @param    aValue        Value to be checked.

    *  @return                 Checked value which will be between internal min 

    *                          and max values. 

    *

    */        

    TInt CheckMinMaxValue(TInt aValue);

    };

//

// CEikScrollBar

//

class CEikScrollThumb;

class CEikScrollBarFrame;

/**

 * The CEikScrollBar class implements a scroll bar. Scroll bars are used when

 * the contents of a view require a greater area than can be physically 

 * displayed. Scroll bars allow a user to move different parts of the content

 * into the view and to indicate what proportion of the total contents are 

 * visible at any one time.

 */

class CEikScrollBar : public CEikBorderedControl, public MCoeControlObserver

	{

friend class CEikScrollBarExtension;

friend class CAknDoubleSpanScrollBarExtension;

public:

    /** Scroll bar orientation. */

    enum TOrientation

        {

        /** Scroll bar is oriented vertically. */

        EVertical = SLafScrollBar::EVertical,

        /** Scroll bar is oriented horizontally. */

        EHorizontal = SLafScrollBar::EHorizontal

        };

    /** Type of the scroll bar.*/	

    enum TScrollBarType

        {

        /** Normal scrollbar. */		

        ENormalScrollBar =0x0,

        /** Used scrollbar type is an old one. (arrows in the CBA-area) */		

        EArrowHead =0x200,

        /** 

         * The created scrollbar is the current and commonly used in Series 60

         * platform, spanned scrollbar. (scrollable bar on the right side of

         *  the control, like in windows etc.).

         */		

        EDoubleSpan =0x400

        };

    /** 

     * Scroll bar initialisation flags. The default is for the scroll bar

     * to have both a shaft and a thumb. 

     */	

    enum TEikScrollBarFlags

    	{

    	/**  */	

    	EEikScrollBarDefaultBehaviour = 

    	    SLafScrollBar::EEikScrollBarDefaultBehaviour,

    	/** Does not display nudge buttons.*/	

    	EEikScrollBarNoNudgeButtons =

    	    SLafScrollBar::EEikScrollBarNoNudgeButtons,

    	/** Has buttons which move it a page at a time. */	

    	EEikScrollBarHasPageButtons =

    	    SLafScrollBar::EEikScrollBarHasPageButtons,	

    	/** Has buttons which move it its entire extent. */	

    	EEikScrollBarHasHomeEndButtons =

    	    SLafScrollBar::EEikScrollBarHasHomeEndButtons,

    	/** Central area is empty. */	

    	EEikScrollBarNoShaftOrThumb =

    	    SLafScrollBar::EEikScrollBarNoShaftOrThumb,	

    	/** Central area has no scroll thumb. */	

    	EEikScrollBarShaftButNoThumb =

    	    SLafScrollBar::EEikScrollBarShaftButNoThumb,	

    	/** Buttons are placed at the start of the bar. */	

    	EButtonsAtStartOfShaft =

    	    SLafScrollBar::EButtonsAtStartOfShaft,	

    	/** Buttons are placed at the end of the bar. */	

    	EButtonsAtEndOfShaft =

    	    SLafScrollBar::EButtonsAtEndOfShaft,			

    	/** 

    	 * Buttons are placed at either end of the bar @c

    	 * (EButtonsAtStartOfShaft | @c EButtonsAtEndOfShaft).

    	 */	

    	EButtonsEitherSideOfShaft =

    	    SLafScrollBar::EButtonsEitherSideOfShaft,

    	/** 

    	 * Buttons do not automatically dim when scroll bar is at its maximum

    	 * extent.

    	 */	

    	ENoAutoDimming =

    	    SLafScrollBar::ENoAutoDimming,

    	/** Enable the nudge buttons. */

    	EEnableNudgeButtons = 0x0200,

    	/** Disable the expanded touch area. */

    	EDisableExpandedTouchArea = 0x0400

    	};

    /** Type of the scroll extension area.*/

     enum TScrollBarExtensionAreaType

        {

        /** Normal scrollbar extension area. */

        ENormalExpandedTouchArea,

        /** Scale scrollbar extension area. */

        EScaleExpandedTouchArea,

        /** none scrollbar extension area. */