.TH "KDialog" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDialog \- Dialog with extended nonmodal support and methods for \fBKDE\fP standard compliance.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdialog.h>\fP
.PP
Inherits \fBQDialog\fP.
.PP
Inherited by \fBKDialogBase\fP, KShortcutDialog, and \fBKTipDialog\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "virtual void \fBpolish\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetCaption\fP (const  \fBQString\fP &caption)"
.br
.RI "\fIMake a \fBKDE\fP compliant caption. \fP"
.ti -1c
.RI "virtual void \fBsetPlainCaption\fP (const  \fBQString\fP &caption)"
.br
.RI "\fIMake a plain caption without any modifications. \fP"
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBlayoutHintChanged\fP ()"
.br
.RI "\fIEmitted when the margin size and/or spacing size have changed. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDialog\fP (\fBQWidget\fP *parent=0, const  char *name=0, bool modal=false, WFlags f=0)"
.br
.RI "\fIConstructor. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "int \fBmarginHint\fP ()"
.br
.RI "\fIReturn the number of pixels you shall use between a dialog edge and the outermost widget(s) according to the \fBKDE\fP standard. \fP"
.ti -1c
.RI "int \fBspacingHint\fP ()"
.br
.RI "\fIReturn the number of pixels you shall use between widgets inside a dialog according to the \fBKDE\fP standard. \fP"
.ti -1c
.RI "void \fBresizeLayout\fP (\fBQWidget\fP *widget, int margin, int spacing)"
.br
.RI "\fIResize every layout manager used in \fCwidget\fP and its nested children. \fP"
.ti -1c
.RI "void \fBresizeLayout\fP (\fBQLayoutItem\fP *lay, int margin, int spacing)"
.br
.RI "\fIReszie every layout associated with \fClay\fP and its children. \fP"
.ti -1c
.RI "void \fBcenterOnScreen\fP (\fBQWidget\fP *widget, int screen=-1)"
.br
.RI "\fICenters \fCwidget\fP on the desktop, taking multi-head setups into account. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBkeyPressEvent\fP (\fBQKeyEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Dialog with extended nonmodal support and methods for \fBKDE\fP standard compliance. 

Generally, you should not use this class directly, but \fBKDialogBase\fP which inherits KDialog.
.PP
If the dialog is non-modal and has a parent, the default keybindings (\fCescape\fP = \fC\fBreject()\fP\fP, \fCenter\fP = \fC\fBaccept()\fP\fP, etc.) are disabled.
.PP
The \fBmarginHint\fP() and \fBspacingHint\fP() sizes shall be used whenever you layout the interior of a dialog. One special note. If you make your own action buttons (OK, Cancel etc), the space beteween the buttons shall be \fBspacingHint\fP(), whereas the space above, below, to the right and to the left shall be \fBmarginHint\fP(). If you add a separator line above the buttons, there shall be a \fBmarginHint\fP() between the buttons and the separator and a \fBmarginHint\fP() above the separator as well.
.PP
\fBSee also:\fP
.RS 4
\fBKDialogBase\fP 
.RE
.PP
\fBAuthor:\fP
.RS 4
Thomas Tanghus <tanghus@earthling.net>, Espen Sand <espensa@online.no> 
.RE
.PP
\fBVersion:\fP
.RS 4
0.1.2 
.RE
.PP

.PP
Definition at line 51 of file kdialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDialog::KDialog (\fBQWidget\fP * parent = 0, const char * name = 0, bool modal = false, WFlags f = 0)"
.PP
Constructor. Takes the same arguments as \fBQDialog\fP. Definition at line 39 of file kdialog.cpp.
.PP
References KStdAccel::name().
.SH "Member Function Documentation"
.PP 
.SS "int KDialog::marginHint ()\fC [static]\fP"
.PP
Return the number of pixels you shall use between a dialog edge and the outermost widget(s) according to the \fBKDE\fP standard. Definition at line 92 of file kdialog.cpp.
.PP
Referenced by KHelpMenu::aboutApplication(), KDialogBase::enableLinkedHelp(), KDialogBase::getBorderWidths(), KDialogBase::getContentsRect(), KFontChooser::KFontChooser(), KJanusWidget::KJanusWidget(), KTipDialog::KTipDialog(), KPassivePopup::setView(), and KDialogBase::updateGeometry().
.SS "int KDialog::spacingHint ()\fC [static]\fP"
.PP
Return the number of pixels you shall use between widgets inside a dialog according to the \fBKDE\fP standard. Definition at line 98 of file kdialog.cpp.
.PP
Referenced by KHelpMenu::aboutApplication(), KJanusWidget::addGridPage(), KJanusWidget::addHBoxPage(), KJanusWidget::addVBoxPage(), KBugReport::KBugReport(), KCharSelect::KCharSelect(), KFontChooser::KFontChooser(), KJanusWidget::KJanusWidget(), KLineEditDlg::KLineEditDlg(), KTipDialog::KTipDialog(), KDialogBase::makeGridMainWidget(), KDialogBase::makeHBoxMainWidget(), KDialogBase::makeVBoxMainWidget(), KJanusWidget::minimumSizeHint(), KDialogBase::setButtonApplyText(), KDialogBase::setButtonCancelText(), KDialogBase::setButtonOKText(), KDialogBase::setButtonText(), KPassivePopup::setView(), KPassivePopup::standardView(), and KDialogBase::updateGeometry().
.SS "void KDialog::resizeLayout (\fBQWidget\fP * widget, int margin, int spacing)\fC [static]\fP"
.PP
Resize every layout manager used in \fCwidget\fP and its nested children. \fBParameters:\fP
.RS 4
\fImargin\fP The new layout margin. 
.br
\fImargin\fP The new layout spacing. 
.RE
.PP
Definition at line 132 of file kdialog.cpp.
.PP
References QObject::isWidgetType(), and QWidget::layout().
.PP
Referenced by resizeLayout().
.SS "void KDialog::resizeLayout (\fBQLayoutItem\fP * lay, int margin, int spacing)\fC [static]\fP"
.PP
Reszie every layout associated with \fClay\fP and its children. \fBParameters:\fP
.RS 4
\fImargin\fP The new layout margin 
.br
\fImargin\fP The new layout spacing 
.RE
.PP
Definition at line 154 of file kdialog.cpp.
.PP
References QLayoutIterator::current(), QLayoutItem::iterator(), QLayoutItem::layout(), and resizeLayout().
.SS "void KDialog::centerOnScreen (\fBQWidget\fP * widget, int screen = -1)\fC [static]\fP"
.PP
Centers \fCwidget\fP on the desktop, taking multi-head setups into account. If \fCscreen\fP is -1, \fCwidget\fP will be centered on its current screen (if it was shown already) or on the primary screen. 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 170 of file kdialog.cpp.
.PP
References QRect::center(), QApplication::desktop(), QWidget::height(), QWidget::move(), QDesktopWidget::numScreens(), QDesktopWidget::primaryScreen(), QDesktopWidget::screenGeometry(), QDesktopWidget::screenNumber(), and QWidget::width().
.SS "void KDialog::setCaption (const \fBQString\fP & caption)\fC [virtual, slot]\fP"
.PP
Make a \fBKDE\fP compliant caption. \fBParameters:\fP
.RS 4
\fIcaption\fP Your caption. Do \fCnot\fP include the application name in this string. It will be added automatically according to the \fBKDE\fP standard. 
.RE
.PP
Definition at line 114 of file kdialog.cpp.
.PP
References setPlainCaption().
.PP
Referenced by KLineEditDlg::getText(), KDialogBase::KDialogBase(), and KTipDialog::KTipDialog().
.SS "void KDialog::setPlainCaption (const \fBQString\fP & caption)\fC [virtual, slot]\fP"
.PP
Make a plain caption without any modifications. \fBParameters:\fP
.RS 4
\fIcaption\fP Your caption. This is the string that will be displayed in the window title. 
.RE
.PP
Definition at line 121 of file kdialog.cpp.
.PP
References QString::utf8().
.PP
Referenced by KHelpMenu::aboutApplication(), KAboutDialog::imageURL(), KAboutDialog::KAboutDialog(), and setCaption().
.SS "void KDialog::layoutHintChanged ()\fC [signal]\fP"
.PP
Emitted when the margin size and/or spacing size have changed. Use \fBmarginHint\fP() and \fBspacingHint\fP() in your slot to get the new values. Referenced by KDialogBase::KDialogBase().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
