• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KDialog Class Reference

A dialog base class with standard buttons and predefined layouts. More...

#include <kdialog.h>

Inheritance diagram for KDialog:
QDialog KAboutApplicationDialog KBugReport KColorDialog KEditToolBar KFindDialog KFontDialog KNewPasswordDialog KPageDialog KPasswordDialog KPixmapRegionSelectorDialog KProgressDialog KShortcutsDialog KTipDialog Sonnet::ConfigDialog Sonnet::Dialog

List of all members.

Public Types

enum  ButtonCode {
  None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004,
  Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040,
  No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400,
  User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000
}
enum  ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }
enum  CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }

Public Slots

void delayedDestruct ()
void enableButton (ButtonCode id, bool state)
void enableButtonApply (bool state)
void enableButtonCancel (bool state)
void enableButtonOk (bool state)
void enableLinkedHelp (bool state)
bool isDetailsWidgetVisible () const
virtual void setCaption (const QString &caption, bool modified)
virtual void setCaption (const QString &caption)
void setDetailsWidget (QWidget *detailsWidget)
void setDetailsWidgetVisible (bool visible)
void setHelp (const QString &anchor, const QString &appname=QString())
void setHelpLinkText (const QString &text)
virtual void setPlainCaption (const QString &caption)

Signals

void aboutToShowDetails ()
void applyClicked ()
void buttonClicked (KDialog::ButtonCode button)
void cancelClicked ()
void closeClicked ()
void defaultClicked ()
void finished ()
void helpClicked ()
void hidden ()
void layoutHintChanged ()
void noClicked ()
void okClicked ()
void resetClicked ()
void tryClicked ()
void user1Clicked ()
void user2Clicked ()
void user3Clicked ()
void yesClicked ()

Public Member Functions

KPushButton * button (ButtonCode id) const
KIcon buttonIcon (ButtonCode id) const
QString buttonText (ButtonCode id) const
QString buttonToolTip (ButtonCode id) const
QString buttonWhatsThis (ButtonCode id) const
ButtonCode defaultButton () const
QString helpLinkText () const
void incrementInitialSize (const QSize &size)
bool isButtonEnabled (ButtonCode id) const
 KDialog (QWidget *parent=0, Qt::WFlags flags=0)
QWidget * mainWidget ()
virtual QSize minimumSizeHint () const
void restoreDialogSize (const KConfigGroup &config)
void saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void setButtonFocus (ButtonCode id)
void setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void setButtonIcon (ButtonCode id, const KIcon &icon)
void setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void setButtons (ButtonCodes buttonMask)
void setButtonsOrientation (Qt::Orientation orientation)
void setButtonText (ButtonCode id, const QString &text)
void setButtonToolTip (ButtonCode id, const QString &text)
void setButtonWhatsThis (ButtonCode id, const QString &text)
void setDefaultButton (ButtonCode id)
void setEscapeButton (ButtonCode id)
void setInitialSize (const QSize &size)
void setMainWidget (QWidget *widget)
void showButton (ButtonCode id, bool state)
void showButtonSeparator (bool state)
virtual QSize sizeHint () const
 ~KDialog ()

Static Public Member Functions

static bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void centerOnScreen (QWidget *widget, int screen=-1)
static int groupSpacingHint ()
static QString makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int marginHint ()
static void resizeLayout (QLayout *lay, int margin, int spacing)
static void resizeLayout (QWidget *widget, int margin, int spacing)
static int spacingHint ()

Protected Slots

virtual void slotButtonClicked (int button)
void updateGeometry ()

Protected Member Functions

virtual void closeEvent (QCloseEvent *e)
virtual void hideEvent (QHideEvent *)
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WFlags flags=0)
virtual void keyPressEvent (QKeyEvent *)

Protected Attributes

KDialogPrivate *const d_ptr

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

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.

By default, the dialog is non-modal.

Standard buttons (action buttons):

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 KDE. The button order can be changed, but this ability is only available for a central 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 UserN buttons. Each button emit a signal, so you can choose to connect that signal.

The default action of the Help button will open the help system if you have provided a path to the help text. The default action of Ok and Cancel will run QDialog::accept() and QDialog::reject(), which you can override by reimplementing slotButtonClicked(). The default action of the Close button will close the dialog.

Note that the KDialog will animate a button press when the user presses Escape. The button that is enabled is either Cancel, Close or the button that is defined by setEscapeButton(). Your custom dialog code should reimplement the keyPressEvent and animate the cancel button so that the dialog behaves like regular dialogs.

Layout:

The dialog consists of a help area on top (becomes visible if you define a help path and use enableLinkedHelp()), 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 setButtonsOrientation() 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).

Standard compliance:

The marginHint() and spacingHint() sizes shall be used whenever you lay out the interior of a dialog. One special note. If you make your own action buttons (OK, Cancel etc), the space between 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.

Example:

   KDialog *dialog = new KDialog( this );
   dialog->setCaption( "My title" );
   dialog->setButtons( KDialog::Ok | KDialog::Cancel | KDialog::Apply );

   FooWidget *widget = new FooWidget( dialog );
   dialog->setMainWidget( widget );
   connect( dialog, SIGNAL( applyClicked() ), widget, SLOT( save() ) );
   connect( dialog, SIGNAL( okClicked() ), widget, SLOT( save() ) );
   connect( widget, SIGNAL( changed( bool ) ), dialog, SLOT( enableButtonApply( bool ) ) );

   dialog->enableButtonApply( false );
   dialog->show();

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

See also:
KPageDialog
Author:
Thomas Tanghus <tanghus@earthling.net>
Espen Sand <espensa@online.no>
Mirko Boehm <mirko@kde.org>
Olivier Goffart <ogoffart at kde.org>
Tobias Koenig <tokoe@kde.org>

Definition at line 127 of file kdialog.h.


Member Enumeration Documentation

enum KDialog::ButtonCode
Enumerator:
None 
Help 

Show Help button. (this button will run the help set with setHelp).

Default 

Show Default button.

Ok 

Show Ok button. (this button accept()s the dialog; result set to QDialog::Accepted).

Apply 

Show Apply button.

Try 

Show Try button.

Cancel 

Show Cancel-button. (this button reject()s the dialog; result set to QDialog::Rejected).

Close 

Show Close-button. (this button closes the dialog).

No 

Show No button. (this button closes the dialog and sets the result to KDialog::No).

Yes 

Show Yes button. (this button closes the dialog and sets the result to KDialog::Yes).

Reset 

Show Reset button.

Details 

Show Details button. (this button will show the detail widget set with setDetailsWidget).

User1 

Show User defined button 1.

User2 

Show User defined button 2.

User3 

Show User defined button 3.

NoDefault 

Used when specifying a default button; indicates that no button should be marked by default.

Definition at line 135 of file kdialog.h.

enum KDialog::ButtonPopupMode
Enumerator:
InstantPopup 
DelayedPopup 

Definition at line 156 of file kdialog.h.

enum KDialog::CaptionFlag
Enumerator:
NoCaptionFlags 
AppNameCaption 
ModifiedCaption 
HIGCompliantCaption 

Definition at line 437 of file kdialog.h.


Constructor & Destructor Documentation

KDialog::KDialog ( QWidget *  parent = 0,
Qt::WFlags  flags = 0 
) [explicit]

Creates a dialog.

Parameters:
parent The parent of the dialog.
flags The widget flags passed to the QDialog constructor

Definition at line 190 of file kdialog.cpp.

KDialog::~KDialog (  ) 

Destroys the dialog.

Definition at line 202 of file kdialog.cpp.

KDialog::KDialog ( KDialogPrivate &  dd,
QWidget *  parent,
Qt::WFlags  flags = 0 
) [protected]

Definition at line 196 of file kdialog.cpp.


Member Function Documentation

void KDialog::aboutToShowDetails (  )  [signal]

The detailsWidget is about to get shown.

This is your last chance to call setDetailsWidget if you haven't done so yet.

void KDialog::applyClicked (  )  [signal]

The Apply button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

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)

Definition at line 551 of file kdialog.cpp.

KPushButton * KDialog::button ( ButtonCode  id  )  const

Returns the button that corresponds to the id.

Normally you should not use this function. Never delete the object returned by this function. See also enableButton(), showButton(), setButtonGuiItem().

Parameters:
id Identifier of the button.
Returns:
The button or 0 if the button does not exist.

Definition at line 634 of file kdialog.cpp.

void KDialog::buttonClicked ( KDialog::ButtonCode  button  )  [signal]

A button has been pressed.

This signal is only emitted if slotButtonClicked() is not replaced

Parameters:
button is the code of the pressed button.
KIcon KDialog::buttonIcon ( ButtonCode  id  )  const

Returns the icon of any button.

Definition at line 728 of file kdialog.cpp.

QString KDialog::buttonText ( ButtonCode  id  )  const

