kopete/libkopete/kopeteutils.h

   1 /*
   2     Kopete Utils.
   3
   4     Copyright (c) 2005 Duncan Mac-Vicar Prett <duncan@kde.org>
   5
   6     Kopete    (c) 2002-2003 by the Kopete developers  <kopete-devel@kde.org>
   7
   8     *************************************************************************
   9     *                                                                       *
  10     * This library is free software; you can redistribute it and/or         *
  11     * modify it under the terms of the GNU Lesser General Public            *
  12     * License as published by the Free Software Foundation; either          *
  13     * version 2 of the License, or (at your option) any later version.      *
  14     *                                                                       *
  15     *************************************************************************
  16 */
  17
  18 #ifndef KOPETE_UTILS_H
  19 #define KOPETE_UTILS_H
  20
  21 #include "qobject.h"
  22 #include "qstring.h"
  23 #include "qpixmap.h"
  24 #include "kopete_export.h"
  25
  26
  27 namespace Kopete
  28 {
  29
  30 class Account;
  31
  32 namespace Utils
  33 {
  34
  35 /**
  36  * Notifies the user connection has been lost without coupling plugins with GUI code.
  37  *
  38  * @param account The account that lost the connection and wants to notify the user.
  39  * @param caption A brief subject line, used where possible if the presentation allows it.
  40  * @param message A short description of the error.
  41  * @param explanation A long description on how the error occurred and what the user can do about it.
  42  * @param debugInfo Debug info that can be sent to the developers or to the network service owners.
  43  *
  44  * You cannot provide debugInfo without an user explanation. If you don't provide a caption, message, or
  45  * explanation, Kopete will use a default explanation.
  46  */
  47 void KOPETE_EXPORT notifyConnectionLost( const Account *account,
  48                                          const QString caption = QString(),
  49                                          const QString message = QString(),
  50                                          const QString explanation = QString(),
  51                                          const QString debugInfo = QString() );
  52
  53
  54 /**
  55  * Notifies the user the server is not reachable without coupling plugins with GUI code.
  56  *
  57  * @param account The account that cannot establish a connection and want to notify the user about that.
  58  * @param explanation A long description on how the error occurred and what the user can do about it.
  59  * @param debugInfo Debug info that can be sent to the developers or to the network service owners.
  60  *
  61  * You cannot provide debugInfo without an user explanation. If you don't provide a caption, message, or
  62  * explanation, Kopete will use a default explanation.
  63  */
  64 void KOPETE_EXPORT notifyCannotConnect( const Account *account,
  65                                         const QString explanation = QString(),
  66                                         const QString debugInfo = QString());
  67
  68 } // end ns Utils
  69 } // end ns Kopete
  70
  71 #endif