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) |
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 42 of file kmessagebox.h.
Member Enumeration Documentation
|
Button types.
Definition at line 48 of file kmessagebox.h. Referenced by questionYesNoCancelWId(), questionYesNoListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Definition at line 75 of file kmessagebox.h. |
Member Function Documentation
|
Display a simple "question" dialog.
The default button is "Yes". Pressing "Esc" selects "No". Definition at line 293 of file kmessagebox.cpp. References questionYesNo(), and questionYesNoList(). 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 305 of file kmessagebox.cpp. References questionYesNoListWId(), and questionYesNoWId(). Referenced by messageBoxWId(), and questionYesNoWId(). |
|
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 424 of file kmessagebox.cpp. References questionYesNoCancel(), and questionYesNoCancelWId(). Referenced by questionYesNoCancel(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 437 of file kmessagebox.cpp. References ButtonCode, questionYesNoCancelWId(), saveDontShowAgainYesNo(), and shouldBeShownYesNo(). Referenced by messageBoxWId(), questionYesNoCancel(), and questionYesNoCancelWId(). |
|
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 377 of file kmessagebox.cpp. References questionYesNoList(), and questionYesNoListWId(). Referenced by questionYesNo(), and questionYesNoList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 390 of file kmessagebox.cpp. References ButtonCode, questionYesNoListWId(), saveDontShowAgainYesNo(), and shouldBeShownYesNo(). Referenced by questionYesNoList(), questionYesNoListWId(), and questionYesNoWId(). |
|
Display a "warning" dialog.
The default button is "No". Pressing "Esc" selects "No". Definition at line 473 of file kmessagebox.cpp. References warningYesNo(), and warningYesNoList(). 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 485 of file kmessagebox.cpp. References warningYesNoListWId(), and warningYesNoWId(). Referenced by messageBoxWId(), and warningYesNoWId(). |
|
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 497 of file kmessagebox.cpp. References warningYesNoList(), and warningYesNoListWId(). Referenced by warningYesNo(), and warningYesNoList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 510 of file kmessagebox.cpp. References ButtonCode, saveDontShowAgainYesNo(), shouldBeShownYesNo(), and warningYesNoListWId(). Referenced by warningYesNoList(), warningYesNoListWId(), and warningYesNoWId(). |
|
Display a "warning" dialog.
The default button is buttonContinue. Pressing "Esc" selects "Cancel". Definition at line 549 of file kmessagebox.cpp. References warningContinueCancel(), and warningContinueCancelList(). 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 561 of file kmessagebox.cpp. References warningContinueCancelListWId(), and warningContinueCancelWId(). Referenced by messageBoxWId(), and warningContinueCancelWId(). |
|
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 573 of file kmessagebox.cpp. References warningContinueCancelList(), and warningContinueCancelListWId(). Referenced by warningContinueCancel(), and warningContinueCancelList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 585 of file kmessagebox.cpp. References saveDontShowAgainContinue(), shouldBeShownContinue(), and warningContinueCancelListWId(). Referenced by warningContinueCancelList(), warningContinueCancelListWId(), 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 618 of file kmessagebox.cpp. References warningYesNoCancel(), and warningYesNoCancelList(). 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 630 of file kmessagebox.cpp. References warningYesNoCancelListWId(), and warningYesNoCancelWId(). Referenced by messageBoxWId(), and warningYesNoCancelWId(). |
|
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 642 of file kmessagebox.cpp. References warningYesNoCancelList(), and warningYesNoCancelListWId(). Referenced by warningYesNoCancel(), and warningYesNoCancelList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 655 of file kmessagebox.cpp. References ButtonCode, saveDontShowAgainYesNo(), shouldBeShownYesNo(), and warningYesNoCancelListWId(). Referenced by warningYesNoCancelList(), warningYesNoCancelListWId(), 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 690 of file kmessagebox.cpp. References error(), and errorWId(). Referenced by error(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 697 of file kmessagebox.cpp. References errorWId(). Referenced by error(), errorWId(), 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 714 of file kmessagebox.cpp. References detailedError(), and detailedErrorWId(). Referenced by detailedError(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 722 of file kmessagebox.cpp. References detailedErrorWId(). Referenced by detailedError(), detailedErrorWId(), 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 740 of file kmessagebox.cpp. References queuedDetailedError(), and queuedDetailedErrorWId(). Referenced by queuedDetailedError(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 748 of file kmessagebox.cpp. References detailedErrorWId(), and queuedDetailedErrorWId(). Referenced by queuedDetailedError(), and queuedDetailedErrorWId(). |
|
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 759 of file kmessagebox.cpp. References sorry(), and sorryWId(). Referenced by sorry(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 766 of file kmessagebox.cpp. References sorryWId(). Referenced by messageBoxWId(), sorry(), and sorryWId(). |
|
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 783 of file kmessagebox.cpp. References detailedSorry(), and detailedSorryWId(). Referenced by detailedSorry(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 791 of file kmessagebox.cpp. References detailedSorryWId(). Referenced by detailedSorry(), and detailedSorryWId(). |
|
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 809 of file kmessagebox.cpp. References information(), and informationList(). 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 816 of file kmessagebox.cpp. References informationListWId(), and informationWId(). Referenced by informationWId(), and 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 823 of file kmessagebox.cpp. References informationList(), and informationListWId(). Referenced by information(), and informationList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 831 of file kmessagebox.cpp. References informationListWId(), saveDontShowAgainContinue(), and shouldBeShownContinue(). Referenced by informationList(), informationListWId(), and informationWId(). |
|
Enable all messages which have been turned off with the
Definition at line 858 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::deleteEntry(), KConfig::entryMap(), KConfigBase::hasGroup(), and KConfigBase::sync(). |
|
Re-enable a specific
Definition at line 878 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::deleteEntry(), enableMessage(), KConfigBase::hasGroup(), and KConfigBase::sync(). Referenced by enableMessage(). |
|
Display an "About" dialog.
The default button is "&OK". NOTE: The ok button will always have the i18n'ed text '&OK'. Definition at line 892 of file kmessagebox.cpp. References about(). Referenced by about(). |
|
Alternate method to show a messagebox:.
Definition at line 915 of file kmessagebox.cpp. References messageBox(), and messageBoxWId(). Referenced by messageBox(). |
|
Alternate method to show a messagebox:.
Definition at line 924 of file kmessagebox.cpp. References messageBox(), and messageBoxWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 932 of file kmessagebox.cpp. References errorWId(), informationWId(), messageBoxWId(), questionYesNoCancelWId(), questionYesNoWId(), sorryWId(), warningContinueCancelWId(), warningYesNoCancelWId(), and warningYesNoWId(). Referenced by messageBox(), messageBoxWId(), 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 969 of file kmessagebox.cpp. References queuedMessageBox(), and queuedMessageBoxWId(). Referenced by queuedMessageBox(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 974 of file kmessagebox.cpp. References messageBoxWId(), and queuedMessageBoxWId(). Referenced by queuedMessageBox(), and queuedMessageBoxWId(). |
|
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 982 of file kmessagebox.cpp. References queuedMessageBox(), and 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(), and queuedMessageBoxWId(). |
|
Definition at line 317 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::readEntry(), and shouldBeShownYesNo(). Referenced by questionYesNoCancelWId(), questionYesNoListWId(), shouldBeShownYesNo(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Definition at line 337 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::readBoolEntry(), and shouldBeShownContinue(). Referenced by informationListWId(), shouldBeShownContinue(), and warningContinueCancelListWId(). |
|
Save the fact that the yes/no message box should not be shown again.
Definition at line 347 of file kmessagebox.cpp. References KGlobal::config(), saveDontShowAgainYesNo(), KConfigBase::sync(), and KConfigBase::writeEntry(). Referenced by questionYesNoCancelWId(), questionYesNoListWId(), saveDontShowAgainYesNo(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Save the fact that the continue/cancel message box should not be shown again.
Definition at line 359 of file kmessagebox.cpp. References KGlobal::config(), saveDontShowAgainContinue(), KConfigBase::sync(), and KConfigBase::writeEntry(). Referenced by informationListWId(), saveDontShowAgainContinue(), and warningContinueCancelListWId(). |
|
Use
If
Definition at line 371 of file kmessagebox.cpp. References setDontShowAskAgainConfig(). Referenced by setDontShowAskAgainConfig(). |
The documentation for this class was generated from the following files: