diff options
| author | Jeremy Lainé <jeremy.laine@m4x.org> | 2012-02-08 12:51:15 +0000 |
|---|---|---|
| committer | Jeremy Lainé <jeremy.laine@m4x.org> | 2012-02-08 12:51:15 +0000 |
| commit | deb9d6cb53057ca8b90d10d6a3bdc5dcfd1b3ee4 (patch) | |
| tree | d956bad28e28aadc3c83dbf88b3eddb5e1d9a9f4 /src/base/QXmppMucIq.h | |
| parent | e8a1ad0cc608f12874ba4bafbd8282fa537ec9fb (diff) | |
| download | qxmpp-deb9d6cb53057ca8b90d10d6a3bdc5dcfd1b3ee4.tar.gz | |
move files common to client/server into "base"
Diffstat (limited to 'src/base/QXmppMucIq.h')
| -rw-r--r-- | src/base/QXmppMucIq.h | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/src/base/QXmppMucIq.h b/src/base/QXmppMucIq.h new file mode 100644 index 00000000..5e73fc9b --- /dev/null +++ b/src/base/QXmppMucIq.h @@ -0,0 +1,152 @@ +/* + * Copyright (C) 2008-2011 The QXmpp developers + * + * Author: + * Jeremy Lainé + * + * Source: + * http://code.google.com/p/qxmpp + * + * This file is a part of QXmpp library. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + */ + +#ifndef QXMPPMUCIQ_H +#define QXMPPMUCIQ_H + +#include "QXmppDataForm.h" +#include "QXmppIq.h" + +/// \brief The QXmppMucItem class represents a chat room "item". +/// +/// It is used to convey information such as permissions. +/// +/// \ingroup Stanzas + +class QXmppMucItem +{ +public: + /// This enum is used to represent long-lived permissions in a room (affiliations). + enum Affiliation { + UnspecifiedAffiliation, + OutcastAffiliation, + NoAffiliation, + MemberAffiliation, + AdminAffiliation, + OwnerAffiliation, + }; + + /// This enum is used to represent short-lived permissions in a room (roles). + enum Role { + UnspecifiedRole, + NoRole, + VisitorRole, + ParticipantRole, + ModeratorRole, + }; + + QXmppMucItem(); + bool isNull() const; + + QString actor() const; + void setActor(const QString &actor); + + Affiliation affiliation() const; + void setAffiliation(Affiliation affiliation); + + QString jid() const; + void setJid(const QString &jid); + + QString nick() const; + void setNick(const QString &nick); + + QString reason() const; + void setReason(const QString &reason); + + Role role() const; + void setRole(Role role); + + void parse(const QDomElement &element); + void toXml(QXmlStreamWriter *writer) const; + + /// \cond + static Affiliation affiliationFromString(const QString &affiliationStr); + static QString affiliationToString(Affiliation affiliation); + static Role roleFromString(const QString &roleStr); + static QString roleToString(Role role); + /// \endcond +private: + QString m_actor; + Affiliation m_affiliation; + QString m_jid; + QString m_nick; + QString m_reason; + Role m_role; +}; + +/// \brief The QXmppMucAdminIq class represents a chat room administration IQ +/// as defined by XEP-0045: Multi-User Chat. +/// +/// It is used to get or modify room memberships. +/// +/// \ingroup Stanzas + +class QXmppMucAdminIq : public QXmppIq +{ +public: + QList<QXmppMucItem> items() const; + void setItems(const QList<QXmppMucItem> &items); + + /// \cond + static bool isMucAdminIq(const QDomElement &element); + /// \endcond + +protected: + /// \cond + void parseElementFromChild(const QDomElement &element); + void toXmlElementFromChild(QXmlStreamWriter *writer) const; + /// \endcond + +private: + QList<QXmppMucItem> m_items; +}; + +/// \brief The QXmppMucOwnerIq class represents a chat room configuration IQ as +/// defined by XEP-0045: Multi-User Chat. +/// +/// It is used to get or modify room configuration options. +/// +/// \sa QXmppDataForm +/// + +class QXmppMucOwnerIq : public QXmppIq +{ +public: + QXmppDataForm form() const; + void setForm(const QXmppDataForm &form); + + /// \cond + static bool isMucOwnerIq(const QDomElement &element); + /// \endcond + +protected: + /// \cond + void parseElementFromChild(const QDomElement &element); + void toXmlElementFromChild(QXmlStreamWriter *writer) const; + /// \endcond + +private: + QXmppDataForm m_form; +}; + +#endif |
