\section{KDialog Class Reference}
\label{classKDialog}\index{KDialog@{KDialog}}
Dialog with extended non-modal support and methods for KDE standard compliance.  


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

Inheritance diagram for KDialog:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=187pt]{classKDialog__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KDialog:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=44pt]{classKDialog__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{CompactItemize}
\item 
virtual void {\bf polish} ()
\item 
virtual void {\bf set\-Caption} (const {\bf QString} \&caption)
\item 
virtual void {\bf set\-Plain\-Caption} (const {\bf QString} \&caption)
\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf layout\-Hint\-Changed} ()
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KDialog} ({\bf QWidget} $\ast$parent=0, const char $\ast$name=0, bool modal=false, WFlags f=0)
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static int {\bf margin\-Hint} ()
\item 
static int {\bf spacing\-Hint} ()
\item 
static void {\bf resize\-Layout} ({\bf QWidget} $\ast$widget, int margin, int spacing)
\item 
static void {\bf resize\-Layout} ({\bf QLayout\-Item} $\ast$lay, int margin, int spacing)
\item 
static void {\bf center\-On\-Screen} ({\bf QWidget} $\ast$widget, int screen=-1)
\item 
static bool {\bf avoid\-Area} ({\bf QWidget} $\ast$widget, const {\bf QRect} \&area, int screen=-1)
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf key\-Press\-Event} ({\bf QKey\-Event} $\ast$)\label{classKDialog_b0}

\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKDialog_b1}

\end{CompactItemize}


\subsection{Detailed Description}
Dialog with extended non-modal support and methods for KDE standard compliance. 

Generally, you should not use this class directly, but {\bf KDialog\-Base}{\rm (p.\,\pageref{classKDialogBase})} which inherits KDialog.

If the dialog is non-modal and has a parent, the default keybindings ({\tt escape} = {\tt {\bf reject()}}, {\tt enter} = {\tt {\bf accept()}}, etc.) are disabled.

The {\bf margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})} and {\bf spacing\-Hint()}{\rm (p.\,\pageref{classKDialog_e1})} sizes shall be used whenever you layout the interior of a dialog. One special note. If you make your own action buttons (OK, Cancel etc), the space beteween the buttons shall be {\bf spacing\-Hint()}{\rm (p.\,\pageref{classKDialog_e1})}, whereas the space above, below, to the right and to the left shall be {\bf margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})}. If you add a separator line above the buttons, there shall be a {\bf margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})} between the buttons and the separator and a {\bf margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})} above the separator as well.

\begin{Desc}
\item[See also:]{\bf KDialog\-Base}{\rm (p.\,\pageref{classKDialogBase})} \end{Desc}
\begin{Desc}
\item[Author:]Thomas Tanghus $<${\tt tanghus@earthling.net}$>$, Espen Sand $<${\tt espensa@online.no}$>$ \end{Desc}




Definition at line 52 of file kdialog.h.

\subsection{Constructor \& Destructor Documentation}
\index{KDialog@{KDialog}!KDialog@{KDialog}}
\index{KDialog@{KDialog}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDialog::KDialog ({\bf QWidget} $\ast$ {\em parent} = {\tt 0}, const char $\ast$ {\em name} = {\tt 0}, bool {\em modal} = {\tt false}, WFlags {\em f} = {\tt 0})}\label{classKDialog_a0}


Constructor. 

Takes the same arguments as {\bf QDialog}. 

Definition at line 46 of file kdialog.cpp.

\subsection{Member Function Documentation}
\index{KDialog@{KDialog}!marginHint@{marginHint}}
\index{marginHint@{marginHint}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDialog::margin\-Hint ()\hspace{0.3cm}{\tt  [static]}}\label{classKDialog_e0}


Return the number of pixels you shall use between a dialog edge and the outermost widget(s) according to the {\bf KDE} standard. 



Definition at line 97 of file kdialog.cpp.

Referenced by KDialog\-Base::enable\-Linked\-Help(), KDialog\-Base::get\-Border\-Widths(), KDialog\-Base::get\-Contents\-Rect(), KTip\-Dialog::KTip\-Dialog(), and KDialog\-Base::update\-Geometry().\index{KDialog@{KDialog}!spacingHint@{spacingHint}}
\index{spacingHint@{spacingHint}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDialog::spacing\-Hint ()\hspace{0.3cm}{\tt  [static]}}\label{classKDialog_e1}


Return the number of pixels you shall use between widgets inside a dialog according to the {\bf KDE} standard. 



Definition at line 103 of file kdialog.cpp.

Referenced by KBug\-Report::KBug\-Report(), KColor\-Dialog::KColor\-Dialog(), KFont\-Chooser::KFont\-Chooser(), KLine\-Edit\-Dlg::KLine\-Edit\-Dlg(), KTip\-Dialog::KTip\-Dialog(), KDialog\-Base::make\-Grid\-Main\-Widget(), KDialog\-Base::make\-HBox\-Main\-Widget(), KDialog\-Base::make\-VBox\-Main\-Widget(), KDialog\-Base::set\-Button\-Apply\-Text(), KDialog\-Base::set\-Button\-Cancel\-Text(), KDialog\-Base::set\-Button\-Gui\-Item(), KDialog\-Base::set\-Button\-OKText(), KDialog\-Base::set\-Button\-Text(), and KDialog\-Base::update\-Geometry().\index{KDialog@{KDialog}!resizeLayout@{resizeLayout}}
\index{resizeLayout@{resizeLayout}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::resize\-Layout ({\bf QWidget} $\ast$ {\em widget}, int {\em margin}, int {\em spacing})\hspace{0.3cm}{\tt  [static]}}\label{classKDialog_e2}


