kicontheme.h

Go to the documentation of this file.

/* vi: ts=8 sts=4 sw=4
 *
 * This file is part of the KDE project, module kdecore.
 * Copyright (C) 2000 Geert Jansen <jansen@kde.org>
 *                    Antonio Larrosa <larrosa@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License version 2 as published by the Free Software Foundation.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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 KICONTHEME_H
#define KICONTHEME_H

#include <kdeui_export.h>

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QList>

#include "kiconloader.h"

class QAction;
class KIconThemeDir;
class K3Icon;

class KDEUI_EXPORT KIconTheme
{
public:
    explicit KIconTheme(const QString& name, const QString& appName=QString());
    ~KIconTheme();

    QString name() const;

    QString internalName() const;

    QString description() const;

    QString example() const;

    QString screenshot() const;

    QString dir() const;

    QStringList inherits() const;

    bool isValid() const;

    bool isHidden() const;

    int depth() const;

    int defaultSize(KIconLoader::Group group) const;

    QList<int> querySizes(KIconLoader::Group group) const;

    QStringList queryIcons(int size, KIconLoader::Context context = KIconLoader::Any) const;

    QStringList queryIconsByContext(int size, KIconLoader::Context context = KIconLoader::Any) const;

    K3Icon iconPath(const QString& name, int size, KIconLoader::MatchType match) const;

    bool hasContext( KIconLoader::Context context ) const;

    static QStringList list();

    static QString current();

    static void reconfigure();

    static QString defaultThemeName();

    enum ContextMenus { TextEditor,
                        ReadOnlyText };

    static void assignIconsToContextMenu(ContextMenus type, QList<QAction*> actions);

private:
    class KIconThemePrivate;
    KIconThemePrivate * const d;
};

#endif