kcmodule.h

Go to the documentation of this file.

/*
   This file is part of the KDE libraries

   Copyright (c) 1999 Matthias Hoelzer-Kluepfel <hoelzer@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 as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

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

#include <kdeui_export.h>

#include <QtCore/QVariant>
#include <QtGui/QWidget>

#ifdef Q_WS_X11
#include <fixx11h.h>
#endif

class QStringList;
class KAboutData;
class KConfigDialogManager;
class KCoreConfigSkeleton;
class KConfigSkeleton;
class KCModulePrivate;
class KComponentData;

namespace KAuth {
    class Action;
}

class KDEUI_EXPORT KCModule : public QWidget
{
  Q_OBJECT

public:

  enum Button { NoAdditionalButton=0, Help=1, Default=2, Apply=4, Export=8 };
  Q_DECLARE_FLAGS( Buttons, Button )

#ifdef KDE3_SUPPORT
  KDE_CONSTRUCTOR_DEPRECATED KCModule( QWidget *parent, const char *name, const QStringList& args = QStringList() );

  KDE_CONSTRUCTOR_DEPRECATED KCModule(const KComponentData &componentData, QWidget *parent, const QStringList& args);
#endif

  explicit KCModule(const KComponentData &componentData, QWidget *parent = 0, const QVariantList& args = QVariantList());

  ~KCModule();

  virtual QString quickHelp() const;

  virtual const KAboutData *aboutData() const;

  void setAboutData( const KAboutData* about );

  Buttons buttons() const;

  QString rootOnlyMessage() const;

  bool useRootOnlyMessage() const;

  KComponentData componentData() const;

  QList<KConfigDialogManager*> configs() const;

  void setNeedsAuthorization(bool needsAuth);

  bool needsAuthorization() const;

  KAuth::Action *authAction() const;

  QString exportText() const;

  void setExportText(const QString &);

public Q_SLOTS:
  virtual void load();

  virtual void save();

  virtual void defaults();

protected:
  KConfigDialogManager* addConfig( KCoreConfigSkeleton *config, QWidget* widget );

  KConfigDialogManager* addConfig( KConfigSkeleton *config, QWidget* widget );

  void setQuickHelp( const QString& help );

  virtual void showEvent(QShowEvent *ev);

  friend class KCModuleProxy;

Q_SIGNALS:

  void changed(bool state);

  void quickHelpChanged();

  void rootOnlyMessageChanged(bool use, QString message);

protected Q_SLOTS:

  void changed();

   void widgetChanged();

   void authStatusChanged(int);

protected:

  void setButtons(Buttons btn);

  void setRootOnlyMessage(const QString& message);

  void setUseRootOnlyMessage(bool on);

  bool managedWidgetChangeState() const;

  void unmanagedWidgetChangeState(bool);

private:
  KCModulePrivate *const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS( KCModule::Buttons )

#endif //KCMODULE_H