skinfactory.h

/*
  Copyright (c) 2012, BuildmLearn Contributors listed at http://buildmlearn.org/people/
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

  * Neither the name of the BuildmLearn nor the names of its
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef SKINFACTORY_H
#define SKINFACTORY_H

#include <QObject>

#include <QStringList>
#include <QMetaType>


/// \brief Skin representation.
struct Skin {
    QString m_baseName;
    QString m_baseFolder;
    QString m_visibleName;
    QStringList m_stylesNames;
    QString m_author;
    QString m_email;
    QString m_version;
    QString m_rawData;

    QString m_simulatorBackgroundMain;
    QString m_simulatorStyle;
};

Q_DECLARE_METATYPE(Skin)

///
/// \brief Main features for skinning.
class SkinFactory : public QObject {
    Q_OBJECT

  public:
    /// \brief Constructor.
    explicit SkinFactory(QObject *parent = 0);

    /// \brief Destructor.
    virtual ~SkinFactory();

    /// \brief Loads skin name from settings and sets it as active.
    void loadCurrentSkin();

    /// \brief Name of this "activated" skin.
    /// \return Returns the name of the skin, that should be activated
    /// after application restart.
    QString selectedSkinName();

    /// \brief Gets skin about a particular skin.
    Skin skinInfo(const QString &skin_name, bool *ok = NULL);

    /// \brief Returns list of installed skins.
    QList<Skin> installedSkins();

    /// \brief Sets the desired skin as the active one if it exists.
    void setCurrentSkinName(const QString &skin_name);

    /// \brief Access to activated skin.
    /// \return Returns Skin instance which holds data of currently
    /// active skin.
    inline Skin currentSkin() const {
      return m_currentSkin;
    }

  private:
    // Loads the skin from give skin_data.
    bool loadSkinFromData(const Skin &skin);

  private:
    // Holds name of the current skin.
    Skin m_currentSkin;
};

#endif // SKINFACTORY_H