KMessageBox Class Reference
Easy message dialog box. More...
#include <kmessagebox.h>
Public Types | |
enum | ButtonCode { Ok = 1, Cancel = 2, Yes = 3, No = 4, Continue = 5 } |
enum | DialogType { QuestionYesNo = 1, WarningYesNo = 2, WarningContinueCancel = 3, WarningYesNoCancel = 4, Information = 5, Sorry = 7, Error = 8, QuestionYesNoCancel = 9 } |
enum | OptionsType { Notify = 1, AllowLink = 2, Dangerous = 4 } |
Static Public Member Functions | |
int | questionYesNo (QWidget *parent, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | questionYesNoWId (WId parent_id, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | questionYesNoCancel (QWidget *parent, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | questionYesNoCancelWId (WId parent_id, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | questionYesNoList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | questionYesNoListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningYesNo (QWidget *parent, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify|Dangerous) |
int | warningYesNoWId (WId parent_id, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify|Dangerous) |
int | warningYesNoList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify|Dangerous) |
int | warningYesNoListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify|Dangerous) |
int | warningContinueCancel (QWidget *parent, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonContinue=KStdGuiItem::cont(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningContinueCancelWId (WId parent_id, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonContinue=KStdGuiItem::cont(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningContinueCancelList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonContinue=KStdGuiItem::cont(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningContinueCancelListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonContinue=KStdGuiItem::cont(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningYesNoCancel (QWidget *parent, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningYesNoCancelWId (WId parent_id, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningYesNoCancelList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
int | warningYesNoCancelListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontAskAgainName=QString::null, int options=Notify) |
void | error (QWidget *parent, const QString &text, const QString &caption=QString::null, int options=Notify) |
void | errorWId (WId parent_id, const QString &text, const QString &caption=QString::null, int options=Notify) |
void | detailedError (QWidget *parent, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
void | detailedErrorWId (WId parent_id, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
void | queuedDetailedError (QWidget *parent, const QString &text, const QString &details, const QString &caption=QString::null) |
void | queuedDetailedErrorWId (WId parent_id, const QString &text, const QString &details, const QString &caption=QString::null) |
void | sorry (QWidget *parent, const QString &text, const QString &caption=QString::null, int options=Notify) |
void | sorryWId (WId parent_id, const QString &text, const QString &caption=QString::null, int options=Notify) |
void | detailedSorry (QWidget *parent, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
void | detailedSorryWId (WId parent_id, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
void | information (QWidget *parent, const QString &text, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
void | informationWId (WId parent_id, const QString &text, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
void | informationList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
void | informationListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
void | enableAllMessages () |
void | enableMessage (const QString &dontShowAgainName) |
void | about (QWidget *parent, const QString &text, const QString &caption=QString::null, int options=Notify) |
int | messageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption, const KGuiItem &buttonYes, const KGuiItem &buttonNo, const QString &dontShowAskAgainName, int options=Notify) |
int | messageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), int options=Notify) |
int | messageBoxWId (WId parent_id, DialogType type, const QString &text, const QString &caption=QString::null, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const QString &dontShowAskAgainName=QString::null, int options=Notify) |
void | queuedMessageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption, int options) |
void | queuedMessageBoxWId (WId parent_id, DialogType type, const QString &text, const QString &caption, int options) |
void | queuedMessageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption=QString::null) |
void | queuedMessageBoxWId (WId parent_id, DialogType type, const QString &text, const QString &caption=QString::null) |
bool | shouldBeShownYesNo (const QString &dontShowAgainName, ButtonCode &result) |
bool | shouldBeShownContinue (const QString &dontShowAgainName) |
void | saveDontShowAgainYesNo (const QString &dontShowAgainName, ButtonCode result) |
void | saveDontShowAgainContinue (const QString &dontShowAgainName) |
void | setDontShowAskAgainConfig (KConfig *cfg) |
int | createKMessageBox (KDialogBase *dialog, QMessageBox::Icon icon, const QString &text, const QStringList &strlist, const QString &ask, bool *checkboxReturn, int options, const QString &details=QString::null) |
int | createKMessageBox (KDialogBase *dialog, QPixmap icon, const QString &text, const QStringList &strlist, const QString &ask, bool *checkboxReturn, int options, const QString &details=QString::null, QMessageBox::Icon notifyType=QMessageBox::Information) |
Detailed Description
Easy message dialog box.Provides convenience functions for some i18n'ed standard dialogs.
The text in message boxes is wrapped automatically. The text may either be plaintext or richtext. If the text is plaintext, a newline-character may be used to indicate the end of a paragraph.
- Author:
- Waldo Bastian (bastian@kde.org)
Definition at line 44 of file kmessagebox.h.
Member Enumeration Documentation
|
Button types.
Definition at line 50 of file kmessagebox.h. Referenced by questionYesNoCancelWId(), questionYesNoListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Definition at line 77 of file kmessagebox.h. |
Member Function Documentation
|
Display a simple "question" dialog.
The default button is "Yes". Pressing "Esc" selects "No". Definition at line 305 of file kmessagebox.cpp. References questionYesNoList(). Referenced by KBugReport::slotOk(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 317 of file kmessagebox.cpp. References questionYesNoListWId(). Referenced by messageBoxWId(). |
|
Display a simple "question" dialog.
The default button is "Yes". Pressing "Esc" selects "Cancel". NOTE: The cancel button will always have the i18n'ed text '&Cancel'. Definition at line 436 of file kmessagebox.cpp. References questionYesNoCancelWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 449 of file kmessagebox.cpp. References ButtonCode, createKMessageBox(), saveDontShowAgainYesNo(), and shouldBeShownYesNo(). Referenced by messageBoxWId(), and questionYesNoCancel(). |
|
Display a "question" dialog with a listbox to show information to the user.
The default button is "Yes". Pressing "Esc" selects "No". Definition at line 389 of file kmessagebox.cpp. References questionYesNoListWId(). Referenced by questionYesNo(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 402 of file kmessagebox.cpp. References ButtonCode, createKMessageBox(), saveDontShowAgainYesNo(), and shouldBeShownYesNo(). Referenced by questionYesNoList(), and questionYesNoWId(). |
|
Display a "warning" dialog.
The default button is "No". Pressing "Esc" selects "No". Definition at line 485 of file kmessagebox.cpp. References warningYesNoList(). Referenced by KBugReport::slotCancel(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 497 of file kmessagebox.cpp. References warningYesNoListWId(). Referenced by messageBoxWId(). |
|
Display a "warning" dialog with a listbox to show information to the user.
The default button is "No". Pressing "Esc" selects "No". Definition at line 509 of file kmessagebox.cpp. References warningYesNoListWId(). Referenced by warningYesNo(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 522 of file kmessagebox.cpp. References ButtonCode, createKMessageBox(), saveDontShowAgainYesNo(), and shouldBeShownYesNo(). Referenced by warningYesNoList(), and warningYesNoWId(). |
|
Display a "warning" dialog.
The default button is buttonContinue. Pressing "Esc" selects "Cancel". Definition at line 561 of file kmessagebox.cpp. References warningContinueCancelList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 573 of file kmessagebox.cpp. References warningContinueCancelListWId(). Referenced by messageBoxWId(). |
|
Display a "warning" dialog with a listbox to show information to the user.
The default button is buttonContinue. Pressing "Esc" selects "Cancel". Definition at line 585 of file kmessagebox.cpp. References warningContinueCancelListWId(). Referenced by warningContinueCancel(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 597 of file kmessagebox.cpp. References createKMessageBox(), saveDontShowAgainContinue(), and shouldBeShownContinue(). Referenced by warningContinueCancelList(), and warningContinueCancelWId(). |
|
Display a Yes/No/Cancel "warning" dialog.
The default button is "Yes". Pressing "Esc" selects "Cancel" NOTE: The cancel button will always have the i18n'ed text '&Cancel'. Definition at line 630 of file kmessagebox.cpp. References warningYesNoCancelList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 642 of file kmessagebox.cpp. References warningYesNoCancelListWId(). Referenced by messageBoxWId(). |
|
Display a Yes/No/Cancel "warning" dialog with a listbox to show information to the user.
The default button is "Yes". Pressing "Esc" selects "Cancel" NOTE: The cancel button will always have the i18n'ed text '&Cancel'.
Definition at line 654 of file kmessagebox.cpp. References warningYesNoCancelListWId(). Referenced by warningYesNoCancel(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 667 of file kmessagebox.cpp. References ButtonCode, createKMessageBox(), saveDontShowAgainYesNo(), and shouldBeShownYesNo(). Referenced by warningYesNoCancelList(), and warningYesNoCancelWId(). |
|
Display an "Error" dialog.
If your program detects the action specified by the user is somehow not allowed, this should never be reported with error(). Use sorry() instead to explain to the user that this action is not allowed. The default button is "&OK". Pressing "Esc" selects the OK-button. NOTE: The OK button will always have the i18n'ed text '&OK'. Definition at line 702 of file kmessagebox.cpp. References errorWId(). Referenced by KBugReport::slotOk(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 709 of file kmessagebox.cpp. References createKMessageBox(). Referenced by error(), and messageBoxWId(). |
|
Displays an "Error" dialog with a "Details >>" button.
The If your program detects the action specified by the user is somehow not allowed, this should never be reported with error(). Use sorry() instead to explain to the user that this action is not allowed. The default button is "&OK". Pressing "Esc" selects the OK-button. NOTE: The OK button will always have the i18n'ed text '&OK'. Definition at line 726 of file kmessagebox.cpp. References detailedErrorWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 734 of file kmessagebox.cpp. References createKMessageBox(). Referenced by detailedError(), and queuedDetailedErrorWId(). |
|
Like detailedError. This function will return immediately, the messagebox will be shown once the application enters an event loop and no other messagebox is being shown. Note that if the parent gets deleted, the messagebox will not be shown. Definition at line 752 of file kmessagebox.cpp. References queuedDetailedErrorWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 760 of file kmessagebox.cpp. References detailedErrorWId(). Referenced by queuedDetailedError(). |
|
Display an "Sorry" dialog.
To be used for small problems like "Sorry, I can't find the file you specified." The default button is "&OK". Pressing "Esc" selects the OK-button. NOTE: The ok button will always have the i18n'ed text '&OK'. Definition at line 771 of file kmessagebox.cpp. References sorryWId(). Referenced by KPasswordDialog::slotOk(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 778 of file kmessagebox.cpp. References createKMessageBox(). Referenced by messageBoxWId(), and sorry(). |
|
Displays a "Sorry" dialog with a "Details >>" button.
To be used for small problems like "Sorry, I can't find the file you specified."
And then The default button is "&OK". Pressing "Esc" selects the OK-button. NOTE: The ok button will always have the i18n'ed text '&OK'. Definition at line 795 of file kmessagebox.cpp. References detailedSorryWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 803 of file kmessagebox.cpp. References createKMessageBox(). Referenced by detailedSorry(). |
|
Display an "Information" dialog.
The default button is "&OK". Pressing "Esc" selects the OK-button. NOTE: The OK button will always have the i18n'ed text '&OK'. Definition at line 821 of file kmessagebox.cpp. References informationList(). Referenced by KBugReport::slotOk(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 828 of file kmessagebox.cpp. References informationListWId(). Referenced by messageBoxWId(). |
|
Display an "Information" dialog with a listbox.
The default button is "&OK". Pressing "Esc" selects the OK-button. NOTE: The OK button will always have the i18n'ed text '&OK'.
Definition at line 835 of file kmessagebox.cpp. References informationListWId(). Referenced by information(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 843 of file kmessagebox.cpp. References createKMessageBox(), saveDontShowAgainContinue(), and shouldBeShownContinue(). Referenced by informationList(), and informationWId(). |
|
Enable all messages which have been turned off with the
Definition at line 870 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::deleteEntry(), KConfig::entryMap(), KConfigBase::hasGroup(), and KConfigBase::sync(). |
|
Re-enable a specific
Definition at line 890 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::deleteEntry(), KConfigBase::hasGroup(), and KConfigBase::sync(). |
|
Display an "About" dialog.
The default button is "&OK". NOTE: The ok button will always have the i18n'ed text '&OK'. Definition at line 904 of file kmessagebox.cpp. References createKMessageBox(), KApplication::icon(), and KApplication::kApplication(). |
|
Alternate method to show a messagebox:.
Definition at line 928 of file kmessagebox.cpp. References messageBoxWId(). |
|
Alternate method to show a messagebox:.
Definition at line 937 of file kmessagebox.cpp. References messageBoxWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 945 of file kmessagebox.cpp. References errorWId(), informationWId(), questionYesNoCancelWId(), questionYesNoWId(), sorryWId(), KGuiItem::text(), warningContinueCancelWId(), warningYesNoCancelWId(), and warningYesNoWId(). Referenced by messageBox(), and queuedMessageBoxWId(). |
|
Like messageBox. Only for message boxes of type Information, Sorry or Error. This function will return immediately, the messagebox will be shown once the application enters an event loop and no other messagebox is being shown. Note that if the parent gets deleted, the messagebox will not be shown. Definition at line 982 of file kmessagebox.cpp. References queuedMessageBoxWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 987 of file kmessagebox.cpp. References messageBoxWId(). Referenced by queuedMessageBox(). |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is an overloaded member function, provided for convenience. It behaves essentially like the above function. Definition at line 995 of file kmessagebox.cpp. References queuedMessageBoxWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 1000 of file kmessagebox.cpp. References messageBoxWId(). |
|
Definition at line 329 of file kmessagebox.cpp. References KGlobal::config(), and KConfigBase::readEntry(). Referenced by questionYesNoCancelWId(), questionYesNoListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Definition at line 349 of file kmessagebox.cpp. References KGlobal::config(), and KConfigBase::readBoolEntry(). Referenced by informationListWId(), and warningContinueCancelListWId(). |
|
Save the fact that the yes/no message box should not be shown again.
Definition at line 359 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::sync(), and KConfigBase::writeEntry(). Referenced by questionYesNoCancelWId(), questionYesNoListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Save the fact that the continue/cancel message box should not be shown again.
Definition at line 371 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::sync(), and KConfigBase::writeEntry(). Referenced by informationListWId(), and warningContinueCancelListWId(). |
|
Use
If
Definition at line 383 of file kmessagebox.cpp. |
|
Create content and layout of a standard dialog.
Definition at line 141 of file kmessagebox.cpp. Referenced by about(), detailedErrorWId(), detailedSorryWId(), errorWId(), informationListWId(), questionYesNoCancelWId(), questionYesNoListWId(), sorryWId(), warningContinueCancelListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Create content and layout of a standard dialog.
Definition at line 150 of file kmessagebox.cpp. References KDialogBase::actionButton(), KDialogBase::ButtonCode, KGlobalSettings::desktopGeometry(), KDialogBase::disableResize(), KDialogBase::enableButtonSeparator(), KDialogBase::setDetailsWidget(), KDialogBase::setMainWidget(), KWin::setState(), and KActiveLabel::sizeHint(). |
The documentation for this class was generated from the following files: