kdeui Library API Documentation

kmessagebox.h

00001 /*  This file is part of the KDE libraries
00002     Copyright (C) 1999 Waldo Bastian (bastian@kde.org)
00003 
00004     This library is free software; you can redistribute it and/or
00005     modify it under the terms of the GNU Library General Public
00006     License as published by the Free Software Foundation; version 2
00007     of the License.
00008 
00009     This library is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012     Library General Public License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to
00016     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00017     Boston, MA 02111-1307, USA.
00018 */
00019 #ifndef _KMESSAGEBOX_H_
00020 #define _KMESSAGEBOX_H_
00021 
00022 #include <qstring.h>
00023 
00024 #include <kguiitem.h>
00025 #include <kstdguiitem.h>
00026 #include <qmessagebox.h>
00027 
00028 class QWidget;
00029 class QStringList;
00030 class KConfig;
00031 class KDialogBase;
00032 
00044 class KMessageBox
00045 {
00046 public:
00050  enum ButtonCode
00051  {
00052    Ok = 1,
00053    Cancel = 2,
00054    Yes = 3,
00055    No = 4,
00056    Continue = 5
00057  };
00058 
00059  enum DialogType
00060  {
00061    QuestionYesNo = 1,
00062    WarningYesNo = 2,
00063    WarningContinueCancel = 3,
00064    WarningYesNoCancel = 4,
00065    Information = 5,
00066    // Reserved for: SSLMessageBox = 6
00067    Sorry = 7,
00068    Error = 8,
00069    QuestionYesNoCancel = 9
00070  };
00071 
00077  enum OptionsType
00078  {
00079    Notify = 1,
00080    AllowLink = 2,
00081    Dangerous = 4
00082  };
00083 
00114  static int questionYesNo(QWidget *parent,
00115                           const QString &text,
00116                           const QString &caption = QString::null,
00117                           const KGuiItem &buttonYes = KStdGuiItem::yes(),
00118                           const KGuiItem &buttonNo =  KStdGuiItem::no(),
00119                           const QString &dontAskAgainName = QString::null,
00120                           int options = Notify);
00126  static int questionYesNoWId(WId parent_id,
00127                           const QString &text,
00128                           const QString &caption = QString::null,
00129                           const KGuiItem &buttonYes = KStdGuiItem::yes(),
00130                           const KGuiItem &buttonNo =  KStdGuiItem::no(),
00131                           const QString &dontAskAgainName = QString::null,
00132                           int options = Notify);
00165   static int questionYesNoCancel(QWidget *parent,
00166                           const QString &text,
00167                           const QString &caption = QString::null,
00168                           const KGuiItem &buttonYes = KStdGuiItem::yes(),
00169                           const KGuiItem &buttonNo  = KStdGuiItem::no(),
00170                           const QString &dontAskAgainName = QString::null,
00171                           int options = Notify);
00172 
00178   static int questionYesNoCancelWId(WId parent_id,
00179                           const QString &text,
00180                           const QString &caption = QString::null,
00181                           const KGuiItem &buttonYes = KStdGuiItem::yes(),
00182                           const KGuiItem &buttonNo  = KStdGuiItem::no(),
00183                           const QString &dontAskAgainName = QString::null,
00184                           int options = Notify);
00185 
00220  static int questionYesNoList(QWidget *parent,
00221                           const QString &text,
00222                           const QStringList &strlist,
00223                           const QString &caption = QString::null,
00224                           const KGuiItem &buttonYes = KStdGuiItem::yes(),
00225                           const KGuiItem &buttonNo = KStdGuiItem::no(),
00226                           const QString &dontAskAgainName = QString::null,
00227                           int options = Notify);
00228 
00234  static int questionYesNoListWId(WId parent_id,
00235                           const QString &text,
00236                           const QStringList &strlist,
00237                           const QString &caption = QString::null,
00238                           const KGuiItem &buttonYes = KStdGuiItem::yes(),
00239                           const KGuiItem &buttonNo = KStdGuiItem::no(),
00240                           const QString &dontAskAgainName = QString::null,
00241                           int options = Notify);
00242 
00273  static int warningYesNo(QWidget *parent,
00274                          const QString &text,
00275                          const QString &caption = QString::null,
00276                          const KGuiItem &buttonYes = KStdGuiItem::yes(),
00277                          const KGuiItem &buttonNo = KStdGuiItem::no(),
00278                          const QString &dontAskAgainName = QString::null,
00279                          int options = Notify | Dangerous);
00280 
00286  static int warningYesNoWId(WId parent_id,
00287                          const QString &text,
00288                          const QString &caption = QString::null,
00289                          const KGuiItem &buttonYes = KStdGuiItem::yes(),
00290                          const KGuiItem &buttonNo = KStdGuiItem::no(),
00291                          const QString &dontAskAgainName = QString::null,
00292                          int options = Notify | Dangerous);
00293 
00328  static int warningYesNoList(QWidget *parent,
00329                             const QString &text,
00330                             const QStringList &strlist,
00331                             const QString &caption = QString::null,
00332                             const KGuiItem &buttonYes = KStdGuiItem::yes(),
00333                             const KGuiItem &buttonNo = KStdGuiItem::no(),
00334                             const QString &dontAskAgainName = QString::null,
00335                             int options = Notify | Dangerous);
00336 
00342  static int warningYesNoListWId(WId parent_id,
00343                             const QString &text,
00344                             const QStringList &strlist,
00345                             const QString &caption = QString::null,
00346                             const KGuiItem &buttonYes = KStdGuiItem::yes(),
00347                             const KGuiItem &buttonNo = KStdGuiItem::no(),
00348                             const QString &dontAskAgainName = QString::null,
00349                             int options = Notify | Dangerous);
00350 
00380  static int warningContinueCancel(QWidget *parent,
00381                          const QString &text,
00382                          const QString &caption = QString::null,
00383                          const KGuiItem &buttonContinue = KStdGuiItem::cont(),
00384                          const QString &dontAskAgainName = QString::null,
00385                          int options = Notify);
00386 
00392  static int warningContinueCancelWId(WId parent_id,
00393                          const QString &text,
00394                          const QString &caption = QString::null,
00395                          const KGuiItem &buttonContinue = KStdGuiItem::cont(),
00396                          const QString &dontAskAgainName = QString::null,
00397                          int options = Notify);
00398 
00432  static int warningContinueCancelList(QWidget *parent,
00433                          const QString &text,
00434                          const QStringList &strlist,
00435                          const QString &caption = QString::null,
00436                          const KGuiItem &buttonContinue = KStdGuiItem::cont(),
00437                          const QString &dontAskAgainName = QString::null,
00438                          int options = Notify);
00439 
00445  static int warningContinueCancelListWId(WId parent_id,
00446                          const QString &text,
00447                          const QStringList &strlist,
00448                          const QString &caption = QString::null,
00449                          const KGuiItem &buttonContinue = KStdGuiItem::cont(),
00450                          const QString &dontAskAgainName = QString::null,
00451                          int options = Notify);
00452 
00489   static int warningYesNoCancel(QWidget *parent,
00490                                 const QString &text,
00491                                 const QString &caption = QString::null,
00492                                 const KGuiItem &buttonYes = KStdGuiItem::yes(),
00493                                 const KGuiItem &buttonNo = KStdGuiItem::no(),
00494                                 const QString &dontAskAgainName = QString::null,
00495                                 int options = Notify);
00496 
00502   static int warningYesNoCancelWId(WId parent_id,
00503                                 const QString &text,
00504                                 const QString &caption = QString::null,
00505                                 const KGuiItem &buttonYes = KStdGuiItem::yes(),
00506                                 const KGuiItem &buttonNo = KStdGuiItem::no(),
00507                                 const QString &dontAskAgainName = QString::null,
00508                                 int options = Notify);
00509 
00551   static int warningYesNoCancelList(QWidget *parent,
00552                                 const QString &text,
00553                                 const QStringList &strlist,
00554                                 const QString &caption = QString::null,
00555                                 const KGuiItem &buttonYes = KStdGuiItem::yes(),
00556                                 const KGuiItem &buttonNo = KStdGuiItem::no(),
00557                                 const QString &dontAskAgainName = QString::null,
00558                                 int options = Notify);
00559 
00565   static int warningYesNoCancelListWId(WId parent_id,
00566                                 const QString &text,
00567                                 const QStringList &strlist,
00568                                 const QString &caption = QString::null,
00569                                 const KGuiItem &buttonYes = KStdGuiItem::yes(),
00570                                 const KGuiItem &buttonNo = KStdGuiItem::no(),
00571                                 const QString &dontAskAgainName = QString::null,
00572                                 int options = Notify);
00573 
00597   static void error(QWidget *parent,
00598                     const QString &text,
00599                     const QString &caption = QString::null,
00600                     int options = Notify);
00601 
00607   static void errorWId(WId parent_id,
00608                     const QString &text,
00609                     const QString &caption = QString::null,
00610                     int options = Notify);
00611 
00638   static void detailedError(QWidget *parent,
00639                     const QString &text,
00640                     const QString &details,
00641                     const QString &caption = QString::null,
00642                     int options = Notify);
00643 
00649   static void detailedErrorWId(WId parent_id,
00650                     const QString &text,
00651                     const QString &details,
00652                     const QString &caption = QString::null,
00653                     int options = Notify);
00654 
00665   static void queuedDetailedError( QWidget *parent,
00666                     const QString &text,
00667                     const QString &details,
00668                     const QString &caption = QString::null);
00669 
00675   static void queuedDetailedErrorWId( WId parent_id,
00676                     const QString &text,
00677                     const QString &details,
00678                     const QString &caption = QString::null);
00679 
00702   static void sorry(QWidget *parent,
00703                     const QString &text,
00704                     const QString &caption = QString::null,
00705                     int options = Notify);
00706 
00712   static void sorryWId(WId parent_id,
00713                     const QString &text,
00714                     const QString &caption = QString::null,
00715                     int options = Notify);
00716 
00745   static void detailedSorry(QWidget *parent,
00746                     const QString &text,
00747                     const QString &details,
00748                     const QString &caption = QString::null,
00749                     int options = Notify);
00750 
00756   static void detailedSorryWId(WId parent_id,
00757                     const QString &text,
00758                     const QString &details,
00759                     const QString &caption = QString::null,
00760                     int options = Notify);
00761 
00788   static void information(QWidget *parent,
00789                           const QString &text,
00790                           const QString &caption = QString::null,
00791                           const QString &dontShowAgainName = QString::null,
00792                           int options = Notify);
00793 
00799   static void informationWId(WId parent_id,
00800                           const QString &text,
00801                           const QString &caption = QString::null,
00802                           const QString &dontShowAgainName = QString::null,
00803                           int options = Notify);
00804 
00835   static void informationList(QWidget *parent,
00836                   const QString &text,
00837                   const QStringList & strlist,
00838                   const QString &caption = QString::null,
00839                   const QString &dontShowAgainName = QString::null,
00840                   int options = Notify);
00841 
00847   static void informationListWId(WId parent_id,
00848                   const QString &text,
00849                   const QStringList & strlist,
00850                   const QString &caption = QString::null,
00851                   const QString &dontShowAgainName = QString::null,
00852                   int options = Notify);
00853 
00858   static void enableAllMessages();
00859 
00867   static void enableMessage(const QString &dontShowAgainName);
00868 
00888   static void about(QWidget *parent,
00889             const QString& text,
00890             const QString& caption = QString::null,
00891                     int options = Notify);
00892 
00917     static int messageBox( QWidget *parent, DialogType type, const QString &text,
00918                     const QString &caption,
00919                     const KGuiItem &buttonYes,
00920                     const KGuiItem &buttonNo,
00921                     const QString &dontShowAskAgainName,
00922                     int options = Notify);
00923 
00942     // KDE4 - merge with above?
00943     static int messageBox( QWidget *parent, DialogType type, const QString &text,
00944                     const QString &caption = QString::null,
00945                     const KGuiItem &buttonYes = KStdGuiItem::yes(),
00946                     const KGuiItem &buttonNo = KStdGuiItem::no(),
00947                     int options = Notify);
00948 
00954     static int messageBoxWId( WId parent_id, DialogType type, const QString &text,
00955                     const QString &caption = QString::null,
00956                     const KGuiItem &buttonYes = KStdGuiItem::yes(),
00957                     const KGuiItem &buttonNo = KStdGuiItem::no(),
00958                     const QString &dontShowAskAgainName = QString::null,
00959                     int options = Notify);
00960 
00973     static void queuedMessageBox( QWidget *parent,
00974                     DialogType type, const QString &text,
00975                     const QString &caption,
00976                     int options );
00977 
00983     static void queuedMessageBoxWId( WId parent_id,
00984                     DialogType type, const QString &text,
00985                     const QString &caption,
00986                     int options );
00987 
00994     static void queuedMessageBox( QWidget *parent,
00995                     DialogType type, const QString &text,
00996                     const QString &caption = QString::null );
00997 
01003     static void queuedMessageBoxWId( WId parent_id,
01004                     DialogType type, const QString &text,
01005                     const QString &caption = QString::null );
01006 
01016     static bool shouldBeShownYesNo(const QString &dontShowAgainName,
01017                                    ButtonCode &result);
01025     static bool shouldBeShownContinue(const QString &dontShowAgainName);
01026 
01035     static void saveDontShowAgainYesNo(const QString &dontShowAgainName,
01036                                        ButtonCode result);
01037 
01045     static void saveDontShowAgainContinue(const QString &dontShowAgainName);
01046 
01052     static void setDontShowAskAgainConfig(KConfig* cfg);
01053 
01069     static int createKMessageBox(KDialogBase *dialog, QMessageBox::Icon icon,
01070                              const QString &text, const QStringList &strlist,
01071                              const QString &ask, bool *checkboxReturn,
01072                              int options, const QString &details=QString::null);
01073 
01092     static int createKMessageBox(KDialogBase *dialog, QPixmap icon,
01093                              const QString &text, const QStringList &strlist,
01094                              const QString &ask, bool *checkboxReturn,
01095                              int options, const QString &details=QString::null,
01096                              QMessageBox::Icon notifyType=QMessageBox::Information);
01097 
01098 private:
01099     static KConfig* againConfig;
01100 };
01101 
01102 #endif
KDE Logo
This file is part of the documentation for kdeui Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Sep 23 17:11:54 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003