KMessageBox Class Reference
Easy message dialog box. More...
#include <kmessagebox.h>
Collaboration diagram for KMessageBox:

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, PlainCaption = 8, NoExec = 16 } |
Static Public Member Functions | |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static void | error (QWidget *parent, const QString &text, const QString &caption=QString::null, int options=Notify) |
static void | errorWId (WId parent_id, const QString &text, const QString &caption=QString::null, int options=Notify) |
static void | errorList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, int options=Notify) |
static void | errorListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, int options=Notify) |
static void | detailedError (QWidget *parent, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
static void | detailedErrorWId (WId parent_id, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
static void | queuedDetailedError (QWidget *parent, const QString &text, const QString &details, const QString &caption=QString::null) |
static void | queuedDetailedErrorWId (WId parent_id, const QString &text, const QString &details, const QString &caption=QString::null) |
static void | sorry (QWidget *parent, const QString &text, const QString &caption=QString::null, int options=Notify) |
static void | sorryWId (WId parent_id, const QString &text, const QString &caption=QString::null, int options=Notify) |
static void | detailedSorry (QWidget *parent, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
static void | detailedSorryWId (WId parent_id, const QString &text, const QString &details, const QString &caption=QString::null, int options=Notify) |
static void | information (QWidget *parent, const QString &text, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
static void | informationWId (WId parent_id, const QString &text, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
static void | informationList (QWidget *parent, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
static void | informationListWId (WId parent_id, const QString &text, const QStringList &strlist, const QString &caption=QString::null, const QString &dontShowAgainName=QString::null, int options=Notify) |
static void | enableAllMessages () |
static void | enableMessage (const QString &dontShowAgainName) |
static void | about (QWidget *parent, const QString &text, const QString &caption=QString::null, int options=Notify) |
static int | messageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption, const KGuiItem &buttonYes, const KGuiItem &buttonNo, const QString &dontShowAskAgainName, int options=Notify) |
static 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) |
static 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) |
static void | queuedMessageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption, int options) |
static void | queuedMessageBoxWId (WId parent_id, DialogType type, const QString &text, const QString &caption, int options) |
static void | queuedMessageBox (QWidget *parent, DialogType type, const QString &text, const QString &caption=QString::null) |
static void | queuedMessageBoxWId (WId parent_id, DialogType type, const QString &text, const QString &caption=QString::null) |
static bool | shouldBeShownYesNo (const QString &dontShowAgainName, ButtonCode &result) |
static bool | shouldBeShownContinue (const QString &dontShowAgainName) |
static void | saveDontShowAgainYesNo (const QString &dontShowAgainName, ButtonCode result) |
static void | saveDontShowAgainContinue (const QString &dontShowAgainName) |
static void | setDontShowAskAgainConfig (KConfig *cfg) |
static 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) |
static 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. |
|
Definition at line 79 of file kmessagebox.h. |
Member Function Documentation
|
Display a simple "question" dialog.
The default button is "Yes". Pressing "Esc" selects "No". Definition at line 319 of file kmessagebox.cpp. References questionYesNoList(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 331 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 454 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 467 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, saveDontShowAgainYesNo(), KDialog::setPlainCaption(), 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 403 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 416 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, saveDontShowAgainYesNo(), KDialog::setPlainCaption(), and shouldBeShownYesNo(). Referenced by questionYesNoList(), and questionYesNoWId(). |
|
Display a "warning" dialog.
The default button is "No". Pressing "Esc" selects "No". Definition at line 507 of file kmessagebox.cpp. References warningYesNoList(). Referenced by KBugReport::slotCancel(), and 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 519 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 531 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 544 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, saveDontShowAgainYesNo(), KDialog::setPlainCaption(), and shouldBeShownYesNo(). Referenced by warningYesNoList(), and warningYesNoWId(). |
|
Display a "warning" dialog.
The default button is buttonContinue. Pressing "Esc" selects "Cancel". Definition at line 587 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 599 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 611 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 623 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, saveDontShowAgainContinue(), KDialog::setPlainCaption(), 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 660 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 672 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 684 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 697 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, saveDontShowAgainYesNo(), KDialog::setPlainCaption(), 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 736 of file kmessagebox.cpp. References errorListWId(). 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 743 of file kmessagebox.cpp. References errorListWId(). Referenced by messageBoxWId(). |
|
Display an "Error" dialog with a listbox.
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 750 of file kmessagebox.cpp. References errorListWId(). |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 757 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, and KDialog::setPlainCaption(). Referenced by error(), errorList(), and errorWId(). |
|
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 778 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 786 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, and KDialog::setPlainCaption(). 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 808 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 816 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 827 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 834 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, and KDialog::setPlainCaption(). 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 855 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 863 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, and KDialog::setPlainCaption(). 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 885 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 892 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 899 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 907 of file kmessagebox.cpp. References createKMessageBox(), QWidget::find(), PlainCaption, saveDontShowAgainContinue(), KDialog::setPlainCaption(), and shouldBeShownContinue(). Referenced by informationList(), and informationWId(). |
|
Enable all messages which have been turned off with the
Definition at line 938 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::deleteEntry(), KConfig::entryMap(), QString::fromLatin1(), KConfigBase::hasGroup(), and KConfigBase::sync(). |
|
Re-enable a specific
Definition at line 958 of file kmessagebox.cpp. References KGlobal::config(), KConfigBase::deleteEntry(), QString::fromLatin1(), 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 972 of file kmessagebox.cpp. References QString::arg(), createKMessageBox(), KApplication::icon(), QString::isEmpty(), QPixmap::isNull(), KApplication::kApplication(), and QMessageBox::standardIcon(). |
|
Alternate method to show a messagebox:.
Definition at line 996 of file kmessagebox.cpp. References messageBoxWId(). |
|
Alternate method to show a messagebox:.
Definition at line 1005 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 1013 of file kmessagebox.cpp. References errorWId(), informationWId(), questionYesNoCancelWId(), questionYesNoWId(), sorryWId(), 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 1050 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 1055 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 1063 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 1068 of file kmessagebox.cpp. References messageBoxWId(). |
|
Definition at line 343 of file kmessagebox.cpp. References KGlobal::config(), QString::fromLatin1(), QString::lower(), and KConfigBase::readEntry(). Referenced by questionYesNoCancelWId(), questionYesNoListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Definition at line 363 of file kmessagebox.cpp. References KGlobal::config(), QString::fromLatin1(), 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 373 of file kmessagebox.cpp. References KGlobal::config(), QString::fromLatin1(), 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 385 of file kmessagebox.cpp. References KGlobal::config(), QString::fromLatin1(), KConfigBase::sync(), and KConfigBase::writeEntry(). Referenced by informationListWId(), and warningContinueCancelListWId(). |
|
Use
If
Definition at line 397 of file kmessagebox.cpp. |
|
Create content and layout of a standard dialog.
Definition at line 142 of file kmessagebox.cpp. Referenced by about(), detailedErrorWId(), detailedSorryWId(), errorListWId(), informationListWId(), questionYesNoCancelWId(), questionYesNoListWId(), sorryWId(), warningContinueCancelListWId(), warningYesNoCancelListWId(), and warningYesNoListWId(). |
|
Create content and layout of a standard dialog.
Definition at line 151 of file kmessagebox.cpp. References KGlobalSettings::desktopGeometry(), QObject::disconnect(), QRect::height(), QListBox::insertStringList(), QPushButton::isDefault(), QPixmap::isNull(), NoExec, QLabel::setPixmap(), QTextEdit::setReadOnly(), QListBox::setSelectionMode(), QRect::setWidth(), KActiveLabel::sizeHint(), and QRect::width(). |
The documentation for this class was generated from the following files: