• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KUtils

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

#include <kcmultidialog.h>

Inheritance diagram for KCMultiDialog:
KPageDialog KDialog QDialog KSettings::Dialog

Signals

void configCommitted ()
 
void configCommitted (const QByteArray &componentName)
 
- Signals inherited from KPageDialog
void currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before)
 
void pageRemoved (KPageWidgetItem *page)
 
- Signals inherited from KDialog
void aboutToShowDetails ()
 
void applyClicked ()
 
void buttonClicked (KDialog::ButtonCode button)
 
void cancelClicked ()
 
void closeClicked ()
 
void defaultClicked ()
 
void finished ()
 
void helpClicked ()
 
void hidden ()
 
void layoutHintChanged ()
 
void noClicked ()
 
void okClicked ()
 
void resetClicked ()
 
void tryClicked ()
 
void user1Clicked ()
 
void user2Clicked ()
 
void user3Clicked ()
 
void yesClicked ()
 

Public Member Functions

 KCMultiDialog (QWidget *parent=0)
 
virtual ~KCMultiDialog ()
 
KPageWidgetItem * addModule (const KCModuleInfo &moduleinfo, KPageWidgetItem *parent=0, const QStringList &args=QStringList())
 
KPageWidgetItem * addModule (const QString &module, const QStringList &args=QStringList())
 
void clear ()
 
void setButtons (ButtonCodes buttonMask)
 
- Public Member Functions inherited from KPageDialog
 KPageDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
 
 ~KPageDialog ()
 
void addPage (KPageWidgetItem *item)
 
KPageWidgetItem * addPage (QWidget *widget, const QString &name)
 
void addSubPage (KPageWidgetItem *parent, KPageWidgetItem *item)
 
KPageWidgetItem * addSubPage (KPageWidgetItem *parent, QWidget *widget, const QString &name)
 
KPageWidgetItem * currentPage () const
 
void insertPage (KPageWidgetItem *before, KPageWidgetItem *item)
 
KPageWidgetItem * insertPage (KPageWidgetItem *before, QWidget *widget, const QString &name)
 
void removePage (KPageWidgetItem *item)
 
void setCurrentPage (KPageWidgetItem *item)
 
void setFaceType (FaceType faceType)
 
- Public Member Functions inherited from KDialog
 KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
 
 ~KDialog ()
 
KPushButton * button (ButtonCode id) const
 
KIcon buttonIcon (ButtonCode id) const
 
QString buttonText (ButtonCode id) const
 
QString buttonToolTip (ButtonCode id) const
 
QString buttonWhatsThis (ButtonCode id) const
 
ButtonCode defaultButton () const
 
QString helpLinkText () const
 
void incrementInitialSize (const QSize &size)
 
bool isButtonEnabled (ButtonCode id) const
 
QWidget * mainWidget ()
 
virtual QSize minimumSizeHint () const
 
void restoreDialogSize (const KConfigGroup &config)
 
void saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
 
void setButtonFocus (ButtonCode id)
 
void setButtonGuiItem (ButtonCode id, const KGuiItem &item)
 
void setButtonIcon (ButtonCode id, const KIcon &icon)
 
void setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
 
void setButtons (ButtonCodes buttonMask)
 
void setButtonsOrientation (Qt::Orientation orientation)
 
void setButtonText (ButtonCode id, const QString &text)
 
void setButtonToolTip (ButtonCode id, const QString &text)
 
void setButtonWhatsThis (ButtonCode id, const QString &text)
 
void setDefaultButton (ButtonCode id)
 
void setEscapeButton (ButtonCode id)
 
void setInitialSize (const QSize &size)
 
void setMainWidget (QWidget *widget)
 
void showButton (ButtonCode id, bool state)
 
void showButtonSeparator (bool state)
 
virtual QSize sizeHint () const
 

Protected Slots

void slotApplyClicked ()
 
void slotDefaultClicked ()
 
void slotHelpClicked ()
 
void slotOkClicked ()
 
void slotUser1Clicked ()
 
- Protected Slots inherited from KDialog
virtual void slotButtonClicked (int button)
 
void updateGeometry ()
 

Protected Member Functions

 KCMultiDialog (KCMultiDialogPrivate &dd, KPageWidget *pageWidget, QWidget *parent, Qt::WindowFlags flags=0)
 
 KCMultiDialog (KPageWidget *pageWidget, QWidget *parent, Qt::WindowFlags flags=0)
 
- Protected Member Functions inherited from KPageDialog
 KPageDialog (KPageDialogPrivate &dd, KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0)
 
 KPageDialog (KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0)
 
KPageWidget * pageWidget ()
 
const KPageWidget * pageWidget () const
 
void setPageWidget (KPageWidget *widget)
 
- Protected Member Functions inherited from KDialog
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
 
virtual void closeEvent (QCloseEvent *e)
 
virtual void hideEvent (QHideEvent *)
 
virtual void keyPressEvent (QKeyEvent *)
 

Additional Inherited Members

- Public Types inherited from KPageDialog
enum  FaceType
 
- Public Types inherited from KDialog
enum  ButtonCode
 
enum  ButtonPopupMode
 
enum  CaptionFlag
 
- Public Slots inherited from KDialog
void delayedDestruct ()
 
void enableButton (ButtonCode id, bool state)
 
void enableButtonApply (bool state)
 
void enableButtonCancel (bool state)
 
void enableButtonOk (bool state)
 
void enableLinkedHelp (bool state)
 
bool isDetailsWidgetVisible () const
 
virtual void setCaption (const QString &caption)
 
virtual void setCaption (const QString &caption, bool modified)
 
