• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeui
 

tdeui

  • tdeui
tdecmodule.h
1 /*
2  This file is part of the KDE libraries
3 
4  Copyright (c) 1999 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Library General Public
8  License as published by the Free Software Foundation; either
9  version 2 of the License, or (at your option) any later version.
10 
11  This library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  Library General Public License for more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to
18  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  Boston, MA 02110-1301, USA.
20 
21 */
22 
23 #ifndef TDECMODULE_H
24 #define TDECMODULE_H
25 
26 #include <tqwidget.h>
27 
28 #include <tdelibs_export.h>
29 
30 class TQStringList;
31 
32 class TDEAboutData;
33 class TDEConfigDialogManager;
34 class TDEConfigSkeleton;
35 class TDECModulePrivate;
36 class TDEInstance;
37 
69 class TDEUI_EXPORT TDECModule : public TQWidget
70 {
71  Q_OBJECT
72 
73 public:
74 
81  enum Button {Help=1, Default=2, Apply=16,
82  Reset=4, /* obsolete, do not use! */
83  Cancel=8, /* obsolete, do not use! */
84  Ok=32, /* obsolete, do not use! */
85  SysDefault=64 /* obsolete, do not use! */ };
86 
87  /*
88  * Base class for all KControlModules.
89  * Make sure you have a TQStringList argument in your
90  * implementation.
91  */
92  TDECModule(TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList() );
93 
94  TDECModule(TDEInstance *instance, TQWidget *parent=0, const TQStringList &args=TQStringList() );
95 
96  /*
97  * Destroys the module.
98  */
99  ~TDECModule();
100 
120  virtual void load();
121  // ### KDE 4: Call load() automatically through a single-shot timer
122  // from the constructor // and change documentation
123 
143  virtual void save();
144 
156  virtual void defaults();
157 
166  virtual void sysdefaults() { defaults(); }
167  // KDE 4 deprecate
168 
178  virtual TQString quickHelp() const;
179 
188  virtual TQString handbookDocPath() const;
189 
197  virtual TQString handbookSection() const;
198 
206  virtual const TDEAboutData *aboutData() const;
207 
212  void setAboutData( TDEAboutData* about );
213 
222  int buttons() const { return _btn; }
223 
236  TQString rootOnlyMsg() const;
237 
248  bool useRootOnlyMsg() const;
249 
250  TDEInstance *instance() const;
251 
256  const TQPtrList<TDEConfigDialogManager>& configs() const;
257 
258 protected:
269  TDEConfigDialogManager* addConfig( TDEConfigSkeleton *config, TQWidget* widget );
270 
276  void setQuickHelp( const TQString& help );
277 
278 signals:
279 
287  void changed(bool state);
288 
297  void quickHelpChanged();
298 
299 protected slots:
300 
305  void changed();
306 
312  void widgetChanged();
313 
314 protected:
315 
328  void setButtons(int btn) { _btn = btn; }
329 
339  void setRootOnlyMsg(const TQString& msg);
340 
349  void setUseRootOnlyMsg(bool on);
350 
355  bool managedWidgetChangeState() const;
356 
362  void unmanagedWidgetChangeState(bool);
363 
364 private:
365 
366  int _btn;
367 protected:
368  virtual void virtual_hook( int id, void* data );
369 private:
370  TDECModulePrivate *d;
371 
375  void init();
376 
377 };
378 
379 #endif //TDECMODULE_H
380 
TDEConfigSkeleton
TDEAboutData
TDECModule::buttons
int buttons() const
Indicate which buttons will be used.
Definition: tdecmodule.h:222
TDECModule::sysdefaults
virtual void sysdefaults()
Set the configuration to system default values.
Definition: tdecmodule.h:166
TDECModule::Button
Button
An enumeration type for the buttons used by this module.
Definition: tdecmodule.h:81
TDECModule::setButtons
void setButtons(int btn)
Sets the buttons to display.
Definition: tdecmodule.h:328
TDEConfigDialogManager
TDECModule
The base class for control center modules.
Definition: tdecmodule.h:69
TDEInstance

tdeui

Skip menu "tdeui"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeui

Skip menu "tdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  •     tdecore
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  • tdeioslave
  •   http
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeui by doxygen 1.8.8
This website is maintained by Timothy Pearson.