Returns the text of any button.

Definition at line 712 of file kdialog.cpp.

QString KDialog::buttonToolTip ( ButtonCode  id  )  const

Returns the tooltip of any button.

Definition at line 748 of file kdialog.cpp.

QString KDialog::buttonWhatsThis ( ButtonCode  id  )  const

Returns the "What's this?" text of any button.

Definition at line 768 of file kdialog.cpp.

void KDialog::cancelClicked (  )  [signal]

The Cancel button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

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.

Definition at line 533 of file kdialog.cpp.

void KDialog::closeClicked (  )  [signal]

The Close button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::closeEvent ( QCloseEvent *  e  )  [protected, virtual]

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 QDialog behavior will take place.

Reimplemented in KBugReport.

Definition at line 972 of file kdialog.cpp.

KDialog::ButtonCode KDialog::defaultButton (  )  const

Returns the button code of the default button.

Definition at line 305 of file kdialog.cpp.

void KDialog::defaultClicked (  )  [signal]

The Default button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::delayedDestruct (  )  [slot]

Destruct the dialog delayed.

You can call this function from slots like closeClicked() and hidden(). You should not use the dialog any more after calling this function.

Definition at line 845 of file kdialog.cpp.

void KDialog::enableButton ( ButtonCode  id,
bool  state 
) [slot]

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

Parameters:
id Button identifier.
state true enables the button(s).

Definition at line 640 of file kdialog.cpp.

void KDialog::enableButtonApply ( bool  state  )  [slot]

Enable or disable (gray out) the Apply button.

Parameters:
state true enables the button.

Definition at line 661 of file kdialog.cpp.

void KDialog::enableButtonCancel ( bool  state  )  [slot]

Enable or disable (gray out) the Cancel button.

Parameters:
state true enables the button.

Definition at line 666 of file kdialog.cpp.

void KDialog::enableButtonOk ( bool  state  )  [slot]

Enable or disable (gray out) the OK button.

Parameters:
state true enables the button.

Definition at line 656 of file kdialog.cpp.

void KDialog::enableLinkedHelp ( bool  state  )  [slot]

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

Parameters:
state true will display the area.
See also:
helpLinkText()
setHelpLinkText()
setHelp()

Definition at line 912 of file kdialog.cpp.

void KDialog::finished (  )  [signal]

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 not try to delete the pointer in the slot that is connected to this signal.

You should use deleteLater() instead.

int KDialog::groupSpacingHint (  )  [static]

Returns the number of pixels that should be used to visually separate groups of related options in a dialog according to the KDE standard.

Since:
4.2

Definition at line 417 of file kdialog.cpp.

void KDialog::helpClicked (  )  [signal]

The Help button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

QString KDialog::helpLinkText (  )  const

Returns the help link text.

If no text has been defined, "Get help..." (internationalized) is returned.

Returns:
The help link text.
See also:
enableLinkedHelp()
setHelpLinkText()
setHelp()

Definition at line 954 of file kdialog.cpp.

void KDialog::hidden (  )  [signal]

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.

void KDialog::hideEvent ( QHideEvent *  event  )  [protected, virtual]

Emits the hidden signal.

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

Reimplemented in KEditToolBar.

Definition at line 964 of file kdialog.cpp.

void KDialog::incrementInitialSize ( const QSize &  size  ) 

Convenience method.

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

This method should only be called right before show() or exec().

Parameters:
size Size added to minimum size.

Definition at line 628 of file kdialog.cpp.

bool KDialog::isButtonEnabled ( ButtonCode  id  )  const

Returns whether any button is enabled.

Definition at line 647 of file kdialog.cpp.

bool KDialog::isDetailsWidgetVisible (  )  const [slot]

Returns the status of the Details button.

Definition at line 802 of file kdialog.cpp.

void KDialog::keyPressEvent ( QKeyEvent *  event  )  [protected, virtual]

For internal use only.

Reimplemented in KColorDialog.

Definition at line 364 of file kdialog.cpp.

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.

Deprecated:
This signal is not emitted. Listen to QEvent::StyleChange events instead.
QWidget * KDialog::mainWidget (  ) 
Returns:
The current main widget. Will create a QWidget as the mainWidget if none was set before. This way you can write
   ui.setupUi(mainWidget());
when using designer.

Definition at line 331 of file kdialog.cpp.

QString KDialog::makeStandardCaption ( const QString &  userCaption,
QWidget *  window = 0,
CaptionFlags  flags = HIGCompliantCaption 
) [static]

