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

presence.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_presence_h_HEADER_GUARD_
00023 #define _TelepathyQt4_presence_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/Types>
00031 
00032 namespace Tp
00033 {
00034 
00035 class TELEPATHY_QT4_EXPORT Presence
00036 {
00037 public:
00038     Presence();
00039     Presence(const SimplePresence &sp);
00040     Presence(ConnectionPresenceType type, const QString &status, const QString &statusMessage);
00041     Presence(const Presence &other);
00042     ~Presence();
00043 
00044     static Presence available(const QString &statusMessage = QString());
00045     static Presence away(const QString &statusMessage = QString());
00046     static Presence brb(const QString &statusMessage = QString());
00047     static Presence busy(const QString &statusMessage = QString());
00048     static Presence xa(const QString &statusMessage = QString());
00049     static Presence hidden(const QString &statusMessage = QString());
00050     static Presence offline(const QString &statusMessage = QString());
00051 
00052     bool isValid() const { return mPriv.constData() != 0; }
00053 
00054     Presence &operator=(const Presence &other);
00055 
00056     ConnectionPresenceType type() const;
00057     QString status() const;
00058     QString statusMessage() const;
00059     void setStatus(const SimplePresence &value);
00060     void setStatus(ConnectionPresenceType type, const QString &status,
00061             const QString &statusMessage);
00062 
00063     SimplePresence barePresence() const;
00064 
00065 private:
00066     struct Private;
00067     friend struct Private;
00068     QSharedDataPointer<Private> mPriv;
00069 };
00070 
00071 class TELEPATHY_QT4_EXPORT PresenceSpec
00072 {
00073 public:
00074     PresenceSpec();
00075     PresenceSpec(const QString &status, const SimpleStatusSpec &spec);
00076     PresenceSpec(const PresenceSpec &other);
00077     ~PresenceSpec();
00078 
00079     bool isValid() const { return mPriv.constData() != 0; }
00080 
00081     PresenceSpec &operator=(const PresenceSpec &other);
00082 
00083     Presence presence(const QString &statusMessage = QString()) const;
00084     bool maySetOnSelf() const;
00085     bool canHaveStatusMessage() const;
00086 
00087     SimpleStatusSpec bareSpec() const;
00088 
00089 private:
00090     struct Private;
00091     friend struct Private;
00092     QSharedDataPointer<Private> mPriv;
00093 };
00094 
00095 class TELEPATHY_QT4_EXPORT PresenceSpecList : public QList<PresenceSpec>
00096 {
00097 public:
00098     PresenceSpecList() { }
00099     PresenceSpecList(const SimpleStatusSpecMap &specMap)
00100     {
00101         SimpleStatusSpecMap::const_iterator i = specMap.constBegin();
00102         SimpleStatusSpecMap::const_iterator end = specMap.end();
00103         for (; i != end; ++i) {
00104             QString status = i.key();
00105             SimpleStatusSpec spec = i.value();
00106             append(PresenceSpec(status, spec));
00107         }
00108     }
00109     PresenceSpecList(const QList<PresenceSpec> &other)
00110         : QList<PresenceSpec>(other)
00111     {
00112     }
00113 
00114     QMap<QString, PresenceSpec> toMap() const
00115     {
00116         QMap<QString, PresenceSpec> ret;
00117         Q_FOREACH (const PresenceSpec &spec, *this) {
00118             ret.insert(spec.presence().status(), spec);
00119         }
00120         return ret;
00121     }
00122 };
00123 
00124 } // Tp
00125 
00126 Q_DECLARE_METATYPE(Tp::Presence);
00127 Q_DECLARE_METATYPE(Tp::PresenceSpec);
00128 
00129 #endif


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