\section{KDialog\-Base Class Reference}
\label{classKDialogBase}\index{KDialogBase@{KDialogBase}}
A dialog base class with standard buttons and predefined layouts.  


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

Inheritance diagram for KDialog\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=194pt]{classKDialogBase__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KDialog\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=248pt]{classKDialogBase__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Button\-Code} \{ \par
{\bf Help} =  0x00000001, 
{\bf Default} =  0x00000002, 
{\bf Ok} =  0x00000004, 
{\bf Apply} =  0x00000008, 
\par
{\bf Try} =  0x00000010, 
{\bf Cancel} =  0x00000020, 
{\bf Close} =  0x00000040, 
{\bf User1} =  0x00000080, 
\par
{\bf User2} =  0x00000100, 
{\bf User3} =  0x00000200, 
{\bf No} =  0x00000080, 
{\bf Yes} =  0x00000100, 
\par
{\bf Details} =  0x00000400, 
{\bf Filler} =  0x40000000, 
{\bf Stretch} =  0x80000000, 
{\bf No\-Default}
 \}
\item 
enum {\bf Action\-Button\-Style} \{ \par
{\bf Action\-Style0} = 0, 
{\bf Action\-Style1}, 
{\bf Action\-Style2}, 
{\bf Action\-Style3}, 
\par
{\bf Action\-Style4}, 
{\bf Action\-Style\-MAX}
 \}
\item 
enum {\bf Dialog\-Type} \{ \par
{\bf Tree\-List} =  KJanus\-Widget::Tree\-List, 
{\bf Tabbed} =  KJanus\-Widget::Tabbed, 
{\bf Plain} =  KJanus\-Widget::Plain, 
{\bf Swallow} =  KJanus\-Widget::Swallow, 
\par
{\bf Icon\-List} =  KJanus\-Widget::Icon\-List
 \}
\end{CompactItemize}
\subsection*{Public Slots}
\begin{CompactItemize}
\item 
void {\bf enable\-Button} ({\bf Button\-Code} id, bool state)
\item 
void {\bf enable\-Button\-OK} (bool state)
\item 
void {\bf enable\-Button\-Apply} (bool state)
\item 
void {\bf enable\-Button\-Cancel} (bool state)
\item 
void {\bf enable\-Linked\-Help} (bool state)
\item 
void {\bf delayed\-Destruct} ()
\item 
void {\bf set\-Help\-Link\-Text} (const {\bf QString} \&text)
\item 
void {\bf set\-Help} (const {\bf QString} \&anchor, const {\bf QString} \&appname=QString::null)
\item 
void {\bf help\-Clicked\-Slot} (const {\bf QString} \&)
\item 
void {\bf set\-Details} (bool show\-Details)
\item 
void {\bf set\-Details\-Widget} ({\bf QWidget} $\ast$details\-Widget)
\item 
void {\bf update\-Background} ()
\item 
void {\bf cancel} ()
\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf help\-Clicked} ()
\item 
void {\bf default\-Clicked} ()
\item 
void {\bf user3Clicked} ()
\item 
void {\bf user2Clicked} ()
\item 
void {\bf user1Clicked} ()
\item 
void {\bf apply\-Clicked} ()
\item 
void {\bf try\-Clicked} ()
\item 
void {\bf ok\-Clicked} ()
\item 
void {\bf yes\-Clicked} ()
\item 
void {\bf no\-Clicked} ()
\item 
void {\bf cancel\-Clicked} ()
\item 
void {\bf close\-Clicked} ()
\item 
void {\bf apply} ()
\item 
void {\bf background\-Changed} ()
\item 
void {\bf hidden} ()
\item 
void {\bf finished} ()
\item 
void {\bf about\-To\-Show\-Details} ()
\item 
void {\bf about\-To\-Show\-Page} ({\bf QWidget} $\ast$page)
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KDialog\-Base} ({\bf QWidget} $\ast$parent=0, const char $\ast$name=0, bool modal=true, const {\bf QString} \&caption=QString::null, int button\-Mask=Ok$|$Apply$|$Cancel, {\bf Button\-Code} default\-Button=Ok, bool separator=false, const {\bf KGui\-Item} \&user1={\bf KGui\-Item}(), const {\bf KGui\-Item} \&user2={\bf KGui\-Item}(), const {\bf KGui\-Item} \&user3={\bf KGui\-Item}())
\item 
{\bf KDialog\-Base} (int dialog\-Face, const {\bf QString} \&caption, int button\-Mask, {\bf Button\-Code} default\-Button, {\bf QWidget} $\ast$parent=0, const char $\ast$name=0, bool modal=true, bool separator=false, const {\bf KGui\-Item} \&user1={\bf KGui\-Item}(), const {\bf KGui\-Item} \&user2={\bf KGui\-Item}(), const {\bf KGui\-Item} \&user3={\bf KGui\-Item}())
\item 
{\bf KDialog\-Base} ({\bf KDialog\-Base::Dialog\-Type} dialog\-Face, WFlags f, {\bf QWidget} $\ast$parent=0, const char $\ast$name=0, bool modal=true, const {\bf QString} \&caption=QString::null, int button\-Mask=Ok$|$Apply$|$Cancel, {\bf Button\-Code} default\-Button=Ok, bool separator=false, const {\bf KGui\-Item} \&user1={\bf KGui\-Item}(), const {\bf KGui\-Item} \&user2={\bf KGui\-Item}(), const {\bf KGui\-Item} \&user3={\bf KGui\-Item}())
\item 
{\bf KDialog\-Base} (const {\bf QString} \&caption, int button\-Mask=Yes$|$No$|$Cancel, {\bf Button\-Code} default\-Button=Yes, {\bf Button\-Code} escape\-Button=Cancel, {\bf QWidget} $\ast$parent=0, const char $\ast$name=0, bool modal=true, bool separator=false, const {\bf KGui\-Item} \&yes=KStd\-Gui\-Item::yes(), const {\bf KGui\-Item} \&no=KStd\-Gui\-Item::no(), const {\bf KGui\-Item} \&cancel=KStd\-Gui\-Item::cancel())
\item 
{\bf $\sim$KDialog\-Base} ()
\item 
void {\bf set\-Button\-Box\-Orientation} (int {\bf orientation})
\item 
void {\bf set\-Escape\-Button} ({\bf Button\-Code} id)
\item 
virtual void {\bf adjust\-Size} ()
\item 
virtual {\bf QSize} {\bf size\-Hint} () const \label{classKDialogBase_a8}

\item 
virtual {\bf QSize} {\bf minimum\-Size\-Hint} () const \label{classKDialogBase_a9}

\item 
{\bf QFrame} $\ast$ {\bf plain\-Page} ()
\item 
{\bf QFrame} $\ast$ {\bf add\-Page} (const {\bf QString} \&item\-Name, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QFrame} $\ast$ {\bf add\-Page} (const {\bf QString\-List} \&items, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QVBox} $\ast$ {\bf add\-VBox\-Page} (const {\bf QString} \&item\-Name, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QVBox} $\ast$ {\bf add\-VBox\-Page} (const {\bf QString\-List} \&items, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QHBox} $\ast$ {\bf add\-HBox\-Page} (const {\bf QString} \&item\-Name, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QHBox} $\ast$ {\bf add\-HBox\-Page} (const {\bf QString\-List} \&items, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QGrid} $\ast$ {\bf add\-Grid\-Page} (int n, Orientation dir, const {\bf QString} \&item\-Name, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
{\bf QGrid} $\ast$ {\bf add\-Grid\-Page} (int n, Orientation dir, const {\bf QString\-List} \&items, const {\bf QString} \&header=QString::null, const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
void {\bf set\-Folder\-Icon} (const {\bf QString\-List} \&path, const {\bf QPixmap} \&pixmap)
\item 
{\bf QFrame} $\ast$ {\bf make\-Main\-Widget} ()
\item 
{\bf QVBox} $\ast$ {\bf make\-VBox\-Main\-Widget} ()
\item 
{\bf QHBox} $\ast$ {\bf make\-HBox\-Main\-Widget} ()
\item 
{\bf QGrid} $\ast$ {\bf make\-Grid\-Main\-Widget} (int n, Orientation dir)
\item 
void {\bf enable\-Button\-Separator} (bool state)
\item 
void {\bf show\-Button} ({\bf Button\-Code} id, bool state)
\item 
void {\bf show\-Button\-OK} (bool state)
\item 
void {\bf show\-Button\-Apply} (bool state)
\item 
void {\bf show\-Button\-Cancel} (bool state)
\item 
bool {\bf show\-Page} (int index)
\item 
int {\bf active\-Page\-Index} () const 
\item 
int {\bf page\-Index} ({\bf QWidget} $\ast$widget) const 
\item 
void {\bf set\-Main\-Widget} ({\bf QWidget} $\ast$widget)
\item 
{\bf QWidget} $\ast$ {\bf main\-Widget} ()
\item 
void {\bf disable\-Resize} ()
\item 
void {\bf set\-Initial\-Size} (const {\bf QSize} \&s, bool no\-Resize=false)
\item 
void {\bf inc\-Initial\-Size} (const {\bf QSize} \&s, bool no\-Resize=false)
\item 
{\bf QSize} {\bf config\-Dialog\-Size} (const {\bf QString} \&group\-Name) const 
\item 
{\bf QSize} {\bf config\-Dialog\-Size} ({\bf KConfig} \&config, const {\bf QString} \&group\-Name) const 
\item 
void {\bf save\-Dialog\-Size} (const {\bf QString} \&group\-Name, bool global=false)
\item 
void {\bf save\-Dialog\-Size} ({\bf KConfig} \&config, const {\bf QString} \&group\-Name, bool global=false) const 
\item 
void {\bf set\-Button\-OK} (const {\bf KGui\-Item} \&item=KStd\-Gui\-Item::ok())
\item 
void {\bf set\-Button\-OKText} (const {\bf QString} \&text=QString::null, const {\bf QString} \&tooltip=QString::null, const {\bf QString} \&quickhelp=QString::null) KDE\_\-DEPRECATED
\item 
void {\bf set\-Button\-Apply} (const {\bf KGui\-Item} \&item=KStd\-Gui\-Item::apply())
\item 
void {\bf set\-Button\-Apply\-Text} (const {\bf QString} \&text=QString::null, const {\bf QString} \&tooltip=QString::null, const {\bf QString} \&quickhelp=QString::null) KDE\_\-DEPRECATED
\item 
void {\bf set\-Button\-Cancel} (const {\bf KGui\-Item} \&item=KStd\-Gui\-Item::cancel())
\item 
void {\bf set\-Button\-Cancel\-Text} (const {\bf QString} \&text=QString::null, const {\bf QString} \&tooltip=QString::null, const {\bf QString} \&quickhelp=QString::null) KDE\_\-DEPRECATED
\item 
void {\bf set\-Button\-Text} ({\bf Button\-Code} id, const {\bf QString} \&text)
\item 
void {\bf set\-Button\-Tip} ({\bf Button\-Code} id, const {\bf QString} \&text)
\item 
void {\bf set\-Button\-Whats\-This} ({\bf Button\-Code} id, const {\bf QString} \&text)
\item 
void {\bf set\-Button\-Gui\-Item} ({\bf Button\-Code} id, const {\bf KGui\-Item} \&item)
\item 
void {\bf set\-Tree\-List\-Auto\-Resize} (bool state)
\item 
void {\bf set\-Show\-Icons\-In\-Tree\-List} (bool state)
\item 
void {\bf set\-Root\-Is\-Decorated} (bool state)
\item 
void {\bf unfold\-Tree\-List} (bool persist=false)
\item 
void {\bf add\-Widget\-Below\-List} ({\bf QWidget} $\ast$widget)
\item 
void {\bf add\-Button\-Below\-List} (const {\bf QString} \&text, {\bf QObject} $\ast$recv, const char $\ast$slot)
\item 
void {\bf add\-Button\-Below\-List} (const {\bf KGui\-Item} \&guiitem, {\bf QObject} $\ast$recv, const char $\ast$slot)
\item 
void {\bf set\-Icon\-List\-All\-Visible} (bool state)
\item 
void {\bf show\-Tile} (bool state)
\item 
void {\bf get\-Border\-Widths} (int \&ulx, int \&uly, int \&lrx, int \&lry) const KDE\_\-DEPRECATED
\item 
{\bf QRect} {\bf get\-Contents\-Rect} () const KDE\_\-DEPRECATED
\item 
{\bf QSize} {\bf calculate\-Size} (int w, int h) const 
\item 
{\bf QString} {\bf help\-Link\-Text} () const 
\item 
{\bf QPush\-Button} $\ast$ {\bf action\-Button} ({\bf Button\-Code} id)
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static bool {\bf have\-Background\-Tile} ()
\item 
static const {\bf QPixmap} $\ast$ {\bf background\-Tile} ()
\item 
static const {\bf QPixmap} $\ast$ {\bf get\-Background\-Tile} () KDE\_\-DEPRECATED
\item 
static void {\bf set\-Background\-Tile} (const {\bf QPixmap} $\ast$pix)
\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
virtual void {\bf slot\-Help} ()
\item 
virtual void {\bf slot\-Default} ()
\item 
virtual void {\bf slot\-Details} ()
\item 
virtual void {\bf slot\-User3} ()
\item 
virtual void {\bf slot\-User2} ()
\item 
virtual void {\bf slot\-User1} ()
\item 
virtual void {\bf slot\-Ok} ()
\item 
virtual void {\bf slot\-Apply} ()
\item 
virtual void {\bf slot\-Try} ()
\item 
virtual void {\bf slot\-Yes} ()
\item 
virtual void {\bf slot\-No} ()
\item 
virtual void {\bf slot\-Cancel} ()
\item 
virtual void {\bf slot\-Close} ()
\item 
virtual void {\bf apply\-Pressed} ()
\item 
void {\bf update\-Geometry} ()
\item 
void {\bf slot\-Delayed\-Destruct} ()
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf key\-Press\-Event} ({\bf QKey\-Event} $\ast$e)
\item 
virtual void {\bf hide\-Event} ({\bf QHide\-Event} $\ast$)
\item 
virtual void {\bf close\-Event} ({\bf QClose\-Event} $\ast$e)
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKDialogBase_b3}

