/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbCore module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** This file may be used under the terms of the GNU Lesser General Public

** License version 2.1 as published by the Free Software Foundation and

** appearing in the file LICENSE.LGPL included in the packaging of this file.

** Please review the following information to ensure the GNU Lesser General

** Public License version 2.1 requirements will be met:

** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#ifndef HBICONANIMATIONDEFINITION_H

#define HBICONANIMATIONDEFINITION_H

#include <hbglobal.h>

#include <QString>

#include <QList>

#include <QExplicitlySharedDataPointer>

class HbIconAnimationDefinitionPrivate;

class HB_CORE_EXPORT HbIconAnimationDefinition

{

public:

    enum PlayMode {

        PlayOnce = 0,

        Loop = 1

    };

    struct AnimationFrame {

        QString iconName;

        int duration;

        struct Jump {

            int targetFrameIndex;

            int repeatCount;

        };

        QList<Jump> jumps;

    };

    HbIconAnimationDefinition();

    ~HbIconAnimationDefinition();

    HbIconAnimationDefinition(const HbIconAnimationDefinition &other);

    HbIconAnimationDefinition &operator=(const HbIconAnimationDefinition &other);

    bool isNull() const;

    QList<AnimationFrame> frameList() const;

    void setFrameList(const QList<AnimationFrame> &list);

    PlayMode playMode() const;

    void setPlayMode(PlayMode mode);

private:

    QExplicitlySharedDataPointer<HbIconAnimationDefinitionPrivate> d;

};

#endif // HBICONANIMATIONDEFINITION_H