\section{KKey\-Dialog Class Reference}
\label{classKKeyDialog}\index{KKeyDialog@{KKeyDialog}}
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}. 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=131pt]{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)
\begin{CompactList}\small\item\em Constructs a KKey\-Dialog called {\tt name} as a child of {\tt parent}. \item\end{CompactList}\item 
virtual {\bf $\sim$KKey\-Dialog} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
bool {\bf insert} ({\bf KAction\-Collection} $\ast$)
\begin{CompactList}\small\item\em Insert an action collection, i.e. \item\end{CompactList}\item 
bool {\bf insert} ({\bf KAction\-Collection} $\ast$, const  {\bf QString} \&title)
\begin{CompactList}\small\item\em Insert an action collection, i.e. \item\end{CompactList}\item 
bool {\bf configure} (bool b\-Save\-Settings=true)\label{classKKeyDialog_a4}

\item 
void {\bf commit\-Changes} ()
\begin{CompactList}\small\item\em Commit key setting changes so that changed settings actually become active. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
int {\bf configure} ({\bf KAction\-Collection} $\ast$coll, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\begin{CompactList}\small\item\em Pops up a modal dialog for configuring key settings. \item\end{CompactList}\item 
int {\bf configure} ({\bf KAccel} $\ast$keys, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\begin{CompactList}\small\item\em This is an overloaded member function, provided for convenience. \item\end{CompactList}\item 
int {\bf configure} ({\bf KGlobal\-Accel} $\ast$keys, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\begin{CompactList}\small\item\em This is an overloaded member function, provided for convenience. \item\end{CompactList}\item 
int {\bf configure} ({\bf KAction\-Collection} $\ast$coll, bool b\-Allow\-Letter\-Shortcuts, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\begin{CompactList}\small\item\em This is an overloaded member function, provided for convenience. \item\end{CompactList}\item 
int {\bf configure} ({\bf KAccel} $\ast$keys, bool b\-Allow\-Letter\-Shortcuts, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\begin{CompactList}\small\item\em This is an overloaded member function, provided for convenience. \item\end{CompactList}\item 
int {\bf configure} ({\bf KGlobal\-Accel} $\ast$keys, bool b\-Allow\-Letter\-Shortcuts, {\bf QWidget} $\ast$parent=0, bool b\-Save\-Settings=true)
\begin{CompactList}\small\item\em This is an overloaded member function, provided for convenience. \item\end{CompactList}\item 
int {\bf configure\-Keys} ({\bf KAccel} $\ast$keys, bool save\_\-settings=true, {\bf QWidget} $\ast$parent=0)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} Obsolete. \item\end{CompactList}\item 
int {\bf configure\-Keys} ({\bf KGlobal\-Accel} $\ast$keys, bool save\_\-settings=true, {\bf QWidget} $\ast$parent=0)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} Obsolete. \item\end{CompactList}\item 
int {\bf configure\-Keys} ({\bf KAction\-Collection} $\ast$coll, const  {\bf QString} \&, bool save\_\-settings=true, {\bf QWidget} $\ast$parent=0)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} Obsolete. \item\end{CompactList}\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}
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}. Dialog for configuration of {\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})}.

\small\begin{alltt}
 {\bf KKeyDialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})}( actionCollection() );
 \end{alltt}\normalsize 


\begin{Desc}
\item[Version:]\begin{Desc}
\item[Id]{\bf kkeydialog.h}{\rm (p.\,\pageref{kkeydialog_8h})},v 1.72.2.1 2003/04/25 07:38:44 mlaurent Exp \end{Desc}
\end{Desc}
\begin{Desc}
\item[Author:]Nicolas Hadacek $<${\tt hadacek@via.ecp.fr}$>$ \end{Desc}




Definition at line 217 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} = true, {\bf QWidget} $\ast$ {\em parent} = 0, const char $\ast$ {\em name} = 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 878 of file kkeydialog.cpp.

References KGlobal::config(), KDialog\-Base::default\-Clicked(), KDialog\-Base::enable\-Button(), KStd\-Accel::name(), 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 891 of file kkeydialog.cpp.

References KGlobal::config().

\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 897 of file kkeydialog.cpp.

References KKey\-Chooser::insert().\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 902 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 919 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} = 0, bool {\em b\-Save\-Settings} = 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} is 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 924 of file kkeydialog.cpp.

Referenced by configure(), and configure\-Keys().\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} = 0, bool {\em b\-Save\-Settings} = 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 929 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} = 0, bool {\em b\-Save\-Settings} = 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 934 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} = 0, bool {\em b\-Save\-Settings} = 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 b\-Allow\-Letter\-Shortcuts}]Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.\end{description}
\end{Desc}


Definition at line 959 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 KAccel} $\ast$ {\em keys}, bool {\em b\-Allow\-Letter\-Shortcuts}, {\bf QWidget} $\ast$ {\em parent} = 0, bool {\em b\-Save\-Settings} = 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 939 of file kkeydialog.cpp.

References configure(), KKey\-Chooser::insert(), m\_\-p\-Key\-Chooser, and KAccel::update\-Connections().\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} = 0, bool {\em b\-Save\-Settings} = 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 949 of file kkeydialog.cpp.

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


{\bf This class or method is obsolete, it is provided for compatibility only.} Obsolete. 

Please use {\bf KKey\-Dialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} instead

Definition at line 314 of file kkeydialog.h.

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


{\bf This class or method is obsolete, it is provided for compatibility only.} Obsolete. 

Please use {\bf KKey\-Dialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} instead

Definition at line 320 of file kkeydialog.h.

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


{\bf This class or method is obsolete, it is provided for compatibility only.} Obsolete. 

Please use {\bf KKey\-Dialog::configure}{\rm (p.\,\pageref{classKKeyDialog_e0})} instead

Definition at line 326 of file kkeydialog.h.

References configure().

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