aboutsummaryrefslogtreecommitdiff
path: root/src/QXmppPresence.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/QXmppPresence.cpp')
-rw-r--r--src/QXmppPresence.cpp26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/QXmppPresence.cpp b/src/QXmppPresence.cpp
index b5cbae9a..81a47d63 100644
--- a/src/QXmppPresence.cpp
+++ b/src/QXmppPresence.cpp
@@ -29,6 +29,11 @@
#include <QXmlStreamWriter>
#include "QXmppConstants.h"
+/// Constructs a QXmppPresence.
+///
+/// \param type
+/// \param status
+
QXmppPresence::QXmppPresence(QXmppPresence::Type type,
const QXmppPresence::Status& status)
: QXmppStanza(),
@@ -39,31 +44,52 @@ QXmppPresence::QXmppPresence(QXmppPresence::Type type,
}
+/// Destroys a QXmppPresence.
+
QXmppPresence::~QXmppPresence()
{
}
+/// Returns the presence type.
+///
+/// You can use this method to determine the action which needs to be
+/// taken in response to receiving the presence. For instance, if the type is
+/// QXmppPresence::Available or QXmppPresence::Unavailable, you could update
+/// the icon representing a contact's availability.
+
QXmppPresence::Type QXmppPresence::type() const
{
return m_type;
}
+/// Sets the presence type.
+///
+/// \param type
+
void QXmppPresence::setType(QXmppPresence::Type type)
{
m_type = type;
}
+/// Returns the presence status.
+
const QXmppPresence::Status& QXmppPresence::status() const
{
return m_status;
}
+/// Returns a reference to the presence status, allowing you to change it.
+
QXmppPresence::Status& QXmppPresence::status()
{
return m_status;
}
+/// Sets the presence status.
+///
+/// \param status
+
void QXmppPresence::setStatus(const QXmppPresence::Status& status)
{
m_status = status;