\end{CompactItemize}


\subsection{Detailed Description}
A dialog base class with standard buttons and predefined layouts. 

Provides basic functionality needed by nearly all dialogs.

It offers the standard action buttons you'd expect to find in a dialog as well as the capability to define at most three configurable buttons. You can define a main widget that contains your specific dialog layout or you can use a predefined layout. Currently, {\tt Tree\-List/Paged}, {\tt Tabbed}, {\tt Plain}, {\tt Swallow} and {\tt Icon\-List} mode layouts (faces) are available.

The class takes care of the geometry management. You only need to define a minimum size for the widget you want to use as the main widget.

You can set a background tile (pixmap) for parts of the dialog. The tile you select is shared by all instances of this class in your application so that they all get the same look and feel.

There is a tutorial available on {\tt http://developer.kde.org/} (NOT YET) that contains copy/paste examples as well a screenshots on how to use this class.

{\bf Standard buttons (action buttons):}\par


You select which buttons should be displayed, but you do not choose the order in which they are displayed. This ensures a standard interface in {\bf KDE}. The button order can be changed, but this ability is only available for a central {\bf KDE} control tool. The following buttons are available: OK, Cancel/Close, Apply/Try, Default, Help and three user definable buttons: User1, User2 and User3. You must specify the text of the User\-N buttons. Each button has a virtual slot so you can overload the method when required. The default slots emit a signal as well, so you can choose to connect a signal instead of overriding the slot. The default implementation of {\bf slot\-Help()}{\rm (p.\,\pageref{classKDialogBase_j0})} will automatically enable the help system if you have provided a path to the help text. {\bf slot\-Cancel()}{\rm (p.\,\pageref{classKDialogBase_j11})} and {\bf slot\-Close()}{\rm (p.\,\pageref{classKDialogBase_j12})} will run {\bf QDialog::reject()} while {\bf slot\-Ok()}{\rm (p.\,\pageref{classKDialogBase_j6})} will run {\bf QDialog::accept()}. You define a default button in the constructor.

If you don't want any buttons at all because your dialog is special in some way, then set the button\-Mask argument in the constructor to zero (0). The optional button box separator line should not be enabled in this case. Note that the KDialog\-Base will animate a button press when the user press Escape. The button that is enabled is either Cancel, Close or the button that is defined by {\bf set\-Escape\-Button()}{\rm (p.\,\pageref{classKDialogBase_a6})} The animation will not take place when the button\-Mask is zero. Your custom dialog code should reimplement the key\-Press\-Event and animate the cancel button so that the dialog behaves like regular dialogs. NOTE: None of the regular slots (like {\bf slot\-Ok()}{\rm (p.\,\pageref{classKDialogBase_j6})} ) or signals that are related to the standard action buttons will be used when you don't use these buttons.

{\bf sect Dialog shapes:}\par


You can either use one of the prebuilt, easy to use, faces or define your own main widget. The dialog provides ready to use Tree\-List, Tabbed, Plain, Swallow and Icon\-List faces. KDialog\-Base uses the {\bf KJanus\-Widget}{\rm (p.\,\pageref{classKJanusWidget})} class internally to accomplish this. If you use Tree\-List, Tabbed or Icon\-List mode, then add pages with {\bf add\-Page()}{\rm (p.\,\pageref{classKDialogBase_a11})}.

Pages that have been added can be removed again by simply deleting the page.

If you want complete control of how the dialog contents should look, then you can define a main widget by using {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})}. You only need to set the minimum size of that widget and the dialog will resize itself to fit this minimum size. The dialog is resizeable, but cannot be made smaller than its minimum size.

{\bf Layout:}\par


The dialog consists of a help area on top (becomes visible if you define a help path and use {\bf enable\-Linked\-Help()}{\rm (p.\,\pageref{classKDialogBase_i4})}), the main area which is the built-in dialog face or your own widget in the middle and by default a button box at the bottom. The button box can also be placed at the right edge (to the right of the main widget). Use {\bf set\-Button\-Box\-Orientation()}{\rm (p.\,\pageref{classKDialogBase_a5})} to control this behavior. A separator can be placed above the button box (or to the left when the button box is at the right edge). Normally you specify that you want a separator in the constructor, but you can use {\bf enable\-Button\-Separator()}{\rm (p.\,\pageref{classKDialogBase_a24})} as well.

{\bf Standard compliance:}\par


The class is derived from {\bf KDialog}{\rm (p.\,\pageref{classKDialog})}, so you get automatic access to the {\bf KDialog::margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})}, {\bf KDialog::spacing\-Hint()}{\rm (p.\,\pageref{classKDialog_e1})} and the extended {\bf KDialog::set\-Caption()}{\rm (p.\,\pageref{classKDialog_i1})} method. NOTE: The main widget you use will be positioned inside the dialog using a margin (or border) equal to {\bf KDialog::margin\-Hint()}{\rm (p.\,\pageref{classKDialog_e0})}. You should not add a margin yourself, since one will be added automatically. The example below (from kedit) shows how you use the top level widget and its layout. The second argument (the border) to {\bf QVBox\-Layout} is 0. This situation is valid for add\-Page , add\-VBox\-Page , add\-HBox\-Page , add\-Grid\-Page , make\-Main\-Widget , make\-VBox\-Main\-Widget , make\-HBox\-Main\-Widget and make\-Grid\-Main\-Widget as well.

Example:



\footnotesize\begin{verbatim} UrlDlg::UrlDlg( QWidget *parent, const QString& caption,
                 const QString& urltext)
   : KDialogBase( parent, "urldialog", true, caption,
                  KDialogBase::Ok|KDialogBase::Cancel, KDialogBase::Ok, true )
 {
   QWidget *page = new QWidget( this );
   setMainWidget(page);
   QVBoxLayout *topLayout = new QVBoxLayout( page, 0, spacingHint() );

   QLabel *label = new QLabel( caption, page, "caption" );
   topLayout->addWidget( label );

   lineedit = new QLineEdit( urltext, page, "lineedit" );
   lineedit->setMinimumWidth(fontMetrics().maxWidth()*20);
   topLayout->addWidget( lineedit );

   topLayout->addStretch(10);
 }
\end{verbatim}
\normalsize


If you use {\bf make\-VBox\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a21})}, then the dialog above can be made simpler but you lose the ability to add a stretchable area:



\footnotesize\begin{verbatim} UrlDlg::UrlDlg( QWidget *parent, const QString& caption,
                 const QString& urltext)
 : KDialogBase( parent, "urldialog", true, caption,
                KDialogBase::Ok|KDialogBase::Cancel, KDialogBase::Ok, true )
 {
   QVBox *page = makeVBoxMainWidget();
   QLabel *label = new QLabel( caption, page, "caption" );

   lineedit = new QLineEdit( urltext, page, "lineedit" );
   lineedit->setMinimumWidth(fontMetrics().maxWidth()*20);
 }
\end{verbatim}
\normalsize


This class can be used in many ways. Note that most {\bf KDE} ui widgets and many of {\bf KDE} core applications use the KDialog\-Base so for more inspiration you should study the code for these.

\begin{Desc}
\item[Author:]Mirko Boehm ({\tt mirko@kde.org}) and Espen Sand ({\tt espen@kde.org}) \end{Desc}




Definition at line 193 of file kdialogbase.h.

\subsection{Member Enumeration Documentation}
\index{KDialogBase@{KDialog\-Base}!ButtonCode@{ButtonCode}}
\index{ButtonCode@{ButtonCode}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf enum} {\bf KDialog\-Base::Button\-Code}}\label{classKDialogBase_w27}


\begin{itemize}
\item {\tt Help} - Show Help button. \end{itemize}


\begin{itemize}
\item {\tt Default} - Show Default button. \item {\tt Details} - Show Details button. \item {\tt Ok} - Show Ok button. \item {\tt Apply} - Show Apply button. \item {\tt Try} - Show Try button. \item {\tt Cancel} - Show Cancel button. \item {\tt Close} - Show Close button. \item {\tt User1} - Show User-defined button 1. \item {\tt User2} - Show User-defined button 2. \item {\tt User3} - Show User-defined button 3. \item {\tt No} - Show No button. \item {\tt Yes} - Show Yes button. \item {\tt Stretch} - Used internally. Ignored when used in a constructor. \item {\tt Filler} - Used internally. Ignored when used in a constructor. \item {\tt No\-Default} - Used when specifying a default button; indicates that no button should be marked by default. \end{itemize}
\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{NoDefault@{NoDefault}!KDialogBase@{KDialogBase}}\index{KDialogBase@{KDialogBase}!NoDefault@{NoDefault}}\item[{\em 
No\-Default\label{classKDialogBase_w27w15}
}]\begin{Desc}
\item[Since:]3.3 \end{Desc}
\end{description}
\end{Desc}



Definition at line 218 of file kdialogbase.h.\index{KDialogBase@{KDialog\-Base}!DialogType@{DialogType}}
\index{DialogType@{DialogType}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf enum} {\bf KDialog\-Base::Dialog\-Type}}\label{classKDialogBase_w29}


\begin{itemize}
\item {\tt Tree\-List} - A dialog with a tree on the left side and a representation of the contents on the right side. \end{itemize}


\begin{itemize}
\item {\tt Tabbed} - A dialog using a {\bf QTab\-Widget}. \item {\tt Plain} - A normal dialog. Use {\bf plain\-Page()}{\rm (p.\,\pageref{classKDialogBase_a10})} as parent for widgets. \item {\tt Swallow} - Simplifes the usage of existing widgets. You specify the widget to be displayed by {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})}. \item {\tt Icon\-List} - A dialog with an iconlist on the left side and a representation of the contents on the right side. \end{itemize}


Definition at line 258 of file kdialogbase.h.

\subsection{Constructor \& Destructor Documentation}
\index{KDialogBase@{KDialog\-Base}!KDialogBase@{KDialogBase}}
\index{KDialogBase@{KDialogBase}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDialog\-Base::KDialog\-Base ({\bf QWidget} $\ast$ {\em parent} = {\tt 0}, const char $\ast$ {\em name} = {\tt 0}, bool {\em modal} = {\tt true}, const {\bf QString} \& {\em caption} = {\tt QString::null}, int {\em button\-Mask} = {\tt Ok$|$Apply$|$Cancel}, {\bf Button\-Code} {\em default\-Button} = {\tt Ok}, bool {\em separator} = {\tt false}, const {\bf KGui\-Item} \& {\em user1} = {\tt {\bf KGui\-Item}()}, const {\bf KGui\-Item} \& {\em user2} = {\tt {\bf KGui\-Item}()}, const {\bf KGui\-Item} \& {\em user3} = {\tt {\bf KGui\-Item}()})}\label{classKDialogBase_a0}


Constructor for the standard mode where you must specify the main widget with {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} . 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em parent}]Parent of the dialog. \item[{\em name}]Dialog name (for internal use only) \item[{\em modal}]Controls dialog modality. If {\tt false}, the rest of the program interface (example: other dialogs) is accessible while the dialog is open. \item[{\em caption}]The dialog caption. Do not specify the application name here. The class will take care of that. \item[{\em button\-Mask}]Specifies which buttons will be visible. If zero (0) no button box will be made. \item[{\em default\-Button}]Specifies which button will be marked as the default. Use Button\-Code::No\-Default to indicate that no button should be marked as the default button. \item[{\em separator}]If {\tt true}, a separator line is drawn between the action buttons and the main widget. \item[{\em user1}]User button1 item. \item[{\em user2}]User button2 item. \item[{\em user3}]User button3 item. \end{description}
\end{Desc}


Definition at line 99 of file kdialogbase.cpp.

References enable\-Button\-Separator(), KDialog::layout\-Hint\-Changed(), KDialog::set\-Caption(), and update\-Geometry().\index{KDialogBase@{KDialog\-Base}!KDialogBase@{KDialogBase}}
\index{KDialogBase@{KDialogBase}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDialog\-Base::KDialog\-Base (int {\em dialog\-Face}, const {\bf QString} \& {\em caption}, int {\em button\-Mask}, {\bf Button\-Code} {\em default\-Button}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, const char $\ast$ {\em name} = {\tt 0}, bool {\em modal} = {\tt true}, bool {\em separator} = {\tt false}, const {\bf KGui\-Item} \& {\em user1} = {\tt {\bf KGui\-Item}()}, const {\bf KGui\-Item} \& {\em user2} = {\tt {\bf KGui\-Item}()}, const {\bf KGui\-Item} \& {\em user3} = {\tt {\bf KGui\-Item}()})}\label{classKDialogBase_a1}


In KDE4 a WFlag paramater should be added after modal and next function can be removed. 

Constructor for the predefined layout mode where you specify the kind of layout (face).

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dialog\-Face}]You can use Tree\-List, Tabbed, Plain, Swallow or Icon\-List. \item[{\em caption}]The dialog caption. Do not specify the application name here. The class will take care of that. \item[{\em button\-Mask}]Specifies which buttons will be visible. If zero (0) no button box will be made. \item[{\em default\-Button}]Specifies which button will be marked as the default. Use Button\-Code::No\-Default to indicate that no button should be marked as the default button. \item[{\em parent}]Parent of the dialog. \item[{\em name}]Dialog name (for internal use only). \item[{\em modal}]Controls dialog modality. If {\tt false}, the rest of the program interface (example: other dialogs) is accessible while the dialog is open. \item[{\em separator}]If {\tt true}, a separator line is drawn between the action buttons and the main widget. \item[{\em user1}]User button1 text item. \item[{\em user2}]User button2 text item. \item[{\em user3}]User button3 text item. \end{description}
\end{Desc}


Definition at line 121 of file kdialogbase.cpp.

References about\-To\-Show\-Page(), enable\-Button\-Separator(), KJanus\-Widget::is\-Valid(), KDialog::layout\-Hint\-Changed(), KDialog::set\-Caption(), and update\-Geometry().\index{KDialogBase@{KDialog\-Base}!KDialogBase@{KDialogBase}}
\index{KDialogBase@{KDialogBase}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDialog\-Base::KDialog\-Base ({\bf KDialog\-Base::Dialog\-Type} {\em dialog\-Face}, WFlags {\em f}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, const char $\ast$ {\em name} = {\tt 0}, bool {\em modal} = {\tt true}, const {\bf QString} \& {\em caption} = {\tt QString::null}, int {\em button\-Mask} = {\tt Ok$|$Apply$|$Cancel}, {\bf Button\-Code} {\em default\-Button} = {\tt Ok}, bool {\em separator} = {\tt false}, const {\bf KGui\-Item} \& {\em user1} = {\tt {\bf KGui\-Item}()}, const {\bf KGui\-Item} \& {\em user2} = {\tt {\bf KGui\-Item}()}, const {\bf KGui\-Item} \& {\em user3} = {\tt {\bf KGui\-Item}()})}\label{classKDialogBase_a2}


Constructor for the predefined layout mode where you specify the kind of layout (face). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dialog\-Face}]You can use Tree\-List, Tabbed, Plain, Swallow or Icon\-List. \item[{\em f}]widget flags, by default it is just set to WStyle\_\-Dialog\-Border. \item[{\em caption}]The dialog caption. Do not specify the application name here. The class will take care of that. \item[{\em parent}]Parent of the dialog. \item[{\em name}]Dialog name (for internal use only). \item[{\em modal}]Controls dialog modality. If {\tt false}, the rest of the program interface (example: other dialogs) is accessible while the dialog is open. \item[{\em button\-Mask}]Specifies which buttons will be visible. If zero (0) no button box will be made. \item[{\em default\-Button}]Specifies which button will be marked as the default. Use Button\-Code::No\-Default to indicate that no button should be marked as the default button. \item[{\em separator}]If {\tt true}, a separator line is drawn between the action buttons and the main widget. \item[{\em user1}]User button1 text item. \item[{\em user2}]User button2 text item. \item[{\em user3}]User button3 text item. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]: 3.2 \end{Desc}


Definition at line 149 of file kdialogbase.cpp.

References about\-To\-Show\-Page(), enable\-Button\-Separator(), KJanus\-Widget::is\-Valid(), KDialog::layout\-Hint\-Changed(), KDialog::set\-Caption(), and update\-Geometry().\index{KDialogBase@{KDialog\-Base}!KDialogBase@{KDialogBase}}
\index{KDialogBase@{KDialogBase}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDialog\-Base::KDialog\-Base (const {\bf QString} \& {\em caption}, int {\em button\-Mask} = {\tt Yes$|$No$|$Cancel}, {\bf Button\-Code} {\em default\-Button} = {\tt Yes}, {\bf Button\-Code} {\em escape\-Button} = {\tt Cancel}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0}, const char $\ast$ {\em name} = {\tt 0}, bool {\em modal} = {\tt true}, bool {\em separator} = {\tt false}, const {\bf KGui\-Item} \& {\em yes} = {\tt KStdGuiItem::yes()}, const {\bf KGui\-Item} \& {\em no} = {\tt KStdGuiItem::no()}, const {\bf KGui\-Item} \& {\em cancel} = {\tt KStdGuiItem::cancel()})}\label{classKDialogBase_a3}


Constructor for a message box mode where the {\tt button\-Mask} can only contain Yes, No, or Cancel. 

If you need other names you can rename the buttons with {\bf set\-Button\-Text()}{\rm (p.\,\pageref{classKDialogBase_a47})}. The dialog box is not resizable by default but this can be changed by {\bf set\-Initial\-Size()}{\rm (p.\,\pageref{classKDialogBase_a35})}. If you select 'modal' to be true, the dialog will return Yes, No, or Cancel when closed otherwise you can use the signals {\bf yes\-Clicked()}{\rm (p.\,\pageref{classKDialogBase_l8})}, {\bf no\-Clicked()}{\rm (p.\,\pageref{classKDialogBase_l9})}, or {\bf cancel\-Clicked()}{\rm (p.\,\pageref{classKDialogBase_l10})} to determine the state.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em caption}]The dialog caption. Do not specify the application name here. The class will take care of that. \item[{\em button\-Mask}]Specifies which buttons will be visible. If zero (0) no button box will be made. \item[{\em default\-Button}]Specifies which button will be marked as the default. Use Button\-Code::No\-Default to indicate that no button should be marked as the default button. \item[{\em escape\-Button}]Specifies which button will be activated by when the dialog receives a {\tt Key\_\-Escape} keypress. \item[{\em parent}]Parent of the dialog. \item[{\em name}]Dialog name (for internal use only). \item[{\em modal}]Controls dialog modality. If {\tt false}, the rest of the program interface (example: other dialogs) is accessible while the dialog is open. \item[{\em separator}]If {\tt true}, a separator line is drawn between the action buttons and the main widget. \item[{\em yes}]Text to use for the first button (defaults to i18n(\char`\"{}Yes\char`\"{})) \item[{\em no}]Text to use for the second button (defaults to i18n(\char`\"{}No\char`\"{})) \item[{\em cancel}]Text to use for the third button (defaults to i18n(\char`\"{}Cancel\char`\"{})) \end{description}
\end{Desc}


Definition at line 178 of file kdialogbase.cpp.

References cancel(), enable\-Button\-Separator(), QString::is\-Empty(), KDialog::layout\-Hint\-Changed(), set\-Button\-Cancel(), KDialog::set\-Caption(), KGui\-Item::text(), and update\-Geometry().\index{KDialogBase@{KDialog\-Base}!~KDialogBase@{$\sim$KDialogBase}}
\index{~KDialogBase@{$\sim$KDialogBase}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDialog\-Base::$\sim${\bf KDialog\-Base} ()}\label{classKDialogBase_a4}


Destructor. 



Definition at line 211 of file kdialogbase.cpp.

\subsection{Member Function Documentation}
\index{KDialogBase@{KDialog\-Base}!setButtonBoxOrientation@{setButtonBoxOrientation}}
\index{setButtonBoxOrientation@{setButtonBoxOrientation}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Box\-Orientation (int {\em orientation})}\label{classKDialogBase_a5}


Sets the orientation of the button box. 

It can be {\tt Vertical} or {\tt Horizontal}. If {\tt Horizontal} (default), the button box is positioned at the bottom of the dialog. If {\tt Vertical} it will be placed at the right edge of the dialog.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em orientation}]The button box orientation. \end{description}
\end{Desc}


Definition at line 345 of file kdialogbase.cpp.

References enable\-Linked\-Help(), and KSeparator::set\-Orientation().\index{KDialogBase@{KDialog\-Base}!setEscapeButton@{setEscapeButton}}
\index{setEscapeButton@{setEscapeButton}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Escape\-Button ({\bf Button\-Code} {\em id})}\label{classKDialogBase_a6}


Sets the button that will be activated when the Escape key is pressed. 

Normally you should not use this function. By default, the Escape key is mapped to either the Cancel or the Close button if one of these buttons are defined. The user expects that Escape will cancel an operation so use this function with caution.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The button code. \end{description}
\end{Desc}


Definition at line 365 of file kdialogbase.cpp.\index{KDialogBase@{KDialog\-Base}!adjustSize@{adjustSize}}
\index{adjustSize@{adjustSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::adjust\-Size ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDialogBase_a7}


Adjust the size of the dialog to fit the contents just before {\bf QDialog::exec()} or {\bf QDialog::show()} is called. 

This method will not be called if the dialog has been explicitly resized before showing it. 

Definition at line 427 of file kdialogbase.cpp.

Referenced by inc\-Initial\-Size(), set\-Details(), and set\-Initial\-Size().\index{KDialogBase@{KDialog\-Base}!plainPage@{plainPage}}
\index{plainPage@{plainPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QFrame} $\ast$ KDialog\-Base::plain\-Page ()}\label{classKDialogBase_a10}


Retrieve the empty page when the predefined layout is used in {\tt Plain} mode. 

This widget must be used as the toplevel widget of your dialog code.

\begin{Desc}
\item[Returns:]The widget or 0 if the predefined layout mode is not {\tt Plain} or if you don't use any predefined layout. \end{Desc}


Definition at line 420 of file kdialogbase.cpp.

References KJanus\-Widget::plain\-Page().

Referenced by KBug\-Report::KBug\-Report(), KLine\-Edit\-Dlg::KLine\-Edit\-Dlg(), and KProgress\-Dialog::KProgress\-Dialog().\index{KDialogBase@{KDialog\-Base}!addPage@{addPage}}
\index{addPage@{addPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QFrame} $\ast$ KDialog\-Base::add\-Page (const {\bf QString} \& {\em item\-Name}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a11}


Add a page to the dialog when the class is used in {\tt Tree\-List} , {\tt Icon\-List} or {\tt Tabbed} mode. 

The returned widget must be used as the toplevel widget for this particular page. Note: The returned frame widget has no layout manager associated with it. In order to use it you must create a layout yourself as the example below illustrates:



\footnotesize\begin{verbatim} QFrame *page = addPage( i18n("Layout") );
 QVBoxLayout *topLayout = new QVBoxLayout( page, 0, KDialog::spacingHint() );
 QLabel *label = new QLabel( i18n("Layout type"), page );
 topLayout->addWidget( label );
 ..
\end{verbatim}
\normalsize


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em item\-Name}]String used in the list or as tab item name. \item[{\em header}]Header text use in the list modes. Ignored in {\tt Tabbed} mode. If empty, the item text is used instead. \item[{\em pixmap}]Used in {\tt Icon\-List} mode. You should prefer a pixmap with size 32x32 pixels.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The page widget which must be used as the toplevel widget for the page. \end{Desc}


Definition at line 1296 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Page().\index{KDialogBase@{KDialog\-Base}!addPage@{addPage}}
\index{addPage@{addPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QFrame} $\ast$ KDialog\-Base::add\-Page (const {\bf QString\-List} \& {\em items}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a12}


This is like {\bf add\-Page()}{\rm (p.\,\pageref{classKDialogBase_a11})} just above, with the difference that the first element is a list of strings. 

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the {\tt Tree\-List} face. Later this may be added for the {\tt Icon\-List} face too. In other faces than the {\tt Tree\-List}, all the strings except the last one is ignored. 

Definition at line 1302 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Page().\index{KDialogBase@{KDialog\-Base}!addVBoxPage@{addVBoxPage}}
\index{addVBoxPage@{addVBoxPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QVBox} $\ast$ KDialog\-Base::add\-VBox\-Page (const {\bf QString} \& {\em item\-Name}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a13}


Add a page to the dialog when the class is used in {\tt Tree\-List}, {\tt Icon\-List} or {\tt Tabbed} mode. 

The returned widget must be used as the toplevel widget for this particular page. The widget contains a {\bf QVBox\-Layout} layout so the widget children are lined up vertically. You can use it as follows:



\footnotesize\begin{verbatim} QVBox *page = addVBoxPage( i18n("Layout") );
 QLabel *label = new QLabel( i18n("Layout type"), page );
 ..
\end{verbatim}
\normalsize


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em item\-Name}]String used in the list or as tab item name. \item[{\em header}]Header text use in the list modes. Ignored in {\tt Tabbed} mode. If empty, the item text is used instead. \item[{\em pixmap}]Used in {\tt Icon\-List} mode. You should prefer a pixmap with size 32x32 pixels.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The page widget which must be used as the toplevel widget for the page. \end{Desc}