Builds a caption that contains the application name along with the userCaption using a standard layout.

To make a compliant caption for your window, simply do: setWindowTitle(KDialog::makeStandardCaption(yourCaption));

To ensure that the caption is appropriate to the desktop in which the application is running, pass in a pointer to the window the caption will be applied to.

If using a KDialog or KMainWindow subclass, call setCaption instead and an appropraite standard caption will be created for you

Parameters:
userCaption The caption string you want to display in the window caption area. Do not include the application name!
window a pointer to the window this application will apply to
flags 
Returns:
the created caption

Definition at line 422 of file kdialog.cpp.

int KDialog::marginHint (  )  [static]

Returns the number of pixels that should be used between a dialog edge and the outermost widget(s) according to the KDE standard.

Deprecated:
Use the style's pixelMetric() function to query individual margins. Different platforms may use different values for the four margins.

Definition at line 407 of file kdialog.cpp.

QSize KDialog::minimumSizeHint (  )  const [virtual]

Reimplemented from QDialog.

Definition at line 352 of file kdialog.cpp.

void KDialog::noClicked (  )  [signal]

The No button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::okClicked (  )  [signal]

The OK button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::resetClicked (  )  [signal]

The Reset button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::resizeLayout ( QLayout *  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
Deprecated:
Use QLayout functions where necessary. Setting margin and spacing values recursively for all children prevents QLayout from creating platform native layouts.

Definition at line 492 of file kdialog.cpp.

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.
Deprecated:
Use QLayout functions where necessary. Setting margin and spacing values recursively for all children prevents QLayout from creating platform native layouts.

Definition at line 478 of file kdialog.cpp.

void KDialog::restoreDialogSize ( const KConfigGroup &  config  ) 

Restores the dialog's size from the configuration according to the screen size.

Note:
the group must be set before calling
Parameters:
config The config group to read from.

Definition at line 982 of file kdialog.cpp.

void KDialog::saveDialogSize ( KConfigGroup &  config,
KConfigGroup::WriteConfigFlags  options = KConfigGroup::Normal 
) const

Saves the dialog's size dependent on the screen dimension either to the global or application config file.

Note:
the group must be set before calling
Parameters:
config The config group to read from.
options passed to KConfigGroup::writeEntry()

Definition at line 997 of file kdialog.cpp.

void KDialog::setButtonFocus ( ButtonCode  id  ) 

Sets the focus to the button of the passed id.

Definition at line 777 of file kdialog.cpp.

void KDialog::setButtonGuiItem ( ButtonCode  id,
const KGuiItem &  item 
)

Sets the KGuiItem 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.

Parameters:
id The button identifier.
item The KGuiItem for the button.

Definition at line 678 of file kdialog.cpp.

void KDialog::setButtonIcon ( ButtonCode  id,
const KIcon &  icon 
)

Sets the icon of any button.

Parameters:
id The button identifier.
icon Button icon.

Definition at line 721 of file kdialog.cpp.

void KDialog::setButtonMenu ( ButtonCode  id,
QMenu *  menu,
ButtonPopupMode  popupmode = InstantPopup 
)

Sets the menu of any button.

Parameters:
id The button identifier.
menu The menu.
popupmode Choose if KPushButton setMenu or setDelayedMenu is used

Definition at line 687 of file kdialog.cpp.

void KDialog::setButtons ( ButtonCodes  buttonMask  ) 

Creates (or recreates) the button box and all the buttons in it.

Note that some combinations are not possible. That means, you can't have the following pairs of buttons in a dialog:

  • Default and Details
  • Cancel and Close
  • Ok and Try

This will reset all default KGuiItem of all button.

Parameters:
buttonMask Specifies what buttons will be made.

Definition at line 207 of file kdialog.cpp.

void KDialog::setButtonsOrientation ( Qt::Orientation  orientation  ) 

Sets the orientation of the button box.

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

Parameters:
orientation The button box orientation.

Definition at line 269 of file kdialog.cpp.

void KDialog::setButtonText ( ButtonCode  id,
const QString &  text 
)

Sets the text of any button.

Parameters:
id The button identifier.
text Button text.

Definition at line 698 of file kdialog.cpp.

void KDialog::setButtonToolTip ( ButtonCode  id,
const QString &  text 
)

Sets the tooltip text of any button.

Parameters:
id The button identifier.
text Button text.

Definition at line 737 of file kdialog.cpp.

void KDialog::setButtonWhatsThis ( ButtonCode  id,
const QString &  text 
)

Sets the "What's this?" text of any button.

Parameters:
id The button identifier.
text Button text.

Definition at line 757 of file kdialog.cpp.

void KDialog::setCaption ( const QString &  caption,
bool  modified 
) [virtual, slot]

Makes 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.
modified Specify whether the document is modified. This displays an additional sign in the title bar, usually "**".

Definition at line 455 of file kdialog.cpp.

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 449 of file kdialog.cpp.

void KDialog::setDefaultButton ( ButtonCode  id  ) 

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

By default, this is the Ok button if it is present

Parameters:
id The button code.

Definition at line 288 of file kdialog.cpp.

void KDialog::setDetailsWidget ( QWidget *  detailsWidget  )  [slot]

Sets the widget that gets shown when "Details" is enabled.

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

Definition at line 784 of file kdialog.cpp.

void KDialog::setDetailsWidgetVisible ( bool  visible  )  [slot]

Sets the status of the Details button.

Definition at line 807 of file kdialog.cpp.

void KDialog::setEscapeButton ( ButtonCode  id  ) 

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

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.

Parameters:
id The button code.

Definition at line 283 of file kdialog.cpp.

void KDialog::setHelp ( const QString &  anchor,
const QString &  appname = QString() 
) [slot]

Sets the help path and topic.

Parameters:
anchor Defined anchor in your docbook sources
appname Defines the appname the help belongs to If empty it's the current one
Note:
The help button works differently for the class KCMultiDialog, so it does not make sense to call this function for Dialogs of that type. See KCMultiDialog::slotHelp() for more information.

Definition at line 938 of file kdialog.cpp.

void KDialog::setHelpLinkText ( const QString &  text  )  [slot]

Sets the text that is shown as the linked text.

If text is empty, the text "Get help..." (internationalized) is used instead.

Parameters:
text The link text.
See also:
helpLinkText()
enableLinkedHelp()
setHelp()

Definition at line 946 of file kdialog.cpp.

void KDialog::setInitialSize ( const QSize &  size  ) 

Convenience method.

Sets the initial dialog size.

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

Parameters:
size Startup size.

Definition at line 622 of file kdialog.cpp.

void KDialog::setMainWidget ( QWidget *  widget  ) 

Sets the main widget of the dialog.

Definition at line 318 of file kdialog.cpp.

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 468 of file kdialog.cpp.

void KDialog::showButton ( ButtonCode  id,
bool  state 
)

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.

Parameters:
id Button identifier.
state true display the button(s).

Definition at line 671 of file kdialog.cpp.

void KDialog::showButtonSeparator ( bool  state  ) 

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

Definition at line 603 of file kdialog.cpp.

QSize KDialog::sizeHint (  )  const [virtual]

Reimplemented from QDialog.

Reimplemented in KShortcutsDialog.

Definition at line 339 of file kdialog.cpp.

void KDialog::slotButtonClicked ( int  button  )  [protected, virtual, slot]

Activated when the button button is clicked.

Sample that shows how to catch and handle button clicks within an own dialog;

 class MyDialog : public KDialog {
     protected Q_SLOTS:
         virtual void slotButtonClicked(int button) {
             if (button == KDialog::Ok)
                 accept();
             else
                 KDialog::slotButtonClicked(button);
         }
 }
Parameters:
button is the type KDialog::ButtonCode

Definition at line 854 of file kdialog.cpp.

int KDialog::spacingHint (  )  [static]

Returns the number of pixels that should be used between widgets inside a dialog according to the KDE standard.

Deprecated:
Use the style's layoutSpacing() function to query individual spacings. Different platforms may use different values depending on widget types and pairs.

Definition at line 412 of file kdialog.cpp.

void KDialog::tryClicked (  )  [signal]

The Try button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::updateGeometry (  )  [protected, slot]

Updates the margins and spacings.

Deprecated:
KDialog respects the style's margins and spacings automatically. Calling this function has no effect.

Definition at line 960 of file kdialog.cpp.

void KDialog::user1Clicked (  )  [signal]

The User1 button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::user2Clicked (  )  [signal]

The User2 button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::user3Clicked (  )  [signal]

The User3 button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

void KDialog::yesClicked (  )  [signal]

The Yes button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced


Member Data Documentation

KDialogPrivate* const KDialog::d_ptr [protected]

Definition at line 845 of file kdialog.h.


The documentation for this class was generated from the following files:
  • kdialog.h
  • kdialog.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal