KCMultiDialog Class Reference

#include <kcmultidialog.h>

Inheritance diagram for KCMultiDialog:

Signals
void	configCommitted ()
void	configCommitted (const TQCString &instanceName)
Signals inherited from KDialogBase
void	helpClicked ()
void	defaultClicked ()
void	user3Clicked ()
void	user2Clicked ()
void	user1Clicked ()
void	applyClicked ()
void	tryClicked ()
void	okClicked ()
void	yesClicked ()
void	noClicked ()
void	cancelClicked ()
void	closeClicked ()
void	apply ()
void	backgroundChanged ()
void	hidden ()
void	finished ()
void	aboutToShowDetails ()
void	aboutToShowPage (TQWidget *page)
Signals inherited from KDialog
void	layoutHintChanged ()

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) TDE_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 ()
Public Member Functions inherited from KDialogBase
	KDialogBase (TQWidget *parent=0, const char *name=0, bool modal=true, const TQString &caption=TQString::null, int buttonMask=Ok|Apply|Cancel, ButtonCode defaultButton=Ok, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
	KDialogBase (int dialogFace, const TQString &caption, int buttonMask, ButtonCode defaultButton, TQWidget *parent=0, const char *name=0, bool modal=true, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
	KDialogBase (KDialogBase::DialogType dialogFace, WFlags f, TQWidget *parent=0, const char *name=0, bool modal=true, const TQString &caption=TQString::null, int buttonMask=Ok|Apply|Cancel, ButtonCode defaultButton=Ok, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
	KDialogBase (const TQString &caption, int buttonMask=Yes|No|Cancel, ButtonCode defaultButton=Yes, ButtonCode escapeButton=Cancel, TQWidget *parent=0, const char *name=0, bool modal=true, bool separator=false, const KGuiItem &yes=KStdGuiItem::yes(), const KGuiItem &no=KStdGuiItem::no(), const KGuiItem &cancel=KStdGuiItem::cancel())
void	setButtonBoxOrientation (int orientation)
void	setEscapeButton (ButtonCode id)
virtual void	adjustSize ()
TQFrame *	plainPage ()
TQFrame *	addPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQFrame *	addPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQVBox *	addVBoxPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQVBox *	addVBoxPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQHBox *	addHBoxPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQHBox *	addHBoxPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQGrid *	addGridPage (int n, Orientation dir, const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQGrid *	addGridPage (int n, Orientation dir, const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
void	setFolderIcon (const TQStringList &path, const TQPixmap &pixmap)
TQFrame *	makeMainWidget ()
TQVBox *	makeVBoxMainWidget ()
TQHBox *	makeHBoxMainWidget ()
TQGrid *	makeGridMainWidget (int n, Orientation dir)
void	enableButtonSeparator (bool state)
void	showButton (ButtonCode id, bool state)
void	showButtonOK (bool state)
void	showButtonApply (bool state)
void	showButtonCancel (bool state)
bool	showPage (int index)
int	activePageIndex () const
int	pageIndex (TQWidget *widget) const
void	setMainWidget (TQWidget *widget)
TQWidget *	mainWidget ()
void	disableResize ()
void	setInitialSize (const TQSize &s, bool noResize=false)
void	incInitialSize (const TQSize &s, bool noResize=false)
TQSize	configDialogSize (const TQString &groupName) const
TQSize	configDialogSize (TDEConfig &config, const TQString &groupName) const
void	saveDialogSize (const TQString &groupName, bool global=false)
void	saveDialogSize (TDEConfig &config, const TQString &groupName, bool global=false) const
void	setButtonOK (const KGuiItem &item=KStdGuiItem::ok())
void	setButtonOKText (const TQString &text=TQString::null, const TQString &tooltip=TQString::null, const TQString &quickhelp=TQString::null) TDE_DEPRECATED
void	setButtonApply (const KGuiItem &item=KStdGuiItem::apply())
void	setButtonApplyText (const TQString &text=TQString::null, const TQString &tooltip=TQString::null, const TQString &quickhelp=TQString::null) TDE_DEPRECATED
void	setButtonCancel (const KGuiItem &item=KStdGuiItem::cancel())
void	setButtonCancelText (const TQString &text=TQString::null, const TQString &tooltip=TQString::null, const TQString &quickhelp=TQString::null) TDE_DEPRECATED
void	setButtonText (ButtonCode id, const TQString &text)
void	setButtonTip (ButtonCode id, const TQString &text)
void	setButtonWhatsThis (ButtonCode id, const TQString &text)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setTreeListAutoResize (bool state)
void	setShowIconsInTreeList (bool state)
void	setRootIsDecorated (bool state)
void	unfoldTreeList (bool persist=false)
void	addWidgetBelowList (TQWidget *widget)
void	addButtonBelowList (const TQString &text, TQObject *recv, const char *slot)
void	addButtonBelowList (const KGuiItem &guiitem, TQObject *recv, const char *slot)
void	setIconListAllVisible (bool state)
void	showTile (bool state)
void	getBorderWidths (int &ulx, int &uly, int &lrx, int &lry) const TDE_DEPRECATED
TQRect	getContentsRect () const TDE_DEPRECATED
TQSize	calculateSize (int w, int h) const
TQString	helpLinkText () const
TQPushButton *	actionButton (ButtonCode id)
Public Member Functions inherited from KDialog
	KDialog (TQWidget *parent=0, const char *name=0, bool modal=false, WFlags f=0)

Protected Slots
virtual void	slotDefault ()
virtual void	slotUser1 ()
virtual void	slotApply ()
virtual void	slotOk ()
virtual void	slotHelp ()
Protected Slots inherited from KDialogBase
virtual void	slotHelp ()
virtual void	slotDefault ()
virtual void	slotDetails ()
virtual void	slotUser3 ()
virtual void	slotUser2 ()
virtual void	slotUser1 ()
virtual void	slotOk ()
virtual void	slotApply ()
virtual void	slotTry ()
virtual void	slotYes ()
virtual void	slotNo ()
virtual void	slotCancel ()
virtual void	slotClose ()
virtual void	applyPressed ()
void	updateGeometry ()
void	slotDelayedDestruct ()

Additional Inherited Members
Public Types inherited from KDialogBase
enum	ButtonCode
enum	DialogType
Public Slots inherited from KDialogBase
void	enableButton (ButtonCode id, bool state)
void	enableButtonOK (bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableLinkedHelp (bool state)
void	delayedDestruct ()
void	setHelpLinkText (const TQString &text)
void	setHelp (const TQString &anchor, const TQString &appname=TQString::null)
void	helpClickedSlot (const TQString &)
void	setDetails (bool showDetails)
void	setDetailsWidget (TQWidget *detailsWidget)
void	updateBackground ()
void	cancel ()
Public Slots inherited from KDialog
virtual void	polish ()
virtual void	setCaption (const TQString &caption)
virtual void	setPlainCaption (const TQString &caption)
Static Public Member Functions inherited from KDialogBase
static bool	haveBackgroundTile ()
static const TQPixmap *	backgroundTile ()
static const TQPixmap *	getBackgroundTile () TDE_DEPRECATED
static void	setBackgroundTile (const TQPixmap *pix)
Static Public Member Functions inherited from KDialog
static int	marginHint ()
static int	spacingHint ()
static void	resizeLayout (TQWidget *widget, int margin, int spacing)
static void	resizeLayout (TQLayoutItem *lay, int margin, int spacing)
static void	centerOnScreen (TQWidget *widget, int screen=-1)
static bool	avoidArea (TQWidget *widget, const TQRect &area, int screen=-1)
Public Attributes inherited from KDialogBase
	Help
	Default
	Ok
	Apply
	Try
	Cancel
	Close
	User1
	User2
	User3
	No
	Yes
	Details
	Filler
	Stretch
	NoDefault
Protected Member Functions inherited from KDialogBase
virtual void	keyPressEvent (TQKeyEvent *e)
virtual void	hideEvent (TQHideEvent *)
virtual void	closeEvent (TQCloseEvent *e)

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() [1/3]

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

Constructs a new KCMultiDialog.

Parameters

parent	The parent widget
name	The widget name
modal	If you pass true here, the dialog will be modal

Definition at line 58 of file kcmultidialog.cpp.

KCMultiDialog() [2/3]

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

Construct a personalized KCMultiDialog.

Parameters

dialogFace	You can use TreeList, Tabbed, Plain, Swallow or IconList.
caption	The dialog caption. Do not specify the application name here. The class will take care of that.
parent	Parent of the dialog.
name	Dialog name (for internal use only).
modal	Controls 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() [3/3]

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

dialogFace	You can use TreeList, Tabbed, Plain, Swallow or IconList.
user2	User button2 text item.
user3	User button3 text item.
buttonMask	Specifies 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.
caption	The dialog caption. Do not specify the application name here. The class will take care of that.
parent	Parent of the dialog.
name	Dialog name (for internal use only).
modal	Controls 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::~KCMultiDialog ( )

virtual

Destructor.

Definition at line 102 of file kcmultidialog.cpp.

Member Function Documentation

addModule() [1/2]

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

Add a module.

Parameters

moduleinfo	Pass a TDECModuleInfo object which will be used for creating the module. It will be added to the list of modules the dialog will show.
parentmodulenames	The names of the modules that should appear as parents in the TreeList. Look at the KDialogBase::addPage documentation for more info on this.
withfallback	Try harder to load the module. Might result in the module appearing outside the dialog.
args	List of arguments to pass to the module.

Definition at line 244 of file kcmultidialog.cpp.

addModule() [2/2]

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

Add a module.

Parameters

module	Specify the name of the module that is to be added to the list of modules the dialog will show.
withfallback	Try harder to load the module. Might result in the module appearing outside the dialog.
args	List of arguments to pass to the module.

Definition at line 232 of file kcmultidialog.cpp.

configCommitted [1/2]

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.

configCommitted [2/2]

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

instanceName

The name of the instance that needs to reload its configuration.

removeAllModules()

void KCMultiDialog::removeAllModules

(

)

Remove all modules from the dialog.

Definition at line 333 of file kcmultidialog.cpp.

slotApply

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.

slotDefault

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.

slotHelp

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.

slotOk

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.

slotUser1

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