tdecmodule.h

/*
   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 TDECMODULE_H
#define TDECMODULE_H
 
#include <tqwidget.h>
 
#include <tdelibs_export.h>
 
class TQStringList;
 
class TDEAboutData;
class TDEConfigDialogManager;
class TDEConfigSkeleton;
class TDECModulePrivate;
class TDEInstance;
 
class TDEUI_EXPORT TDECModule : public TQWidget
{
  TQ_OBJECT
 
public:
 
  enum Button {Help=1, Default=2, Apply=16,
               Reset=4, /* obsolete, do not use! */
               Cancel=8, /* obsolete, do not use! */
               Ok=32, /* obsolete, do not use! */
           SysDefault=64 /* obsolete, do not use! */ };
 
  /*
   * Base class for all KControlModules.
   * Make sure you have a TQStringList argument in your
   * implementation.
   */
  TDECModule(TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList() );
 
  TDECModule(TDEInstance *instance, TQWidget *parent=0, const TQStringList &args=TQStringList() );
 
  /*
   * Destroys the module.
   */
  ~TDECModule();
 
  virtual void load();
  // ### KDE 4: Call load() automatically through a single-shot timer
  //            from the constructor // and change documentation
 
  virtual void save();
 
  virtual void defaults();
 
  virtual void sysdefaults() { defaults(); }
  // KDE 4 deprecate
 
  virtual TQString quickHelp() const;
 
  virtual TQString handbookDocPath() const;
  
  virtual TQString handbookSection() const;
 
  virtual const TDEAboutData *aboutData() const;
 
   void setAboutData( TDEAboutData* about );
 
  int buttons() const { return _btn; }
 
  TQString rootOnlyMsg() const;
 
  bool useRootOnlyMsg() const;
 
  TDEInstance *instance() const;
 
  const TQPtrList<TDEConfigDialogManager>& configs() const;
 
protected:
  TDEConfigDialogManager* addConfig( TDEConfigSkeleton *config, TQWidget* widget );
 
  void setQuickHelp( const TQString& help );
 
signals:
 
  void changed(bool state);
 
  void quickHelpChanged();
 
protected slots:
 
  void changed();
 
   void widgetChanged();
 
protected:
 
  void setButtons(int btn) { _btn = btn; }
 
  void setRootOnlyMsg(const TQString& msg);
 
  void setUseRootOnlyMsg(bool on);
 
  bool managedWidgetChangeState() const;
 
  void unmanagedWidgetChangeState(bool);
 
private:
 
  int _btn;
protected:
  virtual void virtual_hook( int id, void* data );
private:
  TDECModulePrivate *d;
 
  void init();
 
};
 
#endif //TDECMODULE_H