\section{KKey\-Dialog Class Reference}
\label{classKKeyDialog}\index{KKeyDialog@{KKeyDialog}}
Dialog for configuration of {\bf KAction\-Collection}{\rm (p.\,\pageref{classKActionCollection})}, {\bf KAccel}, and {\bf KGlobal\-Accel}.  


{\tt \#include $<$kkeydialog.h$>$}

Inheritance diagram for KKey\-Dialog:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=55pt]{classKKeyDialog__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KKey\-Dialog:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=121pt]{classKKeyDialog__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KKey\-Dialog} (bool b\-Allow\-Letter\-Shortcuts=true, {\bf QWidget} $\ast$parent=0, const char $\ast$name=0)
\item 
virtual {\bf $\sim$KKey\-Dialog} ()
\item 
bool {\bf insert} ({\bf KAction\-Collection} $\ast$)
\item 
bool {\bf insert} ({\bf KAction\-Collection} $\ast$, const {\bf QString} \&title)
\item 
bool {\bf configure} (bool b\-Save\-Settings=true)\label{classKKeyDialog_a4}

\item 
void {\bf commit\-Changes} ()
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static int {\bf configure} ({\bf KAction\-Collection} $\ast$coll, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\item 
static int {\bf configure} ({\bf KAccel} $\ast$keys, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\item 
static int {\bf configure} ({\bf KGlobal\-Accel} $\ast$keys, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\item 
static int {\bf configure} ({\bf KAction\-Collection} $\ast$coll, bool b\-Allow\-Letter\-Shortcuts, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\item 
static int {\bf configure} ({\bf KAccel} $\ast$keys, bool b\-Allow\-Letter\-Shortcuts, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\item 
static int {\bf configure} ({\bf KGlobal\-Accel} $\ast$keys, bool b\-Allow\-Letter\-Shortcuts, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\item 
static KDE\_\-DEPRECATED int {\bf configure\-Keys} ({\bf KAccel} $\ast$keys, bool save\_\-settings=true, {\bf QWidget} $\ast$parent=0)
\item 
static KDE\_\-DEPRECATED int {\bf configure\-Keys} ({\bf KGlobal\-Accel} $\ast$keys, bool save\_\-settings=true, {\bf QWidget} $\ast$parent=0)
\item 
static KDE\_\-DEPRECATED int {\bf configure\-Keys} ({\bf KAction\-Collection} $\ast$coll, const {\bf QString} \&, bool save\_\-settings=true, {\bf QWidget} $\ast$parent=0)
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKKeyDialog_b0}

\end{CompactItemize}


\subsection{Detailed Description}
Dialog for configuration of {\bf KAction\-Collection}{\rm (p.\,\pageref{classKActionCollection})}, {\bf KAccel}, and {\bf KGlobal\-Accel}. 

The KKey\-Dialog class is used for configuring dictionaries of key/action associations for {\bf KAction\-Collection}{\rm (p.\,\pageref{classKActionCollection})}, {\bf KAccel}, and {\bf KGlobal\-Accel}. It uses the {\bf KKey\-Chooser}{\rm (p.\,\pageref{classKKeyChooser})} widget and offers buttons to set all keys to defaults and invoke on-line help.

Three static methods are supplied which provide the most convienient interface to the dialog. The most common and most encouraged use is with {\bf KAction\-Collection}{\rm (p.\,\pageref{classKActionCollection})}.



\footnotesize\begin{verbatim} KKeyDialog::configure( actionCollection() );
\end{verbatim}
\normalsize


\begin{Desc}
\item[Author:]Nicolas Hadacek $<${\tt hadacek@via.ecp.fr}$>$ \end{Desc}




Definition at line 274 of file kkeydialog.h.

\subsection{Constructor \& Destructor Documentation}
\index{KKeyDialog@{KKey\-Dialog}!KKeyDialog@{KKeyDialog}}
\index{KKeyDialog@{KKeyDialog}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KKey\-Dialog::KKey\-Dialog (bool {\em b\-Allow\-Letter\-Shortcuts} = {\tt true}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, const char $\ast$ {\em name} = {\tt 0})}\label{classKKeyDialog_a0}


Constructs a KKey\-Dialog called {\tt name} as a child of {\tt parent}. 

Set {\tt b\-Allow\-Letter\-Shortcuts} to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 1101 of file kkeydialog.cpp.

References KDialog\-Base::default\-Clicked(), KDialog\-Base::enable\-Button(), KConfig\-Base::read\-Size\-Entry(), and KDialog\-Base::set\-Main\-Widget().\index{KKeyDialog@{KKey\-Dialog}!~KKeyDialog@{$\sim$KKeyDialog}}
\index{~KKeyDialog@{$\sim$KKeyDialog}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KKey\-Dialog::$\sim${\bf KKey\-Dialog} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKKeyDialog_a1}


Destructor. 

Deletes all resources used by a KKey\-Dialog object.

Definition at line 1114 of file kkeydialog.cpp.

References KConfig\-Base::write\-Entry().

\subsection{Member Function Documentation}
\index{KKeyDialog@{KKey\-Dialog}!insert@{insert}}
\index{insert@{insert}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KKey\-Dialog::insert ({\bf KAction\-Collection} $\ast$)}\label{classKKeyDialog_a2}


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. \begin{Desc}
\item[Returns:]true :)\end{Desc}


Definition at line 1120 of file kkeydialog.cpp.

References KKey\-Chooser::insert().

Referenced by KXMLGUIFactory::configure\-Shortcuts().\index{KKeyDialog@{KKey\-Dialog}!insert@{insert}}
\index{insert@{insert}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KKey\-Dialog::insert ({\bf KAction\-Collection} $\ast$, const {\bf QString} \& {\em title})}\label{classKKeyDialog_a3}


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.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em title}]the title associated with the collection (if null, the KAbout\-Data::prog\-Name() of the collection's instance is used) \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true :) \end{Desc}
\begin{Desc}
\item[Since:]3.1\end{Desc}


Definition at line 1125 of file kkeydialog.cpp.

References KKey\-Chooser::insert().\index{KKeyDialog@{KKey\-Dialog}!commitChanges@{commitChanges}}
\index{commitChanges@{commitChanges}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KKey\-Dialog::commit\-Changes ()}\label{classKKeyDialog_a5}


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

This method is implicitly called from {\bf configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} if {\tt b\-Save\-Settings} is true.

Definition at line 1142 of file kkeydialog.cpp.

References KKey\-Chooser::commit\-Changes().\index{KKeyDialog@{KKey\-Dialog}!configure@{configure}}
\index{configure@{configure}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Dialog::configure ({\bf KAction\-Collection} $\ast$ {\em coll}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, bool {\em b\-Save\-Settings} = {\tt true})\hspace{0.3cm}{\tt  [static]}}\label{classKKeyDialog_e0}


Pops up a modal dialog for configuring key settings. 

The new shortcut settings will be active if the user presses OK. If {\tt b\-Save\-Settings} if true, the settings will also be saved back to the $\ast$uirc file which they were intially read from. \begin{Desc}
\item[Returns:]Accept if the dialog was closed with OK, Reject otherwise.\end{Desc}


Definition at line 1147 of file kkeydialog.cpp.

Referenced by configure().\index{KKeyDialog@{KKey\-Dialog}!configure@{configure}}
\index{configure@{configure}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Dialog::configure ({\bf KAccel} $\ast$ {\em keys}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, bool {\em b\-Save\-Settings} = {\tt true})\hspace{0.3cm}{\tt  [static]}}\label{classKKeyDialog_e1}


This is an overloaded member function, provided for convenience. 

It behaves essentially like the above function, except that settings are saved to a $\ast$.rc file using {\bf KConfig}.

Definition at line 1152 of file kkeydialog.cpp.

References configure().\index{KKeyDialog@{KKey\-Dialog}!configure@{configure}}
\index{configure@{configure}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Dialog::configure ({\bf KGlobal\-Accel} $\ast$ {\em keys}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, bool {\em b\-Save\-Settings} = {\tt true})\hspace{0.3cm}{\tt  [static]}}\label{classKKeyDialog_e2}


This is an overloaded member function, provided for convenience. 

It behaves essentially like the above function.

Definition at line 1157 of file kkeydialog.cpp.

References configure().\index{KKeyDialog@{KKey\-Dialog}!configure@{configure}}
\index{configure@{configure}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Dialog::configure ({\bf KAction\-Collection} $\ast$ {\em coll}, bool {\em b\-Allow\-Letter\-Shortcuts}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, bool {\em b\-Save\-Settings} = {\tt true})\hspace{0.3cm}{\tt  [static]}}\label{classKKeyDialog_e3}


This is an overloaded member function, provided for convenience. 

It behaves essentially like the above function.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em coll}]the {\bf KAction\-Collection}{\rm (p.\,\pageref{classKActionCollection})} to configure \item[{\em b\-Allow\-Letter\-Shortcuts}]Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts. \item[{\em parent}]the parent widget to attach to \item[{\em b\-Save\-Settings}]if true, the settings will also be saved back to the $\ast$uirc file which they were intially read from.\end{description}
\end{Desc}


Definition at line 1182 of file kkeydialog.cpp.

References configure(), endl(), KKey\-Chooser::insert(), kd\-Debug(), and m\_\-p\-Key\-Chooser.\index{KKeyDialog@{KKey\-Dialog}!configure@{configure}}
\index{configure@{configure}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Dialog::configure ({\bf KAccel} $\ast$ {\em keys}, bool {\em b\-Allow\-Letter\-Shortcuts}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, bool {\em b\-Save\-Settings} = {\tt true})\hspace{0.3cm}{\tt  [static]}}\label{classKKeyDialog_e4}


This is an overloaded member function, provided for convenience. 

It behaves essentially like the above function. 

Definition at line 1162 of file kkeydialog.cpp.

References configure(), KKey\-Chooser::insert(), and m\_\-p\-Key\-Chooser.\index{KKeyDialog@{KKey\-Dialog}!configure@{configure}}
\index{configure@{configure}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Dialog::configure ({\bf KGlobal\-Accel} $\ast$ {\em keys}, bool {\em b\-Allow\-Letter\-Shortcuts}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, bool {\em b\-Save\-Settings} = {\tt true})\hspace{0.3cm}{\tt  [static]}}\label{classKKeyDialog_e5}


This is an overloaded member function, provided for convenience. 

It behaves essentially like the above function. 

Definition at line 1172 of file kkeydialog.cpp.

References configure(), KKey\-Chooser::insert(), and m\_\-p\-Key\-Chooser.\index{KKeyDialog@{KKey\-Dialog}!configureKeys@{configureKeys}}
\index{configureKeys@{configureKeys}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static KDE\_\-DEPRECATED int KKey\-Dialog::configure\-Keys ({\bf KAccel} $\ast$ {\em keys}, bool {\em save\_\-settings} = {\tt true}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0})\hspace{0.3cm}{\tt  [inline, static]}}\label{classKKeyDialog_e6}


