tdecmoduleproxy.h

/*  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 TDECMODULEPROXY_H
#define TDECMODULEPROXY_H
 
#include <tqwidget.h>
#include <tqstringlist.h>
 
#include <kservice.h>
#include <tdelibs_export.h>
 
class TDEAboutData;
class TDECModule;
class TDECModuleInfo;
class TDEInstance;
class TDEProcess;

class TDEUTILS_EXPORT TDECModuleProxy : public TQWidget
{
TQ_OBJECT
 
 
    friend class TDECModuleProxyRootCommunicatorImpl;
 
public:

    TDECModuleProxy( const TDECModuleInfo & info, bool withFallback = true,
            TQWidget * parent = 0, const char * name = 0,
            const TQStringList & args = TQStringList() );

    TDECModuleProxy( const TQString& serviceName, bool withFallback = true,
            TQWidget * parent = 0, const char * name = 0,
            const TQStringList & args = TQStringList() );

    TDECModuleProxy( const KService::Ptr& service, bool withFallback = true,
            TQWidget  * parent = 0, const char * name = 0,
            const TQStringList & args = TQStringList() );

    ~TDECModuleProxy();

    void load();

    void save();

    TQString quickHelp() const;

    const TDEAboutData * aboutData() const;

    TQString handbookDocPath() const;

    TQString handbookSection() const;

    int buttons() const;

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

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

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

    bool changed() const;

    bool rootMode() const;

    TDECModule* realModule() const;

    const TDECModuleInfo& moduleInfo() const;

    TQCString dcopName() const;
 
public slots:

    void runAsRoot();

    void defaults();

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

    void changed( TDECModuleProxy* mod );

    void childClosed();
 
    /*
     * This signal is relayed from the encapsulated module, and
     * is equivalent to the module's own quickHelpChanged() signal.
     *
     * @since 3.4
     */
    void quickHelpChanged();
 
protected:

    void showEvent( TQShowEvent * );

    void init( const TDECModuleInfo& info );
 

    void emitQuickHelpChanged();
 
private slots:

    void callRootModule( const TQCString& function );

    void rootExited();

    void moduleChanged( bool );

    void moduleDestroyed();

    void applicationRemoved( const TQCString& app );
 
private:
 
    class TDECModuleProxyPrivate;
    TDECModuleProxyPrivate * d;
};
 
#endif // TDECMODULEPROXY_H