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

protocol-parameter.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_parameter_h_HEADER_GUARD_
00023 #define _TelepathyQt4_protocol_parameter_h_HEADER_GUARD_
00024 
00025 #ifndef IN_TELEPATHY_QT4_HEADER
00026 #error IN_TELEPATHY_QT4_HEADER
00027 #endif
00028 
00029 #include <TelepathyQt4/Constants>
00030 #include <TelepathyQt4/Global>
00031 
00032 #include <QDBusSignature>
00033 #include <QSharedDataPointer>
00034 #include <QString>
00035 #include <QVariant>
00036 
00037 namespace Tp
00038 {
00039 
00040 class TELEPATHY_QT4_EXPORT ProtocolParameter
00041 {
00042 public:
00043     ProtocolParameter();
00044     ProtocolParameter(const ProtocolParameter &other);
00045     ~ProtocolParameter();
00046 
00047     bool isValid() const { return mPriv.constData() != 0; }
00048 
00049     ProtocolParameter &operator=(const ProtocolParameter &other);
00050     bool operator==(const ProtocolParameter &other) const;
00051     bool operator==(const QString &name) const;
00052 
00053     QString name() const;
00054     QDBusSignature dbusSignature() const;
00055     QVariant::Type type() const;
00056     QVariant defaultValue() const;
00057 
00058     bool isRequired() const;
00059     bool isSecret() const;
00060     bool isRequiredForRegistration() const;
00061 
00062 private:
00063     friend class ConnectionManager;
00064     friend class ProtocolInfo;
00065 
00066     ProtocolParameter(const QString &name,
00067                       const QDBusSignature &dbusSignature,
00068                       QVariant defaultValue,
00069                       ConnMgrParamFlag flags);
00070 
00071     struct Private;
00072     friend struct Private;
00073     QSharedDataPointer<Private> mPriv;
00074 };
00075 
00076 typedef QList<ProtocolParameter> ProtocolParameterList;
00077 
00078 } // Tp
00079 
00080 Q_DECLARE_METATYPE(Tp::ProtocolParameter);
00081 Q_DECLARE_METATYPE(Tp::ProtocolParameterList);
00082 
00083 #endif


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