Resize every layout manager used in {\tt widget} and its nested children. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em widget}]The widget used. \item[{\em margin}]The new layout margin. \item[{\em spacing}]The new layout spacing. \end{description}
\end{Desc}


Definition at line 133 of file kdialog.cpp.

References QObject::is\-Widget\-Type().

Referenced by resize\-Layout().\index{KDialog@{KDialog}!resizeLayout@{resizeLayout}}
\index{resizeLayout@{resizeLayout}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::resize\-Layout ({\bf QLayout\-Item} $\ast$ {\em lay}, int {\em margin}, int {\em spacing})\hspace{0.3cm}{\tt  [static]}}\label{classKDialog_e3}


Resize every layout associated with {\tt lay} and its children. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em lay}]layout to be resized \item[{\em margin}]The new layout margin \item[{\em spacing}]The new layout spacing \end{description}
\end{Desc}


Definition at line 156 of file kdialog.cpp.

References QLayout\-Iterator::current(), and resize\-Layout().\index{KDialog@{KDialog}!centerOnScreen@{centerOnScreen}}
\index{centerOnScreen@{centerOnScreen}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::center\-On\-Screen ({\bf QWidget} $\ast$ {\em widget}, int {\em screen} = {\tt -1})\hspace{0.3cm}{\tt  [static]}}\label{classKDialog_e4}


Centers {\tt widget} on the desktop, taking multi-head setups into account. 

If {\tt screen} is -1, {\tt widget} will be centered on its current screen (if it was shown already) or on the primary screen. If {\tt screen} is -3, {\tt widget} will be centered on the screen that currently contains the mouse pointer. {\tt screen} will be ignored if a merged display (like Xinerama) is not in use, or merged display placement is not enabled in kdeglobals. \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 195 of file kdialog.cpp.

References QRect::center(), QRect::height(), QRect::width(), QRect::x(), and QRect::y().\index{KDialog@{KDialog}!avoidArea@{avoidArea}}
\index{avoidArea@{avoidArea}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDialog::avoid\-Area ({\bf QWidget} $\ast$ {\em widget}, const {\bf QRect} \& {\em area}, int {\em screen} = {\tt -1})\hspace{0.3cm}{\tt  [static]}}\label{classKDialog_e5}


Places {\tt widget} so that it doesn't cover a certain {\tt area} of the screen. 

This is typically used by the \char`\"{}find dialog\char`\"{} so that the match it finds can be read. For {\tt screen}, see center\-On\-Screen \begin{Desc}
\item[Returns:]true on success (widget doesn't cover area anymore, or never did), false on failure (not enough space found) \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 205 of file kdialog.cpp.

References QRect::bottom(), QRect::height(), QRect::intersects(), QRect::left(), QRect::move\-By(), QRect::r\-Bottom(), QRect::right(), QRect::r\-Right(), QRect::set\-X(), QRect::set\-Y(), QRect::top(), QRect::width(), QRect::x(), and QRect::y().\index{KDialog@{KDialog}!polish@{polish}}
\index{polish@{polish}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::polish ()\hspace{0.3cm}{\tt  [virtual, slot]}}\label{classKDialog_i0}


If the dialog starts with focus in a {\bf QLine\-Edit} child, then call select\-All() on the child. 



Definition at line 109 of file kdialog.cpp.\index{KDialog@{KDialog}!setCaption@{setCaption}}
\index{setCaption@{setCaption}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::set\-Caption (const {\bf QString} \& {\em caption})\hspace{0.3cm}{\tt  [virtual, slot]}}\label{classKDialog_i1}


Make a {\bf KDE} compliant caption. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em caption}]Your caption. Do {\tt not} include the application name in this string. It will be added automatically according to the {\bf KDE} standard. \end{description}
\end{Desc}


Definition at line 115 of file kdialog.cpp.

References set\-Plain\-Caption().

Referenced by KLine\-Edit\-Dlg::get\-Text(), KDialog\-Base::KDialog\-Base(), and KTip\-Dialog::KTip\-Dialog().\index{KDialog@{KDialog}!setPlainCaption@{setPlainCaption}}
\index{setPlainCaption@{setPlainCaption}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::set\-Plain\-Caption (const {\bf QString} \& {\em caption})\hspace{0.3cm}{\tt  [virtual, slot]}}\label{classKDialog_i2}


Make a plain caption without any modifications. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em caption}]Your caption. This is the string that will be displayed in the window title. \end{description}
\end{Desc}


Definition at line 122 of file kdialog.cpp.

References NETWin\-Info::set\-Name().

Referenced by KHelp\-Menu::about\-Application(), KMessage\-Box::detailed\-Error\-WId(), KMessage\-Box::detailed\-Sorry\-WId(), KMessage\-Box::error\-List\-WId(), KAbout\-Dialog::image\-URL(), KMessage\-Box::information\-List\-WId(), KAbout\-Dialog::KAbout\-Dialog(), KMessage\-Box::question\-Yes\-No\-Cancel\-WId(), KMessage\-Box::question\-Yes\-No\-List\-WId(), set\-Caption(), KMessage\-Box::sorry\-WId(), KMessage\-Box::warning\-Continue\-Cancel\-List\-WId(), KMessage\-Box::warning\-Yes\-No\-Cancel\-List\-WId(), and KMessage\-Box::warning\-Yes\-No\-List\-WId().\index{KDialog@{KDialog}!layoutHintChanged@{layoutHintChanged}}
\index{layoutHintChanged@{layoutHintChanged}!KDialog@{KDialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog::layout\-Hint\-Changed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialog_l0}


Emitted when the margin size and/or spacing size have changed. 

Use {\bf margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})} and {\bf spacing\-Hint()}{\rm (p.\,\pageref{classKDialog_e1})} in your slot to get the new values. 

Referenced by KDialog\-Base::KDialog\-Base().

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