kcmoduleproxy.h

Go to the documentation of this file.

/*  This file is part of the KDE project
    Copyright (C) 2003 Matthias Kretz <kretz@kde.org>
    Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

    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 KCMUTILS_KCMODULEPROXY_H
#define KCMUTILS_KCMODULEPROXY_H

#include <QtGui/QImage>
#include <QtCore/QStringList>

#include <kcmodule.h>
#include <kservice.h>
#include <kcmutils_export.h>

class KAboutData;
class KCModuleInfo;
class KComponentData;
class KCModuleProxyPrivate;

class KCMUTILS_EXPORT KCModuleProxy : public QWidget
{
Q_DECLARE_PRIVATE(KCModuleProxy)
Q_OBJECT
public:
    explicit KCModuleProxy( const KCModuleInfo& info, QWidget* parent = 0,
            const QStringList& args = QStringList() );

    explicit KCModuleProxy( const QString& serviceName, QWidget* parent = 0,
            const QStringList& args = QStringList() );

    explicit KCModuleProxy( const KService::Ptr& service, QWidget* parent = 0,
            const QStringList& args = QStringList() );

    ~KCModuleProxy();

    void load();

    void save();

    QString quickHelp() const;

    const KAboutData * aboutData() const;

    KCModule::Buttons buttons() const;

    QString rootOnlyMessage() const;
    //KDE4 remove. There's a limit for convenience functions,
    // this one's available via realModule()->

    bool useRootOnlyMessage() const;
    //KDE4 remove. There's a limit for convenience functions,
    // this one's available via realModule()->

    KComponentData componentData() const;
    //KDE4 remove. There's a limit for convenience functions,
    // this one's available via realModule()

    bool changed() const;

    KCModule* realModule() const;

    KCModuleInfo moduleInfo() const;

    QString dbusService() const;
    QString dbusPath() const;
    QSize minimumSizeHint() const;

public Q_SLOTS:

    void defaults();

    void deleteClient();

Q_SIGNALS:

    /*
     * This signal is emitted when the contained module is changed.
     */
    void changed( bool state );

    void changed( KCModuleProxy* mod );

    void childClosed();

    /*
     * This signal is relayed from the encapsulated module, and
     * is equivalent to the module's own quickHelpChanged() signal.
     */
    void quickHelpChanged();

protected:

    void showEvent( QShowEvent * );

protected:
    KCModuleProxyPrivate *const d_ptr;

private:
    Q_PRIVATE_SLOT(d_func(), void _k_moduleChanged(bool))
    Q_PRIVATE_SLOT(d_func(), void _k_moduleDestroyed())
    Q_PRIVATE_SLOT(d_func(), void _k_ownerChanged(const QString &service, const QString &oldOwner, const QString &newOwner))
};

#endif // KUTILS_KCMODULEPROXY_H
// vim: ts=4