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

tdeutils

Signals | Public Member Functions | Protected Slots | List of all members
KCMultiDialog Class Reference
KControl module classes

#include <kcmultidialog.h>

Inheritance diagram for KCMultiDialog:
KDialogBase KDialog

Signals

void configCommitted ()
 
void configCommitted (const TQCString &instanceName)
 

Public Member Functions

 KCMultiDialog (TQWidget *parent=0, const char *name=0, bool modal=false)
 
 KCMultiDialog (int dialogFace, const TQString &caption, TQWidget *parent=0, const char *name=0, bool modal=false)
 
 KCMultiDialog (int dialogFace, const KGuiItem &user2, const KGuiItem &user3=KGuiItem(), int buttonMask=User2, const TQString &caption=i18n("Configure"), TQWidget *parent=0, const char *name=0, bool modal=false) KDE_DEPRECATED
 
virtual ~KCMultiDialog ()
 
void addModule (const TQString &module, bool withfallback=true, TQStringList args=TQStringList())
 
void addModule (const TDECModuleInfo &moduleinfo, TQStringList parentmodulenames=TQStringList(), bool withfallback=false, TQStringList args=TQStringList())
 
void removeAllModules ()
 
void show ()
 

Protected Slots

virtual void slotDefault ()
 
virtual void slotUser1 ()
 
virtual void slotApply ()
 
virtual void slotOk ()
 
virtual void slotHelp ()
 

Additional Inherited Members

- Protected Member Functions inherited from KDialog
virtual void keyPressEvent (TQKeyEvent *)
 

Detailed Description

A method that offers a KDialogBase containing arbitrary KControl Modules.

Author
Matthias Elter elter.nosp@m.@kde.nosp@m..org, Daniel Molkentin molke.nosp@m.ntin.nosp@m.@kde..nosp@m.org
Since
3.2

Definition at line 43 of file kcmultidialog.h.

Constructor & Destructor Documentation

KCMultiDialog::KCMultiDialog ( TQWidget *  parent = 0,
const char *  name = 0,
bool  modal = false 
)

Constructs a new KCMultiDialog.

Parameters
parentThe parent widget
nameThe widget name
modalIf you pass true here, the dialog will be modal

Definition at line 58 of file kcmultidialog.cpp.

KCMultiDialog::KCMultiDialog ( int  dialogFace,
const TQString &  caption,
TQWidget *  parent = 0,
const char *  name = 0,
bool  modal = false 
)

Construct a personalized KCMultiDialog.

Parameters
dialogFaceYou can use TreeList, Tabbed, Plain, Swallow or IconList.
captionThe dialog caption. Do not specify the application name here. The class will take care of that.
parentParent of the dialog.
nameDialog name (for internal use only).
modalControls dialog modality. If false, the rest of the program interface (example: other dialogs) is accessible while the dialog is open.

Definition at line 67 of file kcmultidialog.cpp.

KCMultiDialog::KCMultiDialog ( int  dialogFace,
const KGuiItem &  user2,
const KGuiItem &  user3 = KGuiItem(),
int  buttonMask = User2,
const TQString &  caption = i18n("Configure"),
TQWidget *  parent = 0,
const char *  name = 0,
bool  modal = false 
)

Constructor for the predefined layout mode where you specify the kind of layout (face) and also add buttons.

Note that the User1 button of KDialogBase is already used to provide a "Reset" button so only two more buttons are available to users of KCMultiDialog. When clicked they trigger slotUser2() and slotUser3().

Note
If any root modules are added to the dialog when this constructor is used, it will not be able to run them with root privileges. Since that will render them useless, it is a good idea to use another constructor. In KDE 4 the argument user3 will be removed.
Parameters
dialogFaceYou can use TreeList, Tabbed, Plain, Swallow or IconList.
user2User button2 text item.
user3User button3 text item.
buttonMaskSpecifies which buttons will be visible. If zero (0) no extra buttons will be added. You can only use the User2 and User3 buttons. The User1 button is already used internally. See KDialogBase for more information on this.
captionThe dialog caption. Do not specify the application name here. The class will take care of that.
parentParent of the dialog.
nameDialog name (for internal use only).
modalControls dialog modality. If false, the rest of the program interface (example: other dialogs) is accessible while the dialog is open.

