KviTheme.h

Go to the documentation of this file.

#ifndef _KVI_THEME_H_
#define _KVI_THEME_H_

//=============================================================================
//
//   File : KviTheme.h
//   Creation date : Mon Jan 08 2007 03:23:00 CEST by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2007-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your option) any later version.
//
//   This program 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 General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include "kvi_settings.h"
#include "KviQString.h"
#include "KviHeapObject.h"
#include "kvi_fileextensions.h"
#include "KviApplication.h"
#include "KviFileUtils.h"

#include <QPixmap>

#define KVI_THEMEINFO_FILE_NAME "themeinfo" KVI_FILEEXTENSION_CONFIG
#define KVI_THEMEDATA_FILE_NAME "themedata" KVI_FILEEXTENSION_CONFIG
#define KVI_THEMEINFO_CONFIG_GROUP "ThemeInfo"
#define KVI_THEMEDATA_CONFIG_GROUP "ThemeData"

#define KVI_CURRENT_THEME_ENGINE_VERSION "1.1.0"

class KVIRC_API KviThemeInfo : public KviHeapObject
{
public:
        KviThemeInfo();
        ~KviThemeInfo();

public:
        enum Location
        {
                Builtin = 0,
                User = 1,
                External = 3,
                Auto = 4
        };

protected:
        QString m_szName;    //< name of the theme
        QString m_szVersion; //< version of the theme

        QString m_szDirectory;    //< the absolute directory of the theme
        QString m_szSubdirectory; //< the last component of m_szDirectory (this is needed when the theme is installed)
        Location m_eLocation;     //< the location of the theme

        QString m_szAuthor;             //< author of the theme
        QString m_szDescription;        //< description of the theme
        QString m_szDate;               //< theme creation date
        QString m_szApplication;        //< theme creation (KVIrc) version
        QString m_szThemeEngineVersion; //< the theme engine version that saved this theme

        QString m_szLastError; //< reported when some function fails

        QPixmap m_pixScreenshotLarge;  //< the large screenshot pixmap
        QPixmap m_pixScreenshotMedium; //< the medium screenshot pixmap
        QPixmap m_pixScreenshotSmall;  //< the small screenshot pixmap

public:
        bool load(const QString & szDirectory, Location eLocation);

        bool save(const QString & szThemeFileName);

        const QString & lastError() { return m_szLastError; }
        void setLastError(const QString & szLastError) { m_szLastError = szLastError; }
        const QString & name() { return m_szName; }
        void setName(const QString & szName) { m_szName = szName; }
        const QString & version() { return m_szVersion; }
        void setVersion(const QString & szVersion) { m_szVersion = szVersion; }

        const QString & directory() const
        {
                return m_szDirectory;
        }

        const QString & subdirectory() const
        {
                return m_szSubdirectory;
        }

        Location location() const
        {
                return m_eLocation;
        }

        void setDirectoryAndLocation(const QString & szDirectory, Location eLocation);

        bool isBuiltin()
        {
                return m_eLocation == KviThemeInfo::Builtin;
        }

        const QString & author() { return m_szAuthor; }
        void setAuthor(const QString & szAuthor) { m_szAuthor = szAuthor; }
        const QString & description() { return m_szDescription; }
        void setDescription(const QString & szDescription) { m_szDescription = szDescription; }
        const QString & date() { return m_szDate; }
        void setDate(const QString & szDate) { m_szDate = szDate; }
        const QString & application() { return m_szApplication; }
        void setApplication(const QString & szApplication) { m_szApplication = szApplication; }
        const QString & themeEngineVersion() { return m_szThemeEngineVersion; }
        void setThemeEngineVersion(const QString & szThemeEngineVersion) { m_szThemeEngineVersion = szThemeEngineVersion; }

        const QPixmap & smallScreenshot();
        const QPixmap & mediumScreenshot();
        const QPixmap & largeScreenshot();
        QString smallScreenshotPath();
};

namespace KviTheme
{
        bool KVIRC_API apply(const QString & szThemeDirectory, KviThemeInfo::Location eLocation, KviThemeInfo & buffer);

        bool KVIRC_API save(KviThemeInfo & options, bool bSaveIcons);

        bool KVIRC_API saveScreenshots(KviThemeInfo & options, const QString & szOriginalScreenshotPath);

        void KVIRC_API installedThemeDirectories(QStringList & slThemes, KviThemeInfo::Location eLocation);
}

#endif //_KVI_THEME_H_