kpixmapsequence.h

Go to the documentation of this file.

/*
  Copyright 2008 Aurélien Gâteau <agateau@kde.org>
  Copyright 2009 Sebastian Trueg <trueg@kde.org>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef _K_PIXMAPSEQUENCE_H_
#define _K_PIXMAPSEQUENCE_H_

#include <QtCore/QSharedDataPointer>
#include <QtCore/QSize>

#include "kdeui_export.h"
#include <kiconloader.h>

class QPixmap;

class KDEUI_EXPORT KPixmapSequence
{
public:
    KPixmapSequence();

    KPixmapSequence(const KPixmapSequence &other);

    explicit KPixmapSequence(const QPixmap &pixmap, const QSize &frameSize = QSize());

    explicit KPixmapSequence(const QString &iconName, int size = KIconLoader::SizeSmall);

    ~KPixmapSequence();

    KPixmapSequence &operator=(const KPixmapSequence &other);

    bool isValid() const;

    bool isEmpty() const;

    QSize frameSize() const;

    int frameCount() const;

    QPixmap frameAt(int index) const;

private:
    class Private;
    QSharedDataPointer<Private> d;
};

#endif