Definition at line 76 of file kcmultidialog.cpp.

KCMultiDialog::~KCMultiDialog ( )
virtual

Destructor.

Definition at line 102 of file kcmultidialog.cpp.

Member Function Documentation

void KCMultiDialog::addModule ( const TQString &  module,
bool  withfallback = true,
TQStringList  args = TQStringList() 
)

Add a module.

Parameters
moduleSpecify the name of the module that is to be added to the list of modules the dialog will show.
withfallbackTry harder to load the module. Might result in the module appearing outside the dialog.
argsList of arguments to pass to the module.

Definition at line 232 of file kcmultidialog.cpp.

void KCMultiDialog::addModule ( const TDECModuleInfo &  moduleinfo,
TQStringList  parentmodulenames = TQStringList(),
bool  withfallback = false,
TQStringList  args = TQStringList() 
)

Add a module.

Parameters
moduleinfoPass a TDECModuleInfo object which will be used for creating the module. It will be added to the list of modules the dialog will show.
parentmodulenamesThe names of the modules that should appear as parents in the TreeList. Look at the KDialogBase::addPage documentation for more info on this.
withfallbackTry harder to load the module. Might result in the module appearing outside the dialog.
argsList of arguments to pass to the module.

Definition at line 244 of file kcmultidialog.cpp.

void KCMultiDialog::configCommitted ( )
signal

Emitted after all TDECModules have been told to save their configuration.

The applyClicked and okClicked signals are emitted before the configuration is saved.

void KCMultiDialog::configCommitted ( const TQCString &  instanceName)
signal

Emitted after the TDECModules have been told to save their configuration.

It is emitted once for every instance the KCMs that were changed belong to.

You can make use of this if you have more than one component in your application. instanceName tells you the instance that has to reload its configuration.

The applyClicked and okClicked signals are emitted before the configuration is saved.

Parameters
instanceNameThe name of the instance that needs to reload its configuration.
void KCMultiDialog::removeAllModules ( )

Remove all modules from the dialog.

Definition at line 333 of file kcmultidialog.cpp.

void KCMultiDialog::slotApply ( )
protectedvirtualslot

This slot is called when the user presses the "Apply" Button.

You can reimplement it if needed.

Note
Make sure you call the original implementation.

Definition at line 163 of file kcmultidialog.cpp.

void KCMultiDialog::slotDefault ( )
protectedvirtualslot

This slot is called when the user presses the "Default" Button.

You can reimplement it if needed.

Note
Make sure you call the original implementation.

Definition at line 110 of file kcmultidialog.cpp.

void KCMultiDialog::slotHelp ( )
protectedvirtualslot

This slot is called when the user presses the "Help" Button.

It reads the X-DocPath field of the currently selected KControl module's .desktop file to find the path to the documentation, which it then attempts to load.

You can reimplement this slot if needed.

Note
Make sure you call the original implementation.

Definition at line 183 of file kcmultidialog.cpp.

void KCMultiDialog::slotOk ( void  )
protectedvirtualslot

This slot is called when the user presses the "OK" Button.

You can reimplement it if needed.

Note
Make sure you call the original implementation.

Definition at line 173 of file kcmultidialog.cpp.

void KCMultiDialog::slotUser1 ( )
protectedvirtualslot

This slot is called when the user presses the "Reset" Button.

You can reimplement it if needed.

Note
Make sure you call the original implementation.

Definition at line 124 of file kcmultidialog.cpp.


The documentation for this class was generated from the following files:
  • kcmultidialog.h
  • kcmultidialog.cpp

tdeutils

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

tdeutils

Skip menu "tdeutils"
  • 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 tdeutils by doxygen 1.8.8
This website is maintained by Timothy Pearson.