Global.h

Go to the documentation of this file.

/*
 *   Copyright (C) 2007, 2008, 2009, 2010 Ivan Cukic <ivan.cukic(at)kde.org>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser/Library General Public License version 2,
 *   or (at your option) any later version, as published by the Free
 *   Software Foundation
 *
 *   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 Lesser/Library General Public License for more details
 *
 *   You should have received a copy of the GNU Lesser/Library 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.
 */

#ifndef LANCELOT_GLOBAL_H
#define LANCELOT_GLOBAL_H

#include <QColor>
#include <QList>
#include <QMap>
#include <QString>
#include <QVariant>

#include <KConfig>
#include <KConfigGroup>

#include <Plasma/FrameSvg>
#include <Plasma/Plasma>

#include <lancelot/lancelot_export.h>

namespace Lancelot
{

class Global;
class GroupPrivate;

class LANCELOT_EXPORT Group : public QObject {
public:

    class ColorScheme {
    public:
        ColorScheme();

        QColor normal, disabled, active;
    };

    bool hasProperty(const QString & property) const;

    QVariant property(const QString & property) const;

    void setProperty(const QString & property, const QVariant & value, bool persistent = true);

    void clearProperty(const QString & property);

    Plasma::FrameSvg * backgroundSvg() const;

    const ColorScheme * backgroundColor() const;

    const ColorScheme * foregroundColor() const;

    void load(bool full = false);

    void add(QObject * object);

    bool contains(QObject * object);

    void remove(QObject * object, bool setDefaultGroup = true);

    QString name() const;

    // TODO: delete me after 4.3
    void notifyUpdated() {}

private:
    GroupPrivate * const d;

    Group(QString name);
    virtual ~Group();

    friend class Global;
};

class LANCELOT_EXPORT Global : public QObject {
    Q_OBJECT
public:
    static Global * self();

    virtual ~Global();

    KConfig * theme() const;

    KConfig * config();

    bool config(const QString & group, const QString & field, bool defaultValue) const;

    int  config(const QString & group, const QString & field, int  defaultValue) const;

    QString config(const QString & group, const QString & field, const QString &  defaultValue) const;

    Group * group(const QString & name);

    Group * groupForObject(QObject * object);

    void setGroupForObject(QObject * object, Group * group);

    bool groupExists(const QString & name) const;

    Group * defaultGroup();

    void setImmutability(const Plasma::ImmutabilityType immutable);

    Plasma::ImmutabilityType immutability() const;

Q_SIGNALS:
    void immutabilityChanged(const Plasma::ImmutabilityType immutable);

private:
    Global();

    class Private;
    Private * const d;
};

} // namespace Lancelot

#endif /* LANCELOT_GLOBAL_H */