File indexing completed on 2023-10-01 08:41:44

0001 /*
0002     Telepathy error dictionary - usable strings for dbus messages
0003     Copyright (C) 2011  Martin Klapetek <martin.klapetek@gmail.com>
0004 
0005     This library is free software; you can redistribute it and/or
0006     modify it under the terms of the GNU Lesser General Public
0007     License as published by the Free Software Foundation; either
0008     version 2.1 of the License, or (at your option) any later version.
0009 
0010     This library is distributed in the hope that it will be useful,
0011     but WITHOUT ANY WARRANTY; without even the implied warranty of
0012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0013     Lesser General Public License for more details.
0014 
0015     You should have received a copy of the GNU Lesser General Public
0016     License along with this library; if not, write to the Free Software
0017     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0018 */
0019 
0020 
0021 #ifndef ERROR_DICTIONARY_H
0022 #define ERROR_DICTIONARY_H
0023 
0024 #include <QString>
0025 
0026 #include <KTp/ktpcommoninternals_export.h>
0027 
0028 namespace KTp
0029 {
0030 /**
0031  * @short A method of turning error codes into human readable strings
0032  *
0033  */
0034 namespace ErrorDictionary
0035 {
0036     /**Returns a verbose error message suitable for displaying to the user
0037         @param dbusErrorName The Telepathy error as specified in http://telepathy.freedesktop.org/spec/errors.html
0038      */
0039     KTPCOMMONINTERNALS_EXPORT QString displayVerboseErrorMessage(const QString &dbusErrorName);
0040 
0041     /**Returns a short error message suitable when there is little space
0042         @param dbusErrorName The Telepathy error as specified in http://telepathy.freedesktop.org/spec/errors.html
0043      */
0044     KTPCOMMONINTERNALS_EXPORT QString displayShortErrorMessage(const QString &dbusErrorName);
0045 }
0046 }
0047 
0048 #endif // ERROR_DICTIONARY_H