Definition at line 1309 of file kdialogbase.cpp.

References KJanus\-Widget::add\-VBox\-Page().\index{KDialogBase@{KDialog\-Base}!addVBoxPage@{addVBoxPage}}
\index{addVBoxPage@{addVBoxPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QVBox} $\ast$ KDialog\-Base::add\-VBox\-Page (const {\bf QString\-List} \& {\em items}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a14}


This is like {\bf add\-VBox\-Page()}{\rm (p.\,\pageref{classKDialogBase_a13})} just above, with the difference that the first element is a list of strings. 

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the {\tt Tree\-List} face. Later this may be added for the {\tt Icon\-List} face too. In other faces than the {\tt Tree\-List}, all the strings except the last one is ignored. 

Definition at line 1315 of file kdialogbase.cpp.

References KJanus\-Widget::add\-VBox\-Page().\index{KDialogBase@{KDialog\-Base}!addHBoxPage@{addHBoxPage}}
\index{addHBoxPage@{addHBoxPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QHBox} $\ast$ KDialog\-Base::add\-HBox\-Page (const {\bf QString} \& {\em item\-Name}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a15}


Add a page to the dialog when the class is used in {\tt Tree\-List}, {\tt Icon\-List} or {\tt Tabbed} mode. 

The returned widget must be used as the toplevel widget for this particular page. The widget contains a {\bf QHBox\-Layout} layout so the widget children are lined up horizontally. You can use it as follows:

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em item\-Name}]String used in the list or as tab item name. \item[{\em header}]Header text use in the list modes. Ignored in Tabbed mode. If empty, the item text is used instead. \item[{\em pixmap}]Used in Icon\-List mode. You should prefer a pixmap with size 32x32 pixels.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The page widget which must be used as the toplevel widget for the page. \end{Desc}


Definition at line 1322 of file kdialogbase.cpp.

References KJanus\-Widget::add\-HBox\-Page().\index{KDialogBase@{KDialog\-Base}!addHBoxPage@{addHBoxPage}}
\index{addHBoxPage@{addHBoxPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QHBox} $\ast$ KDialog\-Base::add\-HBox\-Page (const {\bf QString\-List} \& {\em items}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a16}


This is like {\bf add\-HBox\-Page()}{\rm (p.\,\pageref{classKDialogBase_a15})} just above, with the difference that the first element is a list of strings. 

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the {\tt Tree\-List} face. Later this may be added for the {\tt Icon\-List} face too. In other faces than the {\tt Tree\-List}, all the strings except the last one is ignored. 

Definition at line 1329 of file kdialogbase.cpp.

References KJanus\-Widget::add\-HBox\-Page().\index{KDialogBase@{KDialog\-Base}!addGridPage@{addGridPage}}
\index{addGridPage@{addGridPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QGrid} $\ast$ KDialog\-Base::add\-Grid\-Page (int {\em n}, Orientation {\em dir}, const {\bf QString} \& {\em item\-Name}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a17}


Add a page to the dialog when the class is used in {\tt Tree\-List}, {\tt Icon\-List} or {\tt Tabbed} mode. 

The returned widget must be used as the toplevel widget for this particular page. The widget contains a {\bf QGrid\-Layout} layout so the widget children are positioned in a grid.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em n}]Specifies the number of columns if {\tt dir} is Qt::Horizontal or the number of rows if {\tt dir} is Qt::Vertical. \item[{\em dir}]Can be Qt::Horizontal or Qt::Vertical. \item[{\em item\-Name}]String used in the list or as tab item name. \item[{\em header}]Header text use in the list modes {\tt Ignored} in {\tt Tabbed} mode. If empty, the item text is used instead. \item[{\em pixmap}]Used in {\tt Icon\-List} mode. You should prefer a pixmap with size 32x32 pixels.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The page widget which must be used as the toplevel widget for the page. \end{Desc}


Definition at line 1337 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Grid\-Page().\index{KDialogBase@{KDialog\-Base}!addGridPage@{addGridPage}}
\index{addGridPage@{addGridPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QGrid} $\ast$ KDialog\-Base::add\-Grid\-Page (int {\em n}, Orientation {\em dir}, const {\bf QString\-List} \& {\em items}, const {\bf QString} \& {\em header} = {\tt QString::null}, const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDialogBase_a18}


This is like {\bf add\-Grid\-Page()}{\rm (p.\,\pageref{classKDialogBase_a17})} just above, with the difference that the first element is a list of strings. 

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the {\tt Tree\-List} face. Later this may be added for the {\tt Icon\-List} face too. In other faces than the {\tt Tree\-List}, all the strings except the last one is ignored. 

Definition at line 1344 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Grid\-Page().\index{KDialogBase@{KDialog\-Base}!setFolderIcon@{setFolderIcon}}
\index{setFolderIcon@{setFolderIcon}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Folder\-Icon (const {\bf QString\-List} \& {\em path}, const {\bf QPixmap} \& {\em pixmap})}\label{classKDialogBase_a19}


Sets the icon used in {\tt Tree\-List} Mode for the given path. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em path}]The path for which this icon should be shown. \item[{\em pixmap}]The icon used. \end{description}
\end{Desc}


Definition at line 1351 of file kdialogbase.cpp.

References KJanus\-Widget::set\-Folder\-Icon().\index{KDialogBase@{KDialog\-Base}!makeMainWidget@{makeMainWidget}}
\index{makeMainWidget@{makeMainWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QFrame} $\ast$ KDialog\-Base::make\-Main\-Widget ()}\label{classKDialogBase_a20}


Make a main widget. 

The function will make a {\bf QFrame} widget and use {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} to register it. You can {\em not\/} use this function more than once, {\em not\/} if you have already defined a main widget with {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} and {\em not\/} if you have used the constructor where you define the face ({\tt Plain}, {\tt Swallow}, {\tt Tabbed}, {\tt Tree\-List}).

\begin{Desc}
\item[Returns:]The main widget or 0 if any of the rules described above were broken. \end{Desc}


Definition at line 1359 of file kdialogbase.cpp.

References main\-Widget(), and set\-Main\-Widget().\index{KDialogBase@{KDialog\-Base}!makeVBoxMainWidget@{makeVBoxMainWidget}}
\index{makeVBoxMainWidget@{makeVBoxMainWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QVBox} $\ast$ KDialog\-Base::make\-VBox\-Main\-Widget ()}\label{classKDialogBase_a21}


Make a main widget. 

The function will make a {\bf QVBox} widget and use {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} to register it. You {\em can\/} use this function more than once, but {\em not\/} if you have already defined a main widget with {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} and {\em not\/} if you have used the constructor where you define the face ({\tt Plain}, {\tt Swallow}, {\tt Tabbed}, {\tt Tree\-List}, {\tt Icon\-List}).

\begin{Desc}
\item[Returns:]The main widget or 0 if any of the rules described above were broken. \end{Desc}


Definition at line 1373 of file kdialogbase.cpp.

References main\-Widget(), set\-Main\-Widget(), and KDialog::spacing\-Hint().\index{KDialogBase@{KDialog\-Base}!makeHBoxMainWidget@{makeHBoxMainWidget}}
\index{makeHBoxMainWidget@{makeHBoxMainWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QHBox} $\ast$ KDialog\-Base::make\-HBox\-Main\-Widget ()}\label{classKDialogBase_a22}


Make a main widget. 

The function will make a {\bf QHBox} widget and use {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} to register it. You can {\em not\/} use this function more than once, {\em not\/} if you have already defined a main widget with {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} and {\tt not} if you have used the constructor where you define the face ({\tt Plain}, {\tt Swallow}, {\tt Tabbed}, {\tt Tree\-List}, {\tt Icon\-List}).

\begin{Desc}
\item[Returns:]The main widget or 0 if any of the rules described above were broken. \end{Desc}


Definition at line 1388 of file kdialogbase.cpp.

References main\-Widget(), set\-Main\-Widget(), QHBox::set\-Spacing(), and KDialog::spacing\-Hint().\index{KDialogBase@{KDialog\-Base}!makeGridMainWidget@{makeGridMainWidget}}
\index{makeGridMainWidget@{makeGridMainWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QGrid} $\ast$ KDialog\-Base::make\-Grid\-Main\-Widget (int {\em n}, Orientation {\em dir})}\label{classKDialogBase_a23}


Make a main widget. 

The function will make a {\bf QGrid} widget and use {\bf set\-Main\-Widget()}{\rm (p.\,\pageref{classKDialogBase_a32})} to register it. You can {\em not\/} use this function more than once, {\em not\/} if you have already defined a main widget with set\-Main\-Widget and {\em not\/} if you have used the constructor where you define the face (Plain, Swallow, Tabbed, Tree\-List, Icon\-List).

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em n}]Specifies the number of columns if 'dir' is Qt::Horizontal or the number of rows if 'dir' is Qt::Vertical. \item[{\em dir}]Can be Qt::Horizontal or Qt::Vertical.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The main widget or 0 if any of the rules described above were broken. \end{Desc}


Definition at line 1403 of file kdialogbase.cpp.

References main\-Widget(), set\-Main\-Widget(), QGrid::set\-Spacing(), and KDialog::spacing\-Hint().\index{KDialogBase@{KDialog\-Base}!enableButtonSeparator@{enableButtonSeparator}}
\index{enableButtonSeparator@{enableButtonSeparator}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::enable\-Button\-Separator (bool {\em state})}\label{classKDialogBase_a24}


Hide or display the a separator line drawn between the action buttons an the main widget. 



Definition at line 389 of file kdialogbase.cpp.

References KSeparator::set\-Orientation().

Referenced by KDialog\-Base().\index{KDialogBase@{KDialog\-Base}!showButton@{showButton}}
\index{showButton@{showButton}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::show\-Button ({\bf Button\-Code} {\em id}, bool {\em state})}\label{classKDialogBase_a25}


Hide or display a general action button. 

Only buttons that have been created in the constructor can be displayed. This method will not create a new button.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]Button identifier. \item[{\em state}]true display the button(s). \end{description}
\end{Desc}


Definition at line 866 of file kdialogbase.cpp.

References action\-Button().

Referenced by KProgress\-Dialog::KProgress\-Dialog(), show\-Button\-Apply(), show\-Button\-Cancel(), and show\-Button\-OK().\index{KDialogBase@{KDialog\-Base}!showButtonOK@{showButtonOK}}
\index{showButtonOK@{showButtonOK}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::show\-Button\-OK (bool {\em state})}\label{classKDialogBase_a26}


Hide or display the OK button. 

The OK button must have been created in the constructor to be displayed.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]If {\tt true}, display the button(s). \end{description}
\end{Desc}


Definition at line 876 of file kdialogbase.cpp.

References show\-Button().

Referenced by KBug\-Report::KBug\-Report().\index{KDialogBase@{KDialog\-Base}!showButtonApply@{showButtonApply}}
\index{showButtonApply@{showButtonApply}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::show\-Button\-Apply (bool {\em state})}\label{classKDialogBase_a27}


Hide or display the Apply button. 

The Apply button must have been created in the constructor to be displayed.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]true display the button(s). \end{description}
\end{Desc}


Definition at line 882 of file kdialogbase.cpp.

References show\-Button().\index{KDialogBase@{KDialog\-Base}!showButtonCancel@{showButtonCancel}}
\index{showButtonCancel@{showButtonCancel}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::show\-Button\-Cancel (bool {\em state})}\label{classKDialogBase_a28}


Hide or display the Cancel button. 

The Cancel button must have been created in the constructor to be displayed.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]{\tt true} display the button(s). \end{description}
\end{Desc}


Definition at line 888 of file kdialogbase.cpp.

References show\-Button().

Referenced by KProgress\-Dialog::show\-Cancel\-Button().\index{KDialogBase@{KDialog\-Base}!showPage@{showPage}}
\index{showPage@{showPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDialog\-Base::show\-Page (int {\em index})}\label{classKDialogBase_a29}


Sets the page with {\tt index} to be displayed. 

This method will only work when the dialog is using the predefined shape of Tree\-List, Icon\-List or Tabbed.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em index}]Index of the page to be shown. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]{\tt true} if the page is shown, {\tt false} otherwise. \end{Desc}


Definition at line 1470 of file kdialogbase.cpp.

References KJanus\-Widget::show\-Page().\index{KDialogBase@{KDialog\-Base}!activePageIndex@{activePageIndex}}
\index{activePageIndex@{activePageIndex}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDialog\-Base::active\-Page\-Index () const}\label{classKDialogBase_a30}


Returns the index of the active page. 

This method will only work when the dialog is using the predefined shape of Tabbed, Tree\-List or Icon\-List.

\begin{Desc}
\item[Returns:]The page index or -1 if there is no active page. \end{Desc}


Definition at line 1476 of file kdialogbase.cpp.

References KJanus\-Widget::active\-Page\-Index().\index{KDialogBase@{KDialog\-Base}!pageIndex@{pageIndex}}
\index{pageIndex@{pageIndex}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDialog\-Base::page\-Index ({\bf QWidget} $\ast$ {\em widget}) const}\label{classKDialogBase_a31}


Returns the index of a page created with {\bf add\-Page()}{\rm (p.\,\pageref{classKDialogBase_a11})}, {\bf add\-VBox\-Page()}{\rm (p.\,\pageref{classKDialogBase_a13})}, {\bf add\-HBox\-Page()}{\rm (p.\,\pageref{classKDialogBase_a15})} or {\bf add\-Grid\-Page()}{\rm (p.\,\pageref{classKDialogBase_a17})}. 

You can can compare this index with the value returned from {\bf active\-Page\-Index()}{\rm (p.\,\pageref{classKDialogBase_a30})} if you need to do some page specific actions in your code.

The returned index will never change so you can safely use this function once and save the value.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em widget}]The widget returned by {\bf add\-Page()}{\rm (p.\,\pageref{classKDialogBase_a11})}, {\bf add\-VBox\-Page()}{\rm (p.\,\pageref{classKDialogBase_a13})}, {\bf add\-HBox\-Page()}{\rm (p.\,\pageref{classKDialogBase_a15})} or {\bf add\-Grid\-Page()}{\rm (p.\,\pageref{classKDialogBase_a17})}.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The index or -1 if the face is not Tabbed, Tree\-List or Icon\-List \end{Desc}


Definition at line 1482 of file kdialogbase.cpp.

References KJanus\-Widget::page\-Index().\index{KDialogBase@{KDialog\-Base}!setMainWidget@{setMainWidget}}
\index{setMainWidget@{setMainWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Main\-Widget ({\bf QWidget} $\ast$ {\em widget})}\label{classKDialogBase_a32}


Sets the main user definable widget. 

If the dialog is using the predefined Swallow mode, the widget will be reparented to the internal swallow control widget. If the dialog is being used in the standard mode then the {\tt widget} must have the dialog as parent.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em widget}]The widget to be displayed as main widget. If it is 0, then the dialog will show an empty space of 100x100 pixels instead. \end{description}
\end{Desc}


Definition at line 1431 of file kdialogbase.cpp.

References QFocus\-Data::last(), and KJanus\-Widget::set\-Swallowed\-Widget().

Referenced by KHelp\-Menu::about\-Application(), KAbout\-Dialog::KAbout\-Dialog(), KColor\-Dialog::KColor\-Dialog(), KFont\-Dialog::KFont\-Dialog(), KKey\-Dialog::KKey\-Dialog(), KPixmap\-Region\-Selector\-Dialog::KPixmap\-Region\-Selector\-Dialog(), make\-Grid\-Main\-Widget(), make\-HBox\-Main\-Widget(), make\-Main\-Widget(), and make\-VBox\-Main\-Widget().\index{KDialogBase@{KDialog\-Base}!mainWidget@{mainWidget}}
\index{mainWidget@{mainWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget} $\ast$ KDialog\-Base::main\-Widget ()}\label{classKDialogBase_a33}


Returns the main widget if any. 

\begin{Desc}
\item[Returns:]The current main widget. Can be 0 if no widget has been defined. \end{Desc}


Definition at line 1464 of file kdialogbase.cpp.

Referenced by make\-Grid\-Main\-Widget(), make\-HBox\-Main\-Widget(), make\-Main\-Widget(), make\-VBox\-Main\-Widget(), and KColor\-Dialog::set\-Default\-Color().\index{KDialogBase@{KDialog\-Base}!disableResize@{disableResize}}
\index{disableResize@{disableResize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::disable\-Resize ()}\label{classKDialogBase_a34}


Convenience method. 

Freezes the dialog size using the minimum size of the dialog. This method should only be called right before {\bf show()} or {\bf exec()}. 

Definition at line 531 of file kdialogbase.cpp.

Referenced by KHelp\-Menu::about\-Application(), KColor\-Dialog::KColor\-Dialog(), and KColor\-Dialog::set\-Default\-Color().\index{KDialogBase@{KDialog\-Base}!setInitialSize@{setInitialSize}}
\index{setInitialSize@{setInitialSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Initial\-Size (const {\bf QSize} \& {\em s}, bool {\em no\-Resize} = {\tt false})}\label{classKDialogBase_a35}


Convenience method. 

Sets the initial dialog size.

This method should only be called right before {\bf show()} or {\bf exec()}. The initial size will be ignored if smaller than the dialog's minimum size.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]Startup size. \item[{\em no\-Resize}]If {\tt true} the dialog cannot be resized. \end{description}
\end{Desc}


Definition at line 537 of file kdialogbase.cpp.

References adjust\-Size().\index{KDialogBase@{KDialog\-Base}!incInitialSize@{incInitialSize}}
\index{incInitialSize@{incInitialSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::inc\-Initial\-Size (const {\bf QSize} \& {\em s}, bool {\em no\-Resize} = {\tt false})}\label{classKDialogBase_a36}


Convenience method. 

Add a size to the default minimum size of a dialog.

This method should only be called right before {\bf show()} or {\bf exec()}.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]Size added to minimum size. \item[{\em no\-Resize}]If {\tt true} the dialog cannot be resized. \end{description}
\end{Desc}


Definition at line 545 of file kdialogbase.cpp.

References adjust\-Size().\index{KDialogBase@{KDialog\-Base}!configDialogSize@{configDialogSize}}
\index{configDialogSize@{configDialogSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QSize} KDialog\-Base::config\-Dialog\-Size (const {\bf QString} \& {\em group\-Name}) const}\label{classKDialogBase_a37}


read the dialogs size from the configuration according to the screen size. 

If no size is saved for one dimension of the screen, size\-Hint() is returned.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em group\-Name}]Name of the group to read from. The old group of {\bf KGlobal::config} is preserved. \end{description}
\end{Desc}


Definition at line 1741 of file kdialogbase.cpp.\index{KDialogBase@{KDialog\-Base}!configDialogSize@{configDialogSize}}
\index{configDialogSize@{configDialogSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QSize} KDialog\-Base::config\-Dialog\-Size ({\bf KConfig} \& {\em config}, const {\bf QString} \& {\em group\-Name}) const}\label{classKDialogBase_a38}


read the dialogs size from the configuration according to the screen size. 

If no size is saved for one dimension of the screen, size\-Hint() is returned.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em config}]The {\bf KConfig} object to read from \item[{\em group\-Name}]Name of the group to read from. The old group of {\bf KGlobal::config} is preserved. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 1747 of file kdialogbase.cpp.

References QApplication::desktop(), QRect::height(), QSize::height(), QRect::width(), and QSize::width().\index{KDialogBase@{KDialog\-Base}!saveDialogSize@{saveDialogSize}}
\index{saveDialogSize@{saveDialogSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::save\-Dialog\-Size (const {\bf QString} \& {\em group\-Name}, bool {\em global} = {\tt false})}\label{classKDialogBase_a39}


save the dialogs size dependant on the screen dimension either to the global or application config file. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em group\-Name}]The group to which the dialogs size is saved. See config\-Dialog\-Size to read the size. \item[{\em global}]Set to true if the entry should go to the global config rather than to the applications config. Default is false. \end{description}
\end{Desc}


Definition at line 1765 of file kdialogbase.cpp.\index{KDialogBase@{KDialog\-Base}!saveDialogSize@{saveDialogSize}}
\index{saveDialogSize@{saveDialogSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::save\-Dialog\-Size ({\bf KConfig} \& {\em config}, const {\bf QString} \& {\em group\-Name}, bool {\em global} = {\tt false}) const}\label{classKDialogBase_a40}


save the dialogs size dependant on the screen dimension. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em config}]The {\bf KConfig} object to write to. \item[{\em group\-Name}]The group to which the dialogs size is saved. See config\-Dialog\-Size to read the size. \item[{\em global}]Set to true if the entry should go to the global config. Default is false. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 1771 of file kdialogbase.cpp.

References QApplication::desktop(), QSize::height(), QRect::height(), QString::number(), QSize::width(), and QRect::width().\index{KDialogBase@{KDialog\-Base}!setButtonOK@{setButtonOK}}
\index{setButtonOK@{setButtonOK}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-OK (const {\bf KGui\-Item} \& {\em item} = {\tt KStdGuiItem::ok()})}\label{classKDialogBase_a41}


Sets the appearance of the OK button. 

If the default parameters are used (that is, if no {\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})} is given) KStd\-Gui\-Item::ok() is used.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em item}]{\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 916 of file kdialogbase.cpp.

References set\-Button\-Gui\-Item().

Referenced by KBug\-Report::KBug\-Report().\index{KDialogBase@{KDialog\-Base}!setButtonOKText@{setButtonOKText}}
\index{setButtonOKText@{setButtonOKText}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-OKText (const {\bf QString} \& {\em text} = {\tt QString::null}, const {\bf QString} \& {\em tooltip} = {\tt QString::null}, const {\bf QString} \& {\em quickhelp} = {\tt QString::null})}\label{classKDialogBase_a42}


\begin{Desc}
\item[{\bf Deprecated}]. Use set\-Button\-Ok() instead. \end{Desc}
Sets the text of the OK button.

If the default parameters are used (that is, if no parameters are given) the standard texts are set: The button shows \char`\"{}OK\char`\"{}, the tooltip contains \char`\"{}Accept settings.\char`\"{} (internationalized) and the quickhelp text explains the standard behavior of the OK button in settings dialogs.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]Button text. \item[{\em tooltip}]Tooltip text. \item[{\em quickhelp}]Quick help text. \end{description}
\end{Desc}


Definition at line 894 of file kdialogbase.cpp.

References action\-Button(), QWhats\-This::add(), QTool\-Tip::add(), QPush\-Button::set\-Text(), and KDialog::spacing\-Hint().\index{KDialogBase@{KDialog\-Base}!setButtonApply@{setButtonApply}}
\index{setButtonApply@{setButtonApply}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Apply (const {\bf KGui\-Item} \& {\em item} = {\tt KStdGuiItem::apply()})}\label{classKDialogBase_a43}


Sets the appearance of the Apply button. 

If the default parameters are used (that is, if no {\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})} is given) KStd\-Gui\-Item::apply() is used.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em item}]{\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 946 of file kdialogbase.cpp.

References set\-Button\-Gui\-Item().\index{KDialogBase@{KDialog\-Base}!setButtonApplyText@{setButtonApplyText}}
\index{setButtonApplyText@{setButtonApplyText}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Apply\-Text (const {\bf QString} \& {\em text} = {\tt QString::null}, const {\bf QString} \& {\em tooltip} = {\tt QString::null}, const {\bf QString} \& {\em quickhelp} = {\tt QString::null})}\label{classKDialogBase_a44}


\begin{Desc}
\item[{\bf Deprecated}]. Use {\bf set\-Button\-Apply()}{\rm (p.\,\pageref{classKDialogBase_a43})} instead. \end{Desc}
Sets the text of the Apply button.

If the default parameters are used (that is, if no parameters are given) the standard texts are set: The button shows \char`\"{}Apply\char`\"{}, the tooltip contains \char`\"{}Apply settings.\char`\"{} (internationalized) and the quickhelp text explains the standard behavior of the apply button in settings dialogs.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]Button text. \item[{\em tooltip}]Tooltip text. \item[{\em quickhelp}]Quick help text. \end{description}
\end{Desc}


Definition at line 922 of file kdialogbase.cpp.

References action\-Button(), QWhats\-This::add(), QTool\-Tip::add(), QPush\-Button::set\-Text(), and KDialog::spacing\-Hint().\index{KDialogBase@{KDialog\-Base}!setButtonCancel@{setButtonCancel}}
\index{setButtonCancel@{setButtonCancel}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Cancel (const {\bf KGui\-Item} \& {\em item} = {\tt KStdGuiItem::cancel()})}\label{classKDialogBase_a45}


Sets the appearance of the Cancel button. 

If the default parameters are used (that is, if no {\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})} is given) KStd\-Gui\-Item::cancel() is used.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em item}]{\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 970 of file kdialogbase.cpp.

References set\-Button\-Gui\-Item().

Referenced by KBug\-Report::KBug\-Report(), KDialog\-Base(), and KProgress\-Dialog::set\-Button\-Text().\index{KDialogBase@{KDialog\-Base}!setButtonCancelText@{setButtonCancelText}}
\index{setButtonCancelText@{setButtonCancelText}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Cancel\-Text (const {\bf QString} \& {\em text} = {\tt QString::null}, const {\bf QString} \& {\em tooltip} = {\tt QString::null}, const {\bf QString} \& {\em quickhelp} = {\tt QString::null})}\label{classKDialogBase_a46}


\begin{Desc}
\item[{\bf Deprecated}]. Use {\bf set\-Button\-Cancel()}{\rm (p.\,\pageref{classKDialogBase_a45})} instead. \end{Desc}
Sets the text of the Cancel button.

If the default parameters are used (that is, if no parameters are given) the standard texts are set: The button shows \char`\"{}Cancel\char`\"{}, everything else will not be set.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]Button text. \item[{\em tooltip}]Tooltip text. \item[{\em quickhelp}]Quick help text. \end{description}
\end{Desc}


Definition at line 952 of file kdialogbase.cpp.

References action\-Button(), QWhats\-This::add(), QTool\-Tip::add(), QPush\-Button::set\-Text(), and KDialog::spacing\-Hint().\index{KDialogBase@{KDialog\-Base}!setButtonText@{setButtonText}}
\index{setButtonText@{setButtonText}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Text ({\bf Button\-Code} {\em id}, const {\bf QString} \& {\em text})}\label{classKDialogBase_a47}


Sets the text of any button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The button identifier. \item[{\em text}]Button text. \end{description}
\end{Desc}


Definition at line 986 of file kdialogbase.cpp.

References action\-Button(), set\-Details(), QPush\-Button::set\-Text(), and KDialog::spacing\-Hint().

Referenced by set\-Details().\index{KDialogBase@{KDialog\-Base}!setButtonTip@{setButtonTip}}
\index{setButtonTip@{setButtonTip}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Tip ({\bf Button\-Code} {\em id}, const {\bf QString} \& {\em text})}\label{classKDialogBase_a48}


Sets the tooltip text of any button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The button identifier. \item[{\em text}]Button text. \end{description}
\end{Desc}


Definition at line 1003 of file kdialogbase.cpp.

References action\-Button(), QTool\-Tip::add(), and QTool\-Tip::remove().\index{KDialogBase@{KDialog\-Base}!setButtonWhatsThis@{setButtonWhatsThis}}
\index{setButtonWhatsThis@{setButtonWhatsThis}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Whats\-This ({\bf Button\-Code} {\em id}, const {\bf QString} \& {\em text})}\label{classKDialogBase_a49}


Sets the \char`\"{}What's this?\char`\"{} text of any button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The button identifier. \item[{\em text}]Button text. \end{description}
\end{Desc}


Definition at line 1016 of file kdialogbase.cpp.

References action\-Button(), QWhats\-This::add(), and QWhats\-This::remove().\index{KDialogBase@{KDialog\-Base}!setButtonGuiItem@{setButtonGuiItem}}
\index{setButtonGuiItem@{setButtonGuiItem}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Button\-Gui\-Item ({\bf Button\-Code} {\em id}, const {\bf KGui\-Item} \& {\em item})}\label{classKDialogBase_a50}


Sets the {\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})} directly for the button instead of using 3 methods to set the text, tooltip and whatsthis strings. 

This also allows to set an icon for the button which is otherwise not possible for the extra buttons beside Ok, Cancel and Apply.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The button identifier. \item[{\em item}]The {\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})} for the button.\end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 975 of file kdialogbase.cpp.

References action\-Button(), KPush\-Button::set\-Gui\-Item(), and KDialog::spacing\-Hint().

Referenced by set\-Button\-Apply(), set\-Button\-Cancel(), and set\-Button\-OK().\index{KDialogBase@{KDialog\-Base}!setTreeListAutoResize@{setTreeListAutoResize}}
\index{setTreeListAutoResize@{setTreeListAutoResize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Tree\-List\-Auto\-Resize (bool {\em state})}\label{classKDialogBase_a51}


This function has only effect in Tree\-List mode. 

Defines how the tree list widget is resized when the dialog is resized horizontally. By default the tree list keeps its width when the dialog becomes wider.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]The resize mode. If false (default) the tree list keeps its current width when the dialog becomes wider. \end{description}
\end{Desc}


Definition at line 1037 of file kdialogbase.cpp.

References KJanus\-Widget::set\-Tree\-List\-Auto\-Resize().\index{KDialogBase@{KDialog\-Base}!setShowIconsInTreeList@{setShowIconsInTreeList}}
\index{setShowIconsInTreeList@{setShowIconsInTreeList}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Show\-Icons\-In\-Tree\-List (bool {\em state})}\label{classKDialogBase_a52}


This function has only effect in Tree\-List mode. 

This tells the widgets whether the icons given in the add\-Page, add\-VBox\-Page, add\-HBox\-Page, or add\-Grid\-Page methods should be shown in the Tree\-List.

Note: This method must be called before calling any of the methods which add icons to the page.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]If true the icons are shown. \end{description}
\end{Desc}


Definition at line 1045 of file kdialogbase.cpp.

References KJanus\-Widget::set\-Show\-Icons\-In\-Tree\-List().\index{KDialogBase@{KDialog\-Base}!setRootIsDecorated@{setRootIsDecorated}}
\index{setRootIsDecorated@{setRootIsDecorated}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Root\-Is\-Decorated (bool {\em state})}\label{classKDialogBase_a53}


This function has only effect in Tree\-List mode. 

This tells the widgets whether the root should be decorated. For details see {\bf QList\-View::set\-Root\-Is\-Decorated}

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]Root will be decorated if true. \end{description}
\end{Desc}


Definition at line 1053 of file kdialogbase.cpp.

References KJanus\-Widget::set\-Root\-Is\-Decorated().\index{KDialogBase@{KDialog\-Base}!unfoldTreeList@{unfoldTreeList}}
\index{unfoldTreeList@{unfoldTreeList}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::unfold\-Tree\-List (bool {\em persist} = {\tt false})}\label{classKDialogBase_a54}


This function has only effect in Tree\-List mode. 

This tells the Tree\-List to unfold the whole tree so that all entries are visible.

If the list is empty when you call this method newly created entries will not automatically be opened. If the {\tt persist} flag is set opened entries cannot be closed again, though.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em persist}]If true the tree always stays unfolded. \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 1061 of file kdialogbase.cpp.

References KJanus\-Widget::unfold\-Tree\-List().\index{KDialogBase@{KDialog\-Base}!addWidgetBelowList@{addWidgetBelowList}}
\index{addWidgetBelowList@{addWidgetBelowList}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::add\-Widget\-Below\-List ({\bf QWidget} $\ast$ {\em widget})}\label{classKDialogBase_a55}


Add a widget at the bottom of the Tree\-List/Icon\-List. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em widget}]The widget to be added. It will be reparented into the {\bf KJanus\-Widget}{\rm (p.\,\pageref{classKJanusWidget})}, therefor it will be deleted with the {\bf KJanus\-Widget}{\rm (p.\,\pageref{classKJanusWidget})}, too. To be on the save side just don't keep the pointer to this widget. \end{description}
\end{Desc}


Definition at line 1067 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Widget\-Below\-List().\index{KDialogBase@{KDialog\-Base}!addButtonBelowList@{addButtonBelowList}}
\index{addButtonBelowList@{addButtonBelowList}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::add\-Button\-Below\-List (const {\bf QString} \& {\em text}, {\bf QObject} $\ast$ {\em recv}, const char $\ast$ {\em slot})}\label{classKDialogBase_a56}


Add a button at the bottom of the Tree\-List/Icon\-List. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]The text on the Push\-Button. \item[{\em recv}]The object that is to receive the signal when the button is clicked. \item[{\em slot}]The slot to connect to the clicked signal of the button.\end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 1073 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Button\-Below\-List().\index{KDialogBase@{KDialog\-Base}!addButtonBelowList@{addButtonBelowList}}
\index{addButtonBelowList@{addButtonBelowList}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::add\-Button\-Below\-List (const {\bf KGui\-Item} \& {\em guiitem}, {\bf QObject} $\ast$ {\em recv}, const char $\ast$ {\em slot})}\label{classKDialogBase_a57}


The same as the above function, but with a {\bf KGui\-Item}{\rm (p.\,\pageref{classKGuiItem})} providing the text and icon for the button at the bottom of the Tree\-List/Icon\-List. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em guiitem}]The text and icon on the Push\-Button. \item[{\em recv}]The object that is to receive the signal when the button is clicked. \item[{\em slot}]The slot to connect to the clicked signal of the button.\end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 1079 of file kdialogbase.cpp.

References KJanus\-Widget::add\-Button\-Below\-List().\index{KDialogBase@{KDialog\-Base}!setIconListAllVisible@{setIconListAllVisible}}
\index{setIconListAllVisible@{setIconListAllVisible}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Icon\-List\-All\-Visible (bool {\em state})}\label{classKDialogBase_a58}


This function has only effect in Icon\-List mode. 

Defines how the icon list widget is displayed. By default it is the widgets in the dialog pages that decide the minimum height of the dialog. A vertical scrollbar can be used in the icon list area.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]The visibility mode. If true, the minimum height is adjusted so that every icon in the list is visible at the same time. The vertical scrollbar will never be visible. \end{description}
\end{Desc}


Definition at line 1085 of file kdialogbase.cpp.

References KJanus\-Widget::set\-Icon\-List\-All\-Visible().\index{KDialogBase@{KDialog\-Base}!haveBackgroundTile@{haveBackgroundTile}}
\index{haveBackgroundTile@{haveBackgroundTile}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDialog\-Base::have\-Background\-Tile ()\hspace{0.3cm}{\tt  [static]}}\label{classKDialogBase_e0}


Check whether the background tile is set or not. 

\begin{Desc}
\item[Returns:]{\tt true} if there is defined a background tile. \end{Desc}


Definition at line 1662 of file kdialogbase.cpp.

References KDialog\-Base\-Tile::get().\index{KDialogBase@{KDialog\-Base}!backgroundTile@{backgroundTile}}
\index{backgroundTile@{backgroundTile}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf QPixmap} $\ast$ KDialog\-Base::background\-Tile ()\hspace{0.3cm}{\tt  [static]}}\label{classKDialogBase_e1}


Returns a pointer to the background tile if there is one. 

\begin{Desc}
\item[Returns:]The tile pointer or 0 if no tile is defined. \end{Desc}


Definition at line 1670 of file kdialogbase.cpp.

References KDialog\-Base\-Tile::get().

Referenced by get\-Background\-Tile().\index{KDialogBase@{KDialog\-Base}!getBackgroundTile@{getBackgroundTile}}
\index{getBackgroundTile@{getBackgroundTile}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf QPixmap} $\ast$ KDialog\-Base::get\-Background\-Tile ()\hspace{0.3cm}{\tt  [static]}}\label{classKDialogBase_e2}


\begin{Desc}
\item[{\bf Deprecated}]Use {\bf background\-Tile()}{\rm (p.\,\pageref{classKDialogBase_e1})} instead. \end{Desc}


Definition at line 1668 of file kdialogbase.cpp.

References background\-Tile().\index{KDialogBase@{KDialog\-Base}!setBackgroundTile@{setBackgroundTile}}
\index{setBackgroundTile@{setBackgroundTile}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Background\-Tile (const {\bf QPixmap} $\ast$ {\em pix})\hspace{0.3cm}{\tt  [static]}}\label{classKDialogBase_e3}


Sets the background tile. 

If it is Null (0), the background image is deleted.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pix}]The background tile. \end{description}
\end{Desc}


Definition at line 1676 of file kdialogbase.cpp.

References KDialog\-Base\-Tile::set().\index{KDialogBase@{KDialog\-Base}!showTile@{showTile}}
\index{showTile@{showTile}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::show\-Tile (bool {\em state})}\label{classKDialogBase_a59}


Enable hiding of the background tile (if any). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]{\tt true} will make the tile visible. \end{description}
\end{Desc}


Definition at line 1711 of file kdialogbase.cpp.

References KDialog\-Base\-Tile::get().

Referenced by update\-Background().\index{KDialogBase@{KDialog\-Base}!getBorderWidths@{getBorderWidths}}
\index{getBorderWidths@{getBorderWidths}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::get\-Border\-Widths (int \& {\em ulx}, int \& {\em uly}, int \& {\em lrx}, int \& {\em lry}) const}\label{classKDialogBase_a60}


\begin{Desc}
\item[{\bf Deprecated}]Do not use this method. It is included for compatibility reasons. \end{Desc}
This method returns the border widths in all directions the dialog needs for itself. Respect this, or get bad looking results. The references are upper left x ({\tt ulx}), upper left y ({\tt uly}), lower right x ({\tt lrx}), and lower left y ({\tt lly}). The results are differences in pixels from the dialogs corners. 

Definition at line 1510 of file kdialogbase.cpp.

References KDialog::margin\-Hint().

Referenced by calculate\-Size().\index{KDialogBase@{KDialog\-Base}!getContentsRect@{getContentsRect}}
\index{getContentsRect@{getContentsRect}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QRect} KDialog\-Base::get\-Contents\-Rect () const}\label{classKDialogBase_a61}


\begin{Desc}
\item[{\bf Deprecated}]Do not use this method. It is included for compatibility reasons. \end{Desc}
This method returns the contents rectangle of the work area. Place your widgets inside this rectangle, and use it to set up their geometry. Be careful: The rectangle is only valid after resizing the dialog, as it is a result of the resizing process. If you need the \char`\"{}overhead\char`\"{} the dialog needs for its elements, use {\bf get\-Border\-Widths()}{\rm (p.\,\pageref{classKDialogBase_a60})}. 

Definition at line 1489 of file kdialogbase.cpp.

References KDialog::margin\-Hint(), QRect::set\-Bottom(), QRect::set\-Left(), QRect::set\-Right(), and QRect::set\-Top().\index{KDialogBase@{KDialog\-Base}!calculateSize@{calculateSize}}
\index{calculateSize@{calculateSize}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QSize} KDialog\-Base::calculate\-Size (int {\em w}, int {\em h}) const}\label{classKDialogBase_a62}


Calculate the size hint for the dialog. 

With this method it is easy to calculate a size hint for a dialog derived from KDialog\-Base if you know the width and height of the elements you add to the widget. The rectangle returned is calculated so that all elements exactly fit into it. Thus, you may set it as a minimum size for the resulting dialog.

You should not need to use this method and never if you use one of the predefined shapes.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em w}]The width of you special widget. \item[{\em h}]The height of you special widget. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The minimum width and height of the dialog using {\tt w} and {\tt h} as the size of the main widget. \end{Desc}


Definition at line 1528 of file kdialogbase.cpp.

References get\-Border\-Widths().\index{KDialogBase@{KDialog\-Base}!helpLinkText@{helpLinkText}}
\index{helpLinkText@{helpLinkText}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KDialog\-Base::help\-Link\-Text () const}\label{classKDialogBase_a63}


Returns the help link text. 

If no text has been defined, \char`\"{}Get help...\char`\"{} (internationalized) is returned.

\begin{Desc}
\item[Returns:]The help link text. \end{Desc}


Definition at line 1536 of file kdialogbase.cpp.

References QString::is\-Null().

Referenced by enable\-Linked\-Help(), and set\-Help\-Link\-Text().\index{KDialogBase@{KDialog\-Base}!actionButton@{actionButton}}
\index{actionButton@{actionButton}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QPush\-Button} $\ast$ KDialog\-Base::action\-Button ({\bf Button\-Code} {\em id})}\label{classKDialogBase_a64}


Returns the action button that corresponds to the {\tt id}. 

Normally you should not use this function. {\em Never\/} delete the object returned by this function. See also {\bf enable\-Button()}{\rm (p.\,\pageref{classKDialogBase_i0})}, {\bf show\-Button()}{\rm (p.\,\pageref{classKDialogBase_a25})}, {\bf set\-Button\-Tip()}{\rm (p.\,\pageref{classKDialogBase_a48})}, {\bf set\-Button\-Whats\-This()}{\rm (p.\,\pageref{classKDialogBase_a49})}, and {\bf set\-Button\-Text()}{\rm (p.\,\pageref{classKDialogBase_a47})}.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]Integer identifier of the button. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The action button or 0 if the button does not exists.\end{Desc}
FIXME {\bf KDE} 4: Return the actual {\bf KPush\-Button}{\rm (p.\,\pageref{classKPushButton})} instead of {\bf QPush\-Button} (Martijn) 

Definition at line 832 of file kdialogbase.cpp.

Referenced by close\-Event(), enable\-Button(), key\-Press\-Event(), KProgress\-Dialog::KProgress\-Dialog(), set\-Button\-Apply\-Text(), set\-Button\-Cancel\-Text(), set\-Button\-Gui\-Item(), set\-Button\-OKText(), set\-Button\-Text(), set\-Button\-Tip(), set\-Button\-Whats\-This(), and show\-Button().\index{KDialogBase@{KDialog\-Base}!enableButton@{enableButton}}
\index{enableButton@{enableButton}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::enable\-Button ({\bf Button\-Code} {\em id}, bool {\em state})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i0}


Enable or disable (gray out) a general action button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]Button identifier. \item[{\em state}]{\tt true} enables the button(s). \end{description}
\end{Desc}


Definition at line 838 of file kdialogbase.cpp.

References action\-Button().

Referenced by enable\-Button\-Apply(), enable\-Button\-Cancel(), enable\-Button\-OK(), KConfig\-Dialog::KConfig\-Dialog(), KKey\-Dialog::KKey\-Dialog(), KLine\-Edit\-Dlg::KLine\-Edit\-Dlg(), KConfig\-Dialog::show(), KLine\-Edit\-Dlg::slot\-Text\-Changed(), and KConfig\-Dialog::update\-Buttons().\index{KDialogBase@{KDialog\-Base}!enableButtonOK@{enableButtonOK}}
\index{enableButtonOK@{enableButtonOK}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::enable\-Button\-OK (bool {\em state})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i1}


Enable or disable (gray out) the OK button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]{\tt true} enables the button. \end{description}
\end{Desc}


Definition at line 848 of file kdialogbase.cpp.

References enable\-Button().

Referenced by KEdit\-Toolbar::accept\-OK(), KLine\-Edit\-Dlg::KLine\-Edit\-Dlg(), and KLine\-Edit\-Dlg::slot\-Text\-Changed().\index{KDialogBase@{KDialog\-Base}!enableButtonApply@{enableButtonApply}}
\index{enableButtonApply@{enableButtonApply}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::enable\-Button\-Apply (bool {\em state})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i2}


Enable or disable (gray out) the Apply button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]true enables the button. \end{description}
\end{Desc}


Definition at line 854 of file kdialogbase.cpp.

References enable\-Button().

Referenced by KEdit\-Toolbar::slot\-Apply().\index{KDialogBase@{KDialog\-Base}!enableButtonCancel@{enableButtonCancel}}
\index{enableButtonCancel@{enableButtonCancel}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::enable\-Button\-Cancel (bool {\em state})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i3}


Enable or disable (gray out) the Cancel button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]true enables the button. \end{description}
\end{Desc}


Definition at line 860 of file kdialogbase.cpp.

References enable\-Button().\index{KDialogBase@{KDialog\-Base}!enableLinkedHelp@{enableLinkedHelp}}
\index{enableLinkedHelp@{enableLinkedHelp}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::enable\-Linked\-Help (bool {\em state})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i4}


Display or hide the help link area on the top of the dialog. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]{\tt true} will display the area. \end{description}
\end{Desc}


Definition at line 1241 of file kdialogbase.cpp.

References KDialog\-Base\-Tile::get(), help\-Clicked\-Slot(), help\-Link\-Text(), KDialog::margin\-Hint(), KURLLabel::set\-Float(), QLabel::set\-Text(), and KURLLabel::set\-Underline().

Referenced by set\-Button\-Box\-Orientation().\index{KDialogBase@{KDialog\-Base}!delayedDestruct@{delayedDestruct}}
\index{delayedDestruct@{delayedDestruct}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::delayed\-Destruct ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i5}


Destruct the Dialog delayed. 

You can call this function from slots like {\bf close\-Clicked()}{\rm (p.\,\pageref{classKDialogBase_l11})} and {\bf hidden()}{\rm (p.\,\pageref{classKDialogBase_l14})}. You should not use the dialog any more after calling this function. \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 280 of file kdialogbase.cpp.

References QTimer::single\-Shot(), and slot\-Delayed\-Destruct().\index{KDialogBase@{KDialog\-Base}!setHelpLinkText@{setHelpLinkText}}
\index{setHelpLinkText@{setHelpLinkText}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Help\-Link\-Text (const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i6}


Sets the text that is shown as the linked text. 

If text is empty, the text \char`\"{}Get help...\char`\"{} (internationalized) is used instead.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]The link text. \end{description}
\end{Desc}


Definition at line 1286 of file kdialogbase.cpp.

References help\-Link\-Text(), and QLabel::set\-Text().\index{KDialogBase@{KDialog\-Base}!setHelp@{setHelp}}
\index{setHelp@{setHelp}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Help (const {\bf QString} \& {\em anchor}, const {\bf QString} \& {\em appname} = {\tt QString::null})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i7}


Sets the help path and topic. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em anchor}]Defined anchor in your docbook sources \item[{\em appname}]Defines the appname the help belongs to If empty it's the current one\end{description}
\end{Desc}
\begin{Desc}
\item[Note:]The help button works differently for the class {\bf KCMulti\-Dialog}, so it does not make sense to call this function for Dialogs of that type. See {\bf KCMulti\-Dialog::slot\-Help()} for more information. \end{Desc}


Definition at line 1279 of file kdialogbase.cpp.

Referenced by KAbout\-KDE::KAbout\-KDE(), and KColor\-Dialog::KColor\-Dialog().\index{KDialogBase@{KDialog\-Base}!helpClickedSlot@{helpClickedSlot}}
\index{helpClickedSlot@{helpClickedSlot}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::help\-Clicked\-Slot (const {\bf QString} \&)\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i8}


Connected to help link label. 



Definition at line 1229 of file kdialogbase.cpp.

References slot\-Help().

Referenced by enable\-Linked\-Help().\index{KDialogBase@{KDialog\-Base}!setDetails@{setDetails}}
\index{setDetails@{setDetails}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Details (bool {\em show\-Details})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i9}


Sets the status of the Details button. 



Definition at line 1127 of file kdialogbase.cpp.

References about\-To\-Show\-Details(), adjust\-Size(), QWidget::hide(), set\-Button\-Text(), QWidget::set\-Enabled(), and QWidget::show().

Referenced by set\-Button\-Text(), set\-Details\-Widget(), and slot\-Details().\index{KDialogBase@{KDialog\-Base}!setDetailsWidget@{setDetailsWidget}}
\index{setDetailsWidget@{setDetailsWidget}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::set\-Details\-Widget ({\bf QWidget} $\ast$ {\em details\-Widget})\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i10}


Sets the widget that gets shown when \char`\"{}Details\char`\"{} is enabled. 

The dialog takes over ownership of the widget. Any previously set widget gets deleted. 

Definition at line 1112 of file kdialogbase.cpp.

References QWidget::hide(), QWidget::reparent(), and set\-Details().\index{KDialogBase@{KDialog\-Base}!updateBackground@{updateBackground}}
\index{updateBackground@{updateBackground}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::update\-Background ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i11}


This method is called automatically whenever the background has changed. 

You do not need to use this method. 

Definition at line 1685 of file kdialogbase.cpp.

References KDialog\-Base\-Tile::get(), and show\-Tile().\index{KDialogBase@{KDialog\-Base}!cancel@{cancel}}
\index{cancel@{cancel}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::cancel ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDialogBase_i12}


Force closing the dialog, setting its result code to the one Esc would set. 

You shouldn't use this, generally (let the user make his choice!) but it can be useful when you need to make a choice after a timeout has happened, or when the parent widget has to go somewhere else (e.g. html redirections). \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 1632 of file kdialogbase.cpp.

References slot\-Cancel(), slot\-Close(), slot\-No(), slot\-Ok(), slot\-User1(), slot\-User2(), slot\-User3(), and slot\-Yes().

Referenced by KDialog\-Base().\index{KDialogBase@{KDialog\-Base}!helpClicked@{helpClicked}}
\index{helpClicked@{helpClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::help\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l0}


The Help button was pressed. 

This signal is only emitted if {\bf slot\-Help()}{\rm (p.\,\pageref{classKDialogBase_j0})} is not replaced. 

Referenced by slot\-Help().\index{KDialogBase@{KDialog\-Base}!defaultClicked@{defaultClicked}}
\index{defaultClicked@{defaultClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::default\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l1}


The Default button was pressed. 

This signal is only emitted if {\bf slot\-Default()}{\rm (p.\,\pageref{classKDialogBase_j1})} is not replaced. 

Referenced by KConfig\-Dialog::KConfig\-Dialog(), KKey\-Dialog::KKey\-Dialog(), and slot\-Default().\index{KDialogBase@{KDialog\-Base}!user3Clicked@{user3Clicked}}
\index{user3Clicked@{user3Clicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::user3Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l2}


The User3 button was pressed. 

This signal is only emitted if {\bf slot\-User3()}{\rm (p.\,\pageref{classKDialogBase_j3})} is not replaced. 

Referenced by slot\-User3().\index{KDialogBase@{KDialog\-Base}!user2Clicked@{user2Clicked}}
\index{user2Clicked@{user2Clicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::user2Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l3}


The User2 button was pressed. 

This signal is only emitted if {\bf slot\-User2()}{\rm (p.\,\pageref{classKDialogBase_j4})} is not replaced. 

Referenced by slot\-User2().\index{KDialogBase@{KDialog\-Base}!user1Clicked@{user1Clicked}}
\index{user1Clicked@{user1Clicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::user1Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l4}


The User1 button was pressed. 

This signal is only emitted if {\bf slot\-User1()}{\rm (p.\,\pageref{classKDialogBase_j5})} is not replaced. 

Referenced by KLine\-Edit\-Dlg::KLine\-Edit\-Dlg(), and slot\-User1().\index{KDialogBase@{KDialog\-Base}!applyClicked@{applyClicked}}
\index{applyClicked@{applyClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::apply\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l5}


The Apply button was pressed. 

This signal is only emitted if {\bf slot\-Apply()}{\rm (p.\,\pageref{classKDialogBase_j7})} is not replaced. 

Referenced by KConfig\-Dialog::KConfig\-Dialog(), and slot\-Apply().\index{KDialogBase@{KDialog\-Base}!tryClicked@{tryClicked}}
\index{tryClicked@{tryClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::try\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l6}


The Try button was pressed. 

This signal is only emitted if {\bf slot\-Try()}{\rm (p.\,\pageref{classKDialogBase_j8})} is not replaced. 

Referenced by slot\-Try().\index{KDialogBase@{KDialog\-Base}!okClicked@{okClicked}}
\index{okClicked@{okClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::ok\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l7}


The OK button was pressed. 

This signal is only emitted if {\bf slot\-Ok()}{\rm (p.\,\pageref{classKDialogBase_j6})} is not replaced. 

Referenced by KColor\-Dialog::KColor\-Dialog(), KConfig\-Dialog::KConfig\-Dialog(), and slot\-Ok().\index{KDialogBase@{KDialog\-Base}!yesClicked@{yesClicked}}
\index{yesClicked@{yesClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::yes\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l8}


The Yes button was pressed. 

This signal is only emitted if {\bf slot\-Yes()}{\rm (p.\,\pageref{classKDialogBase_j9})} is not replaced. 

Referenced by slot\-Yes().\index{KDialogBase@{KDialog\-Base}!noClicked@{noClicked}}
\index{noClicked@{noClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::no\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l9}


The No button was pressed. 

This signal is only emitted if {\bf slot\-No()}{\rm (p.\,\pageref{classKDialogBase_j10})} is not replaced. 

Referenced by slot\-No().\index{KDialogBase@{KDialog\-Base}!cancelClicked@{cancelClicked}}
\index{cancelClicked@{cancelClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::cancel\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l10}


The Cancel button was pressed. 

This signal is only emitted if {\bf slot\-Cancel()}{\rm (p.\,\pageref{classKDialogBase_j11})} is not replaced. 

Referenced by slot\-Cancel().\index{KDialogBase@{KDialog\-Base}!closeClicked@{closeClicked}}
\index{closeClicked@{closeClicked}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::close\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l11}


The Close button was pressed. 

This signal is only emitted if {\bf slot\-Close()}{\rm (p.\,\pageref{classKDialogBase_j12})} is not replaced. 

Referenced by KColor\-Dialog::KColor\-Dialog(), and slot\-Close().\index{KDialogBase@{KDialog\-Base}!apply@{apply}}
\index{apply@{apply}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::apply ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l12}


Do not use this signal. 

Is is kept for compatibility reasons. 

\begin{Desc}
\item[{\bf Deprecated}]Use {\bf apply\-Clicked()}{\rm (p.\,\pageref{classKDialogBase_l5})} instead. \end{Desc}


Referenced by apply\-Pressed().\index{KDialogBase@{KDialog\-Base}!backgroundChanged@{backgroundChanged}}
\index{backgroundChanged@{backgroundChanged}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::background\-Changed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l13}


The background tile has changed. 

\index{KDialogBase@{KDialog\-Base}!hidden@{hidden}}
\index{hidden@{hidden}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::hidden ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l14}


The dialog is about to be hidden. 

A dialog is hidden after a user clicks a button that ends the dialog or when the user switches to another desktop or minimizes the dialog. 

Referenced by hide\-Event().\index{KDialogBase@{KDialog\-Base}!finished@{finished}}
\index{finished@{finished}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::finished ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l15}


The dialog has finished. 

A dialog emits finished after a user clicks a button that ends the dialog.

This signal is also emitted when you call hide()

If you have stored a pointer to the dialog do {\em not\/} try to delete the pointer in the slot that is connected to this signal.

You should use {\bf delayed\-Destruct()}{\rm (p.\,\pageref{classKDialogBase_i5})} instead. 

Referenced by hide\-Event().\index{KDialogBase@{KDialog\-Base}!aboutToShowDetails@{aboutToShowDetails}}
\index{aboutToShowDetails@{aboutToShowDetails}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::about\-To\-Show\-Details ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l16}


The details\-Widget is about to get shown. 

This is your last chance to call set\-Details\-Widget if you haven't done so yet. 

Referenced by set\-Details().\index{KDialogBase@{KDialog\-Base}!aboutToShowPage@{aboutToShowPage}}
\index{aboutToShowPage@{aboutToShowPage}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::about\-To\-Show\-Page ({\bf QWidget} $\ast$ {\em page})\hspace{0.3cm}{\tt  [signal]}}\label{classKDialogBase_l17}


A page is about to be shown. 

This signal is only emitted for the Tree\-List and Icon\-List faces. 

Referenced by KDialog\-Base().\index{KDialogBase@{KDialog\-Base}!keyPressEvent@{keyPressEvent}}
\index{keyPressEvent@{keyPressEvent}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::key\-Press\-Event ({\bf QKey\-Event} $\ast$ {\em e})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDialogBase_b0}


Maps some keys to the actions buttons. 

F1 is mapped to the Help button if present and Escape to the Cancel or Close if present. The button action event is animated. 

Reimplemented from {\bf KDialog} {\rm (p.\,\pageref{classKDialog})}.

Reimplemented in {\bf KFile\-Dialog}, and {\bf KColor\-Dialog} {\rm (p.\,\pageref{classKColorDialog_b1})}.

Definition at line 1553 of file kdialogbase.cpp.

References action\-Button(), and QWhats\-This::enter\-Whats\-This\-Mode().

Referenced by KColor\-Dialog::key\-Press\-Event().\index{KDialogBase@{KDialog\-Base}!hideEvent@{hideEvent}}
\index{hideEvent@{hideEvent}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::hide\-Event ({\bf QHide\-Event} $\ast$)\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDialogBase_b1}


Emits the {\bf hidden}{\rm (p.\,\pageref{classKDialogBase_l14})} signal. 

You can connect to that signal to detect when a dialog has been closed. 

Definition at line 1611 of file kdialogbase.cpp.

References finished(), and hidden().\index{KDialogBase@{KDialog\-Base}!closeEvent@{closeEvent}}
\index{closeEvent@{closeEvent}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::close\-Event ({\bf QClose\-Event} $\ast$ {\em e})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDialogBase_b2}


Detects when a dialog is being closed from the window manager controls. 

If the Cancel or Close button is present then the button is activated. Otherwise standard {\bf QDialog} behavior will take place. 

Definition at line 1622 of file kdialogbase.cpp.

References action\-Button().\index{KDialogBase@{KDialog\-Base}!slotHelp@{slotHelp}}
\index{slotHelp@{slotHelp}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Help ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j0}


Activated when the Help button has been clicked. 

If a help text has been defined, the help system will be activated. 

Reimplemented in {\bf KCMulti\-Dialog}.

Definition at line 1094 of file kdialogbase.cpp.

References help\-Clicked().

Referenced by help\-Clicked\-Slot().\index{KDialogBase@{KDialog\-Base}!slotDefault@{slotDefault}}
\index{slotDefault@{slotDefault}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Default ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j1}


Activated when the Default button has been clicked. 



Reimplemented in {\bf KCMulti\-Dialog}.

Definition at line 1102 of file kdialogbase.cpp.

References default\-Clicked().\index{KDialogBase@{KDialog\-Base}!slotDetails@{slotDetails}}
\index{slotDetails@{slotDetails}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Details ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j2}


Activated when the Details button has been clicked. 

\begin{Desc}
\item[See also:]details\-Clicked(bool) \end{Desc}


Reimplemented in {\bf KShortcut\-Dialog} {\rm (p.\,\pageref{classKShortcutDialog_j0})}.

Definition at line 1107 of file kdialogbase.cpp.

References set\-Details().\index{KDialogBase@{KDialog\-Base}!slotUser3@{slotUser3}}
\index{slotUser3@{slotUser3}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-User3 ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j3}


Activated when the User3 button has been clicked. 



Definition at line 1183 of file kdialogbase.cpp.

References user3Clicked().

Referenced by cancel().\index{KDialogBase@{KDialog\-Base}!slotUser2@{slotUser2}}
\index{slotUser2@{slotUser2}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-User2 ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j4}


Activated when the User2 button has been clicked. 



Definition at line 1189 of file kdialogbase.cpp.

References user2Clicked().

Referenced by cancel().\index{KDialogBase@{KDialog\-Base}!slotUser1@{slotUser1}}
\index{slotUser1@{slotUser1}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-User1 ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j5}


Activated when the User1 button has been clicked. 



Reimplemented in {\bf KCMulti\-Dialog}.

Definition at line 1195 of file kdialogbase.cpp.

References user1Clicked().

Referenced by cancel().\index{KDialogBase@{KDialog\-Base}!slotOk@{slotOk}}
\index{slotOk@{slotOk}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Ok ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j6}


Activated when the Ok button has been clicked. 

The {\bf QDialog::accept()} is activated. 

Reimplemented in {\bf KFile\-Dialog}, {\bf KIcon\-Dialog}, {\bf KProperties\-Dialog}, {\bf KCMulti\-Dialog}, {\bf KFind\-Dialog}, {\bf KReplace\-Dialog}, {\bf KSettings::Components\-Dialog}, {\bf KBug\-Report} {\rm (p.\,\pageref{classKBugReport_j3})}, {\bf KEdit\-Toolbar} {\rm (p.\,\pageref{classKEditToolbar_j0})}, and {\bf KPassword\-Dialog} {\rm (p.\,\pageref{classKPasswordDialog_j0})}.

Definition at line 1164 of file kdialogbase.cpp.

References QDialog::accept(), and ok\-Clicked().

Referenced by cancel(), and KInput\-Dialog::get\-Item().\index{KDialogBase@{KDialog\-Base}!slotApply@{slotApply}}
\index{slotApply@{slotApply}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Apply ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j7}


Activated when the Apply button has been clicked. 



Reimplemented in {\bf KCMulti\-Dialog}, {\bf KSettings::Components\-Dialog}, and {\bf KEdit\-Toolbar} {\rm (p.\,\pageref{classKEditToolbar_j1})}.

Definition at line 1171 of file kdialogbase.cpp.

References apply\-Clicked().\index{KDialogBase@{KDialog\-Base}!slotTry@{slotTry}}
\index{slotTry@{slotTry}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Try ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j8}


Activated when the Try button has been clicked. 



Definition at line 1177 of file kdialogbase.cpp.

References try\-Clicked().\index{KDialogBase@{KDialog\-Base}!slotYes@{slotYes}}
\index{slotYes@{slotYes}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Yes ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j9}


Activated when the Yes button has been clicked. 

The QDialog::done( Yes ) is activated. 

Definition at line 1201 of file kdialogbase.cpp.

References QDialog::done(), and yes\-Clicked().

Referenced by cancel().\index{KDialogBase@{KDialog\-Base}!slotNo@{slotNo}}
\index{slotNo@{slotNo}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-No ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j10}


Activated when the Yes button has been clicked. 

The QDialog::done( No ) is activated. 

Definition at line 1208 of file kdialogbase.cpp.

References QDialog::done(), and no\-Clicked().

Referenced by cancel().\index{KDialogBase@{KDialog\-Base}!slotCancel@{slotCancel}}
\index{slotCancel@{slotCancel}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Cancel ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j11}


Activated when the Cancel button has been clicked. 

The {\bf QDialog::reject()} is activated in regular mode and QDialog::done( Cancel ) when in message box mode. 

Reimplemented in {\bf KFile\-Dialog}, {\bf KProperties\-Dialog}, {\bf KBug\-Report} {\rm (p.\,\pageref{classKBugReport_j4})}, {\bf KPassword\-Dialog} {\rm (p.\,\pageref{classKPasswordDialog_j1})}, and {\bf KProgress\-Dialog} {\rm (p.\,\pageref{classKProgressDialog_j2})}.

Definition at line 1215 of file kdialogbase.cpp.

References cancel\-Clicked(), and QDialog::done().

Referenced by cancel(), KProgress\-Dialog::slot\-Cancel(), KBug\-Report::slot\-Cancel(), and KBug\-Report::slot\-Url\-Clicked().\index{KDialogBase@{KDialog\-Base}!slotClose@{slotClose}}
\index{slotClose@{slotClose}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Close ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j12}


Activated when the Close button has been clicked. 

The {\bf QDialog::reject()} is activated. 

Definition at line 1222 of file kdialogbase.cpp.

References close\-Clicked(), and QDialog::reject().

Referenced by cancel().\index{KDialogBase@{KDialog\-Base}!applyPressed@{applyPressed}}
\index{applyPressed@{applyPressed}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::apply\-Pressed ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKDialogBase_j13}


\begin{Desc}
\item[{\bf Deprecated}]Do not use this slot. Is is kept for compatibility reasons. Activated when the Apply button has been clicked \end{Desc}


Definition at line 1235 of file kdialogbase.cpp.

References apply().\index{KDialogBase@{KDialog\-Base}!updateGeometry@{updateGeometry}}
\index{updateGeometry@{updateGeometry}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::update\-Geometry ()\hspace{0.3cm}{\tt  [protected, slot]}}\label{classKDialogBase_j14}


Updates the margins and spacings. 



Definition at line 1542 of file kdialogbase.cpp.

References KDialog::margin\-Hint(), QBox\-Layout::set\-Margin(), QBox\-Layout::set\-Spacing(), and KDialog::spacing\-Hint().

Referenced by KDialog\-Base().\index{KDialogBase@{KDialog\-Base}!slotDelayedDestruct@{slotDelayedDestruct}}
\index{slotDelayedDestruct@{slotDelayedDestruct}!KDialogBase@{KDialog\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDialog\-Base::slot\-Delayed\-Destruct ()\hspace{0.3cm}{\tt  [protected, slot]}}\label{classKDialogBase_j15}


Deletes the dialog immediately. 

If you want to delete the dialog delayed use {\bf delayed\-Destruct()}{\rm (p.\,\pageref{classKDialogBase_i5})} or {\bf QObject::delete\-Later()}.

Attention: Do no use connect this slot to signals from user actions! 

Definition at line 288 of file kdialogbase.cpp.

Referenced by delayed\-Destruct().

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