File indexing completed on 2023-12-03 05:01:58

 /*
  * Global Presence - wrap Tp::Presence with KDE functionality
  *
  * Copyright (C) 2011 David Edmundson <kde@davidedmundson.co.uk>
  * Copyright (C) 2012 Daniele E. Domenichelli <daniele.domenichelli@gmail.com>
  *
  * 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.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #ifndef PRESENCE_H
 #define PRESENCE_H
 
 #include <TelepathyQt/Presence>
 
 #include <KTp/ktpcommoninternals_export.h>
 
 namespace KTp
 {
 
 class KTPCOMMONINTERNALS_EXPORT Presence : public Tp::Presence
 {
 public:
     Presence();
     Presence(const Tp::Presence &presence);
 
     /**
      * \brief Get the icon for the presence.
      *
      * \param useImIcons Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").
      * \return The icon for the current presence.
      */
     QIcon icon(bool useImIcons = false) const;
 
     /**
      * \brief Get the icon for the presence with the specified overlays.
      *
      * \param overlays The overlays to apply at the icon.
      * \param useImIcons Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").
      * \return The icon for the current presence.
      */
     QIcon icon(QStringList overlays, bool useImIcons = false) const;
 
     /**
      * \brief Get the name of the icon for the presence.
      *
      * This is useful for example if you want to create an icon using the presence as overlay.
      * \param useImIcons Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").
      * \return The name of the icon for the current presence.
      */
     QString iconName(bool useImIcons = false) const;
 
     /**
      * \brief Get a i18n string representing the presence.
      *
      * \return An i18n string representing the presence.
      */
     QString displayString() const;
 
     /**
      * \brief Returns if the presences are equivalent
      */
     bool operator ==(const Presence &other) const;
 
     /**
      * \brief Returns if the presences are not equivalent
      */
     bool operator !=(const Presence &other) const;
 
     /**
      * \brief Returns which presence is "less available"
      */
     bool operator <(const Presence &other) const;
 
     /**
      * \brief Returns which presence is "more available"
      */
     bool operator >(const Presence &other) const;
 
     /**
      * \brief Returns an int representation of the presence type sorted by priority.
      *
      * 0 - most online, 7 - offline
      */
     static int sortPriority(const Tp::ConnectionPresenceType &type);
 };
 
 }
 
 Q_DECLARE_METATYPE(KTp::Presence);
 
 #endif // PRESENCE_H