.TH "KDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDialog \- Dialog with extended non-modal support and methods for KDE standard compliance.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdialog.h>\fP
.PP
Inherits \fBQDialog\fP.
.PP
Inherited by \fBKDialogBase\fP, \fBKSSLCertDlg\fP, \fBKSSLInfoDlg\fP, 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
.ti -1c
.RI "virtual void \fBsetPlainCaption\fP (const \fBQString\fP &caption)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBlayoutHintChanged\fP ()"
.br
.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
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static int \fBmarginHint\fP ()"
.br
.ti -1c
.RI "static int \fBspacingHint\fP ()"
.br
.ti -1c
.RI "static void \fBresizeLayout\fP (\fBQWidget\fP *widget, int margin, int spacing)"
.br
.ti -1c
.RI "static void \fBresizeLayout\fP (\fBQLayoutItem\fP *lay, int margin, int spacing)"
.br
.ti -1c
.RI "static void \fBcenterOnScreen\fP (\fBQWidget\fP *widget, int screen=-1)"
.br
.ti -1c
.RI "static bool \fBavoidArea\fP (\fBQWidget\fP *widget, const \fBQRect\fP &area, int screen=-1)"
.br
.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 non-modal support and methods for KDE 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

.PP
Definition at line 52 of file kdialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDialog::KDialog (\fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, bool modal = \fCfalse\fP, WFlags f = \fC0\fP)"
.PP
Constructor. 
.PP
Takes the same arguments as \fBQDialog\fP. 
.PP
Definition at line 46 of file kdialog.cpp.
.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. 
.PP
Definition at line 97 of file kdialog.cpp.
.PP
Referenced by KDialogBase::enableLinkedHelp(), KDialogBase::getBorderWidths(), KDialogBase::getContentsRect(), KTipDialog::KTipDialog(), 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. 
.PP
Definition at line 103 of file kdialog.cpp.
.PP
Referenced by KBugReport::KBugReport(), KColorDialog::KColorDialog(), KFontChooser::KFontChooser(), KLineEditDlg::KLineEditDlg(), KTipDialog::KTipDialog(), KDialogBase::makeGridMainWidget(), KDialogBase::makeHBoxMainWidget(), KDialogBase::makeVBoxMainWidget(), KDialogBase::setButtonApplyText(), KDialogBase::setButtonCancelText(), KDialogBase::setButtonGuiItem(), KDialogBase::setButtonOKText(), KDialogBase::setButtonText(), 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. 
.PP
\fBParameters:\fP
.RS 4
\fIwidget\fP The widget used. 
.br
\fImargin\fP The new layout margin. 
.br
\fIspacing\fP The new layout spacing. 
.RE
.PP

.PP
Definition at line 133 of file kdialog.cpp.
.PP
References QObject::isWidgetType().
.PP
Referenced by resizeLayout().
.SS "void KDialog::resizeLayout (\fBQLayoutItem\fP * lay, int margin, int spacing)\fC [static]\fP"
.PP
Resize every layout associated with \fClay\fP and its children. 
.PP
\fBParameters:\fP
.RS 4
\fIlay\fP layout to be resized 
.br
\fImargin\fP The new layout margin 
.br
\fIspacing\fP The new layout spacing 
.RE
.PP

.PP
Definition at line 156 of file kdialog.cpp.
.PP
References QLayoutIterator::current(), and resizeLayout().
.SS "void KDialog::centerOnScreen (\fBQWidget\fP * widget, int screen = \fC-1\fP)\fC [static]\fP"
.PP
Centers \fCwidget\fP on the desktop, taking multi-head setups into account. 
.PP
If \fCscreen\fP is -1, \fCwidget\fP will be centered on its current screen (if it was shown already) or on the primary screen. If \fCscreen\fP is -3, \fCwidget\fP will be centered on the screen that currently contains the mouse pointer. \fCscreen\fP will be ignored if a merged display (like Xinerama) is not in use, or merged display placement is not enabled in kdeglobals. 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 195 of file kdialog.cpp.
.PP
References QRect::center(), QRect::height(), QRect::width(), QRect::x(), and QRect::y().
.SS "bool KDialog::avoidArea (\fBQWidget\fP * widget, const \fBQRect\fP & area, int screen = \fC-1\fP)\fC [static]\fP"
.PP
Places \fCwidget\fP so that it doesn't cover a certain \fCarea\fP of the screen. 
.PP
This is typically used by the 'find dialog' so that the match it finds can be read. For \fCscreen\fP, see centerOnScreen 
.PP
\fBReturns:\fP
.RS 4
true on success (widget doesn't cover area anymore, or never did), false on failure (not enough space found) 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 205 of file kdialog.cpp.
.PP
References QRect::bottom(), QRect::height(), QRect::intersects(), QRect::left(), QRect::moveBy(), QRect::rBottom(), QRect::right(), QRect::rRight(), QRect::setX(), QRect::setY(), QRect::top(), QRect::width(), QRect::x(), and QRect::y().
.SS "void KDialog::polish ()\fC [virtual, slot]\fP"
.PP
If the dialog starts with focus in a \fBQLineEdit\fP child, then call selectAll() on the child. 
.PP
Definition at line 109 of file kdialog.cpp.
.SS "void KDialog::setCaption (const \fBQString\fP & caption)\fC [virtual, slot]\fP"
.PP
Make a \fBKDE\fP compliant caption. 
.PP
\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

.PP
Definition at line 115 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. 
.PP
\fBParameters:\fP
.RS 4
\fIcaption\fP Your caption. This is the string that will be displayed in the window title. 
.RE
.PP

.PP
Definition at line 122 of file kdialog.cpp.
.PP
References NETWinInfo::setName().
.PP
Referenced by KHelpMenu::aboutApplication(), KMessageBox::detailedErrorWId(), KMessageBox::detailedSorryWId(), KMessageBox::errorListWId(), KAboutDialog::imageURL(), KMessageBox::informationListWId(), KAboutDialog::KAboutDialog(), KMessageBox::questionYesNoCancelWId(), KMessageBox::questionYesNoListWId(), setCaption(), KMessageBox::sorryWId(), KMessageBox::warningContinueCancelListWId(), KMessageBox::warningYesNoCancelListWId(), and KMessageBox::warningYesNoListWId().
.SS "void KDialog::layoutHintChanged ()\fC [signal]\fP"
.PP
Emitted when the margin size and/or spacing size have changed. 
.PP
Use \fBmarginHint()\fP and \fBspacingHint()\fP in your slot to get the new values. 
.PP
Referenced by KDialogBase::KDialogBase().

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