void setDetailsWidget (QWidget *detailsWidget)
 
void setDetailsWidgetVisible (bool visible)
 
void setHelp (const QString &anchor, const QString &appname=QString())
 
void setHelpLinkText (const QString &text)
 
virtual void setPlainCaption (const QString &caption)
 
- Static Public Member Functions inherited from KDialog
static bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)
 
static void centerOnScreen (QWidget *widget, int screen=-1)
 
static int groupSpacingHint ()
 
static QString makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
 
static int marginHint ()
 
static void resizeLayout (QLayout *lay, int margin, int spacing)
 
static void resizeLayout (QWidget *widget, int margin, int spacing)
 
static void setAllowEmbeddingInGraphicsView (bool allowEmbedding)
 
static int spacingHint ()
 
- Public Attributes inherited from KPageDialog
 Auto
 
 List
 
 Plain
 
 Tabbed
 
 Tree
 
- Public Attributes inherited from KDialog
 Apply
 
 AppNameCaption
 
 Cancel
 
 Close
 
 Default
 
 DelayedPopup
 
 Details
 
 Help
 
 HIGCompliantCaption
 
 InstantPopup
 
 ModifiedCaption
 
 No
 
 NoCaptionFlags
 
 NoDefault
 
 None
 
 Ok
 
 Reset
 
 Try
 
 User1
 
 User2
 
 User3
 
 Yes
 
- Protected Attributes inherited from KDialog
KDialogPrivate *const d_ptr
 

Detailed Description

A class that offers a KPageDialog 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

Definition at line 37 of file kcmultidialog.h.

Constructor & Destructor Documentation

◆ KCMultiDialog() [1/3]

KCMultiDialog::KCMultiDialog ( QWidget *  parent = 0)

Constructs a new KCMultiDialog.

Parameters
parentThe parent widget

Definition at line 227 of file kcmultidialog.cpp.

◆ ~KCMultiDialog()

KCMultiDialog::~KCMultiDialog ( )
virtual

Destructor.

Definition at line 245 of file kcmultidialog.cpp.

◆ KCMultiDialog() [2/3]

KCMultiDialog::KCMultiDialog ( KPageWidget *  pageWidget,
QWidget *  parent,
Qt::WindowFlags  flags = 0 
)
protected

This constructor can be used by subclasses to provide a custom KPageWidget.

Definition at line 233 of file kcmultidialog.cpp.

◆ KCMultiDialog() [3/3]

KCMultiDialog::KCMultiDialog ( KCMultiDialogPrivate &  dd,
KPageWidget *  pageWidget,
QWidget *  parent,
Qt::WindowFlags  flags = 0 
)
protected

Definition at line 239 of file kcmultidialog.cpp.

Member Function Documentation

◆ addModule() [1/2]

KPageWidgetItem * KCMultiDialog::addModule ( const KCModuleInfo &  moduleinfo,
KPageWidgetItem *  parent = 0,
const QStringList &  args = QStringList() 
)

Add a module.

The module is added according to its KCModuleInfo::weight(). The weight determines where in the list the module will appear. Lighter modules on top, heavier modules at the bottom.

Parameters
moduleinfoPass a KCModuleInfo object which will be used for creating the module. It will be added to the list of modules the dialog will show.
parentThe
See also
KPageWidgetItem that should appear as parents in the tree view or a 0 pointer if there is no parent.
Parameters
argsThe arguments that should be given to the KCModule when it is created

Definition at line 374 of file kcmultidialog.cpp.

◆ addModule() [2/2]

KPageWidgetItem * KCMultiDialog::addModule ( const QString &  module,
const QStringList &  args = QStringList() 
)

Add a module.

The module is added according to its KCModuleInfo::weight(). The weight determines where in the list the module will appear. Lighter modules on top, heavier modules at the bottom.

Parameters
moduleSpecify the name of the module that is to be added to the list of modules the dialog will show.
argsThe arguments that should be given to the KCModule when it is created
Returns
The
See also
KPageWidgetItem associated with the new dialog page.

Definition at line 362 of file kcmultidialog.cpp.

◆ clear()

void KCMultiDialog::clear ( )

Removes all modules from the dialog.

Definition at line 460 of file kcmultidialog.cpp.

◆ configCommitted [1/2]

void KCMultiDialog::configCommitted ( )
signal

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

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

◆ configCommitted [2/2]

void KCMultiDialog::configCommitted ( const QByteArray &  componentName)
signal

Emitted after the KCModules 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. componentName tells you the instance that has to reload its configuration.

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

Parameters
componentNameThe name of the instance that needs to reload its configuration.

◆ setButtons()

void KCMultiDialog::setButtons ( ButtonCodes  buttonMask)

Reimplemented for internal reasons.

Definition at line 475 of file kcmultidialog.cpp.

◆ slotApplyClicked

void KCMultiDialog::slotApplyClicked ( )
protectedslot

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 322 of file kcmultidialog.cpp.

◆ slotDefaultClicked

void KCMultiDialog::slotDefaultClicked ( )
protectedslot

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 249 of file kcmultidialog.cpp.

◆ slotHelpClicked

void KCMultiDialog::slotHelpClicked ( )
protectedslot

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 338 of file kcmultidialog.cpp.

◆ slotOkClicked

void KCMultiDialog::slotOkClicked ( )
protectedslot

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 330 of file kcmultidialog.cpp.

◆ slotUser1Clicked

void KCMultiDialog::slotUser1Clicked ( )
protectedslot

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 265 of file kcmultidialog.cpp.


The documentation for this class was generated from the following files:
  • kcmultidialog.h
  • kcmultidialog.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KUtils

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal