#include <kkeydialog.h>

Inheritance diagram for KKeyDialog:

Public Member Functions
	KKeyDialog (bool bAllowLetterShortcuts=true, TQWidget parent=0, const char name=0)

virtual	~KKeyDialog ()

bool	insert (TDEActionCollection *)

bool	insert (TDEActionCollection *, const TQString &title)

bool	configure (bool bSaveSettings=true)

void	commitChanges ()

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())

	~KDialogBase ()

void	setButtonBoxOrientation (int orientation)

void	setEscapeButton (ButtonCode id)

virtual void	adjustSize ()

virtual TQSize	sizeHint () const

virtual TQSize	minimumSizeHint () const

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)

Static Public Member Functions
static int	configure (TDEActionCollection coll, TQWidget parent=0, bool bSaveSettings=true)

static int	configure (TDEAccel keys, TQWidget parent=0, bool bSaveSettings=true)

static int	configure (TDEGlobalAccel keys, TQWidget parent=0, bool bSaveSettings=true)

static int	configure (TDEActionCollection coll, bool bAllowLetterShortcuts, TQWidget parent=0, bool bSaveSettings=true)

static int	configure (TDEAccel keys, bool bAllowLetterShortcuts, TQWidget parent=0, bool bSaveSettings=true)

static int	configure (TDEGlobalAccel keys, bool bAllowLetterShortcuts, TQWidget parent=0, bool bSaveSettings=true)

static TDE_DEPRECATED int	configureKeys (TDEAccel keys, bool save_settings=true, TQWidget parent=0)

static TDE_DEPRECATED int	configureKeys (TDEGlobalAccel keys, bool save_settings=true, TQWidget parent=0)

static TDE_DEPRECATED int	configureKeys (TDEActionCollection coll, const TQString &, bool save_settings=true, TQWidget parent=0)

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)

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from KDialogBase
virtual void	keyPressEvent (TQKeyEvent *e)

virtual void	hideEvent (TQHideEvent *)

virtual void	closeEvent (TQCloseEvent *e)

virtual void	virtual_hook (int id, void *data)

virtual void	keyPressEvent (TQKeyEvent *)

virtual void	virtual_hook (int id, void *data)

Additional Inherited Members
Public Types inherited from KDialogBase
enum	ButtonCode { Help = 0x00000001 , Default = 0x00000002 , Ok = 0x00000004 , Apply = 0x00000008 , Try = 0x00000010 , Cancel = 0x00000020 , Close = 0x00000040 , User1 = 0x00000080 , User2 = 0x00000100 , User3 = 0x00000200 , No = 0x00000080 , Yes = 0x00000100 , Details = 0x00000400 , Filler = 0x40000000 , Stretch = 0x80000000 , NoDefault }

enum	ActionButtonStyle { ActionStyle0 =0 , ActionStyle1 , ActionStyle2 , ActionStyle3 , ActionStyle4 , ActionStyleMAX }

enum	DialogType { TreeList = KJanusWidget::TreeList , Tabbed = KJanusWidget::Tabbed , Plain = KJanusWidget::Plain , Swallow = KJanusWidget::Swallow , IconList = KJanusWidget::IconList }

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)

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 ()

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 ()

Detailed Description

Dialog for configuration of TDEActionCollection, TDEAccel, and TDEGlobalAccel.

The KKeyDialog class is used for configuring dictionaries of key/action associations for TDEActionCollection, TDEAccel, and TDEGlobalAccel. It uses the KKeyChooser widget and offers buttons to set all keys to defaults and invoke on-line help.

Several static methods are supplied which provide the most convenient interface to the dialog. The most common and most encouraged use is with TDEActionCollection.

KKeyDialog::configure( actionCollection() );

KKeyDialog::configure

bool configure(bool bSaveSettings=true)

Run the dialog and call commitChanges() if bSaveSettings is true.

Definition: kkeydialog.cpp:1130

Author: Nicolas Hadacek hadac.nosp@m.ek@v.nosp@m.ia.ec.nosp@m.p.fr

Definition at line 274 of file kkeydialog.h.

Constructor & Destructor Documentation

◆ KKeyDialog()

KKeyDialog::KKeyDialog	(	bool	bAllowLetterShortcuts = `true`,
		TQWidget *	parent = `0`,
		const char *	name = `0`
	)

Constructs a KKeyDialog called name as a child of parent.

Set bAllowLetterShortcuts to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 1102 of file kkeydialog.cpp.

◆ ~KKeyDialog()

KKeyDialog::~KKeyDialog ( )

virtual

Destructor.

Deletes all resources used by a KKeyDialog object.

Definition at line 1114 of file kkeydialog.cpp.

Member Function Documentation

◆ commitChanges()

void KKeyDialog::commitChanges ( )

Commit key setting changes so that changed settings actually become active.

This method is implicitly called from configure(bool) if bSaveSettings is true.

Definition at line 1142 of file kkeydialog.cpp.

◆ configure() [1/7]

bool KKeyDialog::configure ( bool bSaveSettings = true )

