/*

* Copyright (c) 2002-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:  Wrapper class for Newsticker text label.

*

*/

#ifndef _XNNEWSTICKERADAPTER_H

#define _XNNEWSTICKERADAPTER_H

//  INCLUDES

#include "xncontroladapter.h"

#include "xnnewsticker.h"

// FORWARD DECLARATIONS

class CXnNodePluginIf;

class CXnNewstickerControl;

// CONSTANTS

// The default values for the newsticker control

const TInt KXnNewstickerDelay = 1000000;   // start scrolling after a delay of 1 second

const TInt KXnNewstickerInterval = 100000; // scroll 10 times in a second

const TInt KXnNewstickerScrollAmount = 6;  // scroll 6 pixels at time

const TInt KXnNewstickerLoops = 1;         // loop amount

const TInt KNoDelay = 0;                   //  No delay to start the animation

const TInt KAnimationTime = 6000000;       //  The animation lasts 6 seconds

// CLASS DECLARATION

/**

* @ingroup group_xnnewstickerfactory

* 

*  Newsticker adapter class implementation.

*

*  @lib xnnewstickerfactory.dll

*  @since Series 60 3.2

*/

class CXnNewstickerAdapter : public CXnControlAdapter,

            XnNewstickerInterface::MXnNewstickerCallbackInterface

    {

    public:

        enum TScrollBehaviour

            {

            EScroll,

            EAlternate,

            };            

    public:

    	/**

    	* 2 phase construction.

        * @param aParent Parent control

        * @param aNode UI node

    	*/

    	static CXnNewstickerAdapter* NewL(CXnControlAdapter* aParent, CXnNodePluginIf& aNode);

    	/**

    	* Destructor.

    	*/

    	virtual ~CXnNewstickerAdapter();

    public: // New functions

        /**

         * Append new title to the end of the title list.

         * @param aTitle The new title to add.

         */

        /**

         * Insert new title to the end of the title list.

         * @param aTitle The new title to add.

         * @param aIndex The place to add the title.

         */

        /**

         * Update title text.

         * @param aTitle The new title to add.

         * @param aIndex The place to update the title.

         */

        /**

         * Delete the title.

         * @param aIndex The title index to delete.

         */

    	/**

    	 * Returns index of the currently selected title.

    	 * @return The index of the current title.

    	 */

        TInt CurrentTitleIndex();

    	/**

    	 * Return the title of the given index.

    	 * @param aIndex The index to return the title.

    	 * @return The title of the given index.

    	 */

        /**

         * Delete all titles.

         */

        void ClearTitles();

        /**

         * Set callback interface.

         * @param aCallback The callback interface pointer.

         */

        void SetCallbackInterfaceL(

        /**

         * Start showing the titles.

         */

        /**

         * Stop showing the titles.

         */

        /**

         */

        /**

         * Callback which will be called by the CPeriodic.

         * @param aPtr User defined pointer.

         * @return ETrue if the method should be called again.

         */

    public: // from base classes

        //  From MXnNewstickerCallbackInterface

        /**

         * Called when the title has been shown and is now offscreen.

         * @param aTitleIndex The title that has been completely shown.

         */

        /**

        * See CCoeControl documentation

        */    	

        void SizeChanged();

        /**

        * See CXnControlAdapter documentation

        */    	

        /**

        * Enter power save mode. This is done when application goes to background or lights go off. 

        * Derived classes should override this function and stop animations, timers etc. when the function is called.

        */ 

	   	/**

        * Exit power save mode. This is done when application comes to foreground or lights go on. 

        * Derived classes should override this function and restart animations, timers etc. when the function is called.

        */ 

        /**

        * From CXnControlAdapter Handles the property changes.

        * @since Series 60 3.1

        * @return void.

        */ 

	    /**

        * Skin change notification.

        * See CXnControlAdapter documentation

        */        

        void SkinChanged();

        /**

        */

        /**

        */

    private:

    	/**

    	* Sets text properties, such as color, font, etc.

    	*/

    	void SetTextPropertiesL();	

    	/**

    	* Sets newsticker timing properties.

    	*/

        void SetNewstickerPropertiesL();

        /**

        /**

        * The timer to use for scrolling events.

        * Own.

        */

	    CPeriodic*                  iPeriodicTimer;

        /**

        * The callback interface which is used when a title has been shown.

        * Not own.

        */

        XnNewstickerInterface::MXnNewstickerCallbackInterface*  iCallback;

        /**

        * The control handling the text title showing

        * Own.

        */

        CXnNewstickerControl*       iControl;

        /**

        /**

         * The alternate interval between ticks.

         */	    

	    TInt                        iAlternateInterval;

        /**

        * UI node

        * Not own.

        */

        CXnNodePluginIf&            iNode;

        /**

        * Font for control.

        */        

        CFont*                      iFont;

        /**

        * Whether the font needs to be released or not.

        */        

        /**

        * For keeping track of the current powersave mode state

        */       

        TBool                       iPowerSaveMode;

        /**

        * Current scroll behaviour

        */               

        /**

         * Restart animation after title has been updated

         */

        TBool                       iRestartAfterUpdate;

    };

#endif // XNNEWSTICKERADAPTER_H

// End of File