Home · All Classes · All Namespaces · Modules · Functions · Files

protocol-info.h

00001 /*
00002  * This file is part of TelepathyQt4
00003  *
00004  * Copyright (C) 2010 Collabora Ltd. <http://www.collabora.co.uk/>
00005  * Copyright (C) 2010 Nokia Corporation
00006  *
00007  * This library is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Lesser General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2.1 of the License, or (at your option) any later version.
00011  *
00012  * This library is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Lesser General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Lesser General Public
00018  * License along with this library; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020  */
00021 
00022 #ifndef _TelepathyQt4_protocol_info_h_HEADER_GUARD_
00023 #define _TelepathyQt4_protocol_info_h_HEADER_GUARD_
00024 
00025 #ifndef IN_TELEPATHY_QT4_HEADER
00026 #error IN_TELEPATHY_QT4_HEADER
00027 #endif
00028 
00029 #include <TelepathyQt4/AvatarSpec>
00030 #include <TelepathyQt4/Global>
00031 #include <TelepathyQt4/PresenceSpec>
00032 #include <TelepathyQt4/ProtocolParameter>
00033 #include <TelepathyQt4/Types>
00034 
00035 #include <QSharedDataPointer>
00036 #include <QString>
00037 #include <QList>
00038 
00039 namespace Tp
00040 {
00041 
00042 class ConnectionCapabilities;
00043 
00044 class TELEPATHY_QT4_EXPORT ProtocolInfo
00045 {
00046 public:
00047     ProtocolInfo();
00048     ProtocolInfo(const ProtocolInfo &other);
00049     ~ProtocolInfo();
00050 
00051     bool isValid() const { return mPriv.constData() != 0; }
00052 
00053     ProtocolInfo &operator=(const ProtocolInfo &other);
00054 
00055     QString cmName() const;
00056 
00057     QString name() const;
00058 
00059     ProtocolParameterList parameters() const;
00060     bool hasParameter(const QString &name) const;
00061 
00062     bool canRegister() const;
00063 
00064     ConnectionCapabilities capabilities() const;
00065 
00066     QString vcardField() const;
00067 
00068     QString englishName() const;
00069 
00070     QString iconName() const;
00071 
00072     PresenceSpecList allowedPresenceStatuses() const;
00073 
00074     AvatarSpec avatarRequirements() const;
00075 
00076 private:
00077     friend class ConnectionManager;
00078 
00079     ProtocolInfo(const QString &cmName, const QString &name);
00080 
00081     void addParameter(const ParamSpec &spec);
00082     void setVCardField(const QString &vcardField);
00083     void setEnglishName(const QString &englishName);
00084     void setIconName(const QString &iconName);
00085     void setRequestableChannelClasses(const RequestableChannelClassList &caps);
00086     void setAllowedPresenceStatuses(const PresenceSpecList &statuses);
00087     void setAvatarRequirements(const AvatarSpec &avatarRequirements);
00088 
00089     struct Private;
00090     friend struct Private;
00091     QSharedDataPointer<Private> mPriv;
00092 };
00093 
00094 typedef QList<ProtocolInfo> ProtocolInfoList;
00095 
00096 } // Tp
00097 
00098 Q_DECLARE_METATYPE(Tp::ProtocolInfo);
00099 Q_DECLARE_METATYPE(Tp::ProtocolInfoList);
00100 
00101 #endif


Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.5.8