kdeui Library API Documentation

KDialog Class Reference

Dialog with extended nonmodal support and methods for KDE standard compliance. More...

#include <kdialog.h>

Inheritance diagram for KDialog:

QDialog KDialogBase KTipDialog KAboutDialog KBugReport KColorDialog KConfigDialog KEditToolbar KFontDialog KInputDialog KKeyDialog KLineEditDlg KPasswordDialog KProgressDialog List of all members.

Public Slots

virtual void polish ()
virtual void setCaption (const QString &caption)
virtual void setPlainCaption (const QString &caption)

Signals

void layoutHintChanged ()

Public Methods

 KDialog (QWidget *parent=0, const char *name=0, bool modal=false, WFlags f=0)

Static Public Methods

int marginHint ()
int spacingHint ()
void resizeLayout (QWidget *widget, int margin, int spacing)
void resizeLayout (QLayoutItem *lay, int margin, int spacing)
void centerOnScreen (QWidget *widget, int screen=-1)
bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)

Detailed Description

Dialog with extended nonmodal support and methods for KDE standard compliance.

Generally, you should not use this class directly, but KDialogBase which inherits KDialog.

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

The marginHint() and spacingHint() 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 spacingHint(), whereas the space above, below, to the right and to the left shall be marginHint(). If you add a separator line above the buttons, there shall be a marginHint() between the buttons and the separator and a marginHint() above the separator as well.

See also:
KDialogBase
Author:
Thomas Tanghus <tanghus@earthling.net>, Espen Sand <espensa@online.no>
Version:
0.1.2

Definition at line 51 of file kdialog.h.


Constructor & Destructor Documentation

KDialog::KDialog QWidget   parent = 0,
const char *    name = 0,
bool    modal = false,
WFlags    f = 0
 

Constructor.

Takes the same arguments as QDialog.

Definition at line 45 of file kdialog.cpp.


Member Function Documentation

int KDialog::marginHint   [static]
 

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

Definition at line 95 of file kdialog.cpp.

Referenced by KHelpMenu::aboutApplication(), KDialogBase::enableLinkedHelp(), KDialogBase::getBorderWidths(), KDialogBase::getContentsRect(), KFontChooser::KFontChooser(), KJanusWidget::KJanusWidget(), KTipDialog::KTipDialog(), KPassivePopup::setView(), and KDialogBase::updateGeometry().

int KDialog::spacingHint   [static]
 

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

Definition at line 101 of file kdialog.cpp.

Referenced by KHelpMenu::aboutApplication(), KJanusWidget::addGridPage(), KJanusWidget::addHBoxPage(), KJanusWidget::addVBoxPage(), KBugReport::KBugReport(), KCharSelect::KCharSelect(), KColorDialog::KColorDialog(), KFontChooser::KFontChooser(), KFontRequester::KFontRequester(), KJanusWidget::KJanusWidget(), KLineEditDlg::KLineEditDlg(), KSpellConfig::KSpellConfig(), KTipDialog::KTipDialog(), KDialogBase::makeGridMainWidget(), KDialogBase::makeHBoxMainWidget(), KDialogBase::makeVBoxMainWidget(), KJanusWidget::minimumSizeHint(), KDialogBase::setButtonApply(), KDialogBase::setButtonApplyText(), KDialogBase::setButtonCancel(), KDialogBase::setButtonCancelText(), KDialogBase::setButtonOK(), KDialogBase::setButtonOKText(), KDialogBase::setButtonText(), KPassivePopup::setView(), KPassivePopup::standardView(), and KDialogBase::updateGeometry().

void KDialog::resizeLayout QWidget   widget,
int    margin,
int    spacing
[static]
 

Resize every layout manager used in widget and its nested children.

Parameters:
widget  The widget used.
margin  The new layout margin.
spacing  The new layout spacing.

Definition at line 136 of file kdialog.cpp.

References QObject::isWidgetType(), and QWidget::layout().

Referenced by resizeLayout().

void KDialog::resizeLayout QLayoutItem   lay,
int    margin,
int    spacing
[static]
 

Resize every layout associated with lay and its children.

Parameters:
lay  layout to be resized
margin  The new layout margin
spacing  The new layout spacing

Definition at line 158 of file kdialog.cpp.

References QLayoutIterator::current(), QLayoutItem::iterator(), QLayoutItem::layout(), and resizeLayout().

void KDialog::centerOnScreen QWidget   widget,
int    screen = -1
[static]
 

Centers widget on the desktop, taking multi-head setups into account.

If screen is -1, widget will be centered on its current screen (if it was shown already) or on the primary screen. If screen is -3, widget will be centered on the screen that currently contains the mouse pointer. screen will be ignored if a merged display (like Xinerama) is not in use, or merged display placement is not enabled in kdeglobals.

Since:
3.1

Definition at line 197 of file kdialog.cpp.

References QRect::center(), QWidget::height(), QWidget::move(), and QWidget::width().

bool KDialog::avoidArea QWidget   widget,
const QRect   area,
int    screen = -1
[static]
 

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

This is typically used by the "find dialog" so that the match it finds can be read. For screen, see centerOnScreen

Returns:
true on success (widget doesn't cover area anymore, or never did), false on failure (not enough space found)
Since:
3.2

Definition at line 207 of file kdialog.cpp.

References QRect::bottom(), QWidget::frameGeometry(), QRect::height(), QRect::intersects(), QRect::left(), QWidget::move(), QRect::moveBy(), QRect::rBottom(), QRect::right(), QRect::rRight(), QRect::setX(), QRect::setY(), QRect::top(), QRect::width(), QRect::x(), and QRect::y().

void KDialog::polish   [virtual, slot]
 

If the dialog starts with focus in a QLineEdit child, then call selectAll() on the child.

Definition at line 107 of file kdialog.cpp.

References QWidget::isEnabled().

void KDialog::setCaption const QString   caption [virtual, slot]
 

Make a KDE compliant caption.

Parameters:
caption  Your caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.

Definition at line 117 of file kdialog.cpp.

References setPlainCaption().

Referenced by KLineEditDlg::getText(), KDialogBase::KDialogBase(), and KTipDialog::KTipDialog().

void KDialog::setPlainCaption const QString   caption [virtual, slot]
 

Make a plain caption without any modifications.

Parameters:
caption  Your caption. This is the string that will be displayed in the window title.

Definition at line 124 of file kdialog.cpp.

References QString::utf8().

Referenced by KHelpMenu::aboutApplication(), KAboutDialog::imageURL(), KAboutDialog::KAboutDialog(), and setCaption().

void KDialog::layoutHintChanged   [signal]
 

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

Use marginHint() and spacingHint() in your slot to get the new values.

Referenced by KDialogBase::KDialogBase().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:23:32 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003