Run the dialog and call commitChanges() if bSaveSettings is true.

Definition at line 1130 of file kkeydialog.cpp.

◆ configure() [2/7]

int KKeyDialog::configure	(	TDEAccel *	keys,
		bool	bAllowLetterShortcuts,
		TQWidget *	parent = `0`,
		bool	bSaveSettings = `true`
	)

static

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Definition at line 1162 of file kkeydialog.cpp.

◆ configure() [3/7]

int KKeyDialog::configure	(	TDEAccel *	keys,
		TQWidget *	parent = `0`,
		bool	bSaveSettings = `true`
	)

static

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function, except that settings are saved to a *.rc file using TDEConfig.

Definition at line 1152 of file kkeydialog.cpp.

◆ configure() [4/7]

int KKeyDialog::configure	(	TDEActionCollection *	coll,
		bool	bAllowLetterShortcuts,
		TQWidget *	parent = `0`,
		bool	bSaveSettings = `true`
	)

static

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Parameters

coll	the TDEActionCollection to configure
bAllowLetterShortcuts	Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.
parent	the parent widget to attach to
bSaveSettings	if true, the settings will also be saved back to the *uirc file which they were intially read from.

Definition at line 1182 of file kkeydialog.cpp.

◆ configure() [5/7]

int KKeyDialog::configure	(	TDEActionCollection *	coll,
		TQWidget *	parent = `0`,
		bool	bSaveSettings = `true`
	)

static

Pops up a modal dialog for configuring key settings.

The new shortcut settings will be active if the user presses OK. If bSaveSettings if true, the settings will also be saved back to the *uirc file which they were intially read from.

Returns: Accept if the dialog was closed with OK, Reject otherwise.

Definition at line 1147 of file kkeydialog.cpp.

◆ configure() [6/7]

int KKeyDialog::configure	(	TDEGlobalAccel *	keys,
		bool	bAllowLetterShortcuts,
		TQWidget *	parent = `0`,
		bool	bSaveSettings = `true`
	)

static

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Definition at line 1172 of file kkeydialog.cpp.

◆ configure() [7/7]

int KKeyDialog::configure	(	TDEGlobalAccel *	keys,
		TQWidget *	parent = `0`,
		bool	bSaveSettings = `true`
	)

static

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Definition at line 1157 of file kkeydialog.cpp.

◆ configureKeys() [1/3]

static TDE_DEPRECATED int KKeyDialog::configureKeys	(	TDEAccel *	keys,
		bool	save_settings = `true`,
		TQWidget *	parent = `0`
	)

inlinestatic

Deprecated:: Obsolete. Please use KKeyDialog::configure instead

Definition at line 380 of file kkeydialog.h.

◆ configureKeys() [2/3]

static TDE_DEPRECATED int KKeyDialog::configureKeys	(	TDEActionCollection *	coll,
		const TQString &	,
		bool	save_settings = `true`,
		TQWidget *	parent = `0`
	)

inlinestatic

Deprecated:: Obsolete. Please use KKeyDialog::configure instead

Definition at line 392 of file kkeydialog.h.

◆ configureKeys() [3/3]

static TDE_DEPRECATED int KKeyDialog::configureKeys	(	TDEGlobalAccel *	keys,
		bool	save_settings = `true`,
		TQWidget *	parent = `0`
	)

inlinestatic

Deprecated:: Obsolete. Please use KKeyDialog::configure instead

Definition at line 386 of file kkeydialog.h.

◆ insert() [1/2]

bool KKeyDialog::insert ( TDEActionCollection * pColl )

Insert an action collection, i.e.

add all its actions to the ones displayed by the dialog. This method can be useful in applications following the document/view design, with actions in both the document and the view. Simply call insert with the action collections of each one in turn.

Returns: true :)

Definition at line 1120 of file kkeydialog.cpp.

◆ insert() [2/2]

bool KKeyDialog::insert	(	TDEActionCollection *	pColl,
		const TQString &	title
	)

Insert an action collection, i.e. add all its actions to the ones

displayed by the dialog. This method can be useful in applications following the document/view design, with actions in both the document and the view. Simply call insert with the action collections of each one in turn.

@param title the title associated with the collection (if null, the
TDEAboutData::progName() of the collection's instance is used)
@return true :)

Since: 3.1

Definition at line 1125 of file kkeydialog.cpp.

◆ virtual_hook()

void KKeyDialog::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Reimplemented from KDialogBase.

Definition at line 1206 of file kkeydialog.cpp.

The documentation for this class was generated from the following files:

tdeui

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KKeyDialog()

◆ ~KKeyDialog()

Member Function Documentation

◆ commitChanges()

◆ configure() [1/7]

◆ configure() [2/7]

◆ configure() [3/7]

◆ configure() [4/7]

◆ configure() [5/7]

◆ configure() [6/7]

◆ configure() [7/7]

◆ configureKeys() [1/3]

◆ configureKeys() [2/3]

◆ configureKeys() [3/3]

◆ insert() [1/2]

◆ insert() [2/2]

◆ virtual_hook()

tdeui

tdeui