\begin{Desc}
\item[{\bf Deprecated}]Obsolete. Please use {\bf KKey\-Dialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} instead \end{Desc}


Definition at line 376 of file kkeydialog.h.\index{KKeyDialog@{KKey\-Dialog}!configureKeys@{configureKeys}}
\index{configureKeys@{configureKeys}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static KDE\_\-DEPRECATED int KKey\-Dialog::configure\-Keys ({\bf KGlobal\-Accel} $\ast$ {\em keys}, bool {\em save\_\-settings} = {\tt true}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0})\hspace{0.3cm}{\tt  [inline, static]}}\label{classKKeyDialog_e7}


\begin{Desc}
\item[{\bf Deprecated}]Obsolete. Please use {\bf KKey\-Dialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} instead \end{Desc}


Definition at line 382 of file kkeydialog.h.\index{KKeyDialog@{KKey\-Dialog}!configureKeys@{configureKeys}}
\index{configureKeys@{configureKeys}!KKeyDialog@{KKey\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static KDE\_\-DEPRECATED int KKey\-Dialog::configure\-Keys ({\bf KAction\-Collection} $\ast$ {\em coll}, const {\bf QString} \&, bool {\em save\_\-settings} = {\tt true}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0})\hspace{0.3cm}{\tt  [inline, static]}}\label{classKKeyDialog_e8}


\begin{Desc}
\item[{\bf Deprecated}]Obsolete. Please use {\bf KKey\-Dialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} instead \end{Desc}


Definition at line 388 of file kkeydialog.h.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
kkeydialog.h\item 
kkeydialog.cpp\end{CompactItemize}
