kopete/libkopete/kopetestatusitems.h

   1 /*
   2     kopetestatusitems.h - Kopete Status Items
   3
   4     Copyright (c) 2008      by Roman Jarosz          <kedgedev@centrum.cz>
   5     Kopete    (c) 2008      by the Kopete developers <kopete-devel@kde.org>
   6
   7     *************************************************************************
   8     *                                                                       *
   9     * This library is free software; you can redistribute it and/or         *
  10     * modify it under the terms of the GNU Lesser General Public            *
  11     * License as published by the Free Software Foundation; either          *
  12     * version 2 of the License, or (at your option) any later version.      *
  13     *                                                                       *
  14     *************************************************************************
  15 */
  16 #ifndef KOPETESTATUSITEMS_H
  17 #define KOPETESTATUSITEMS_H
  18
  19 #include <QtCore/QObject>
  20 #include <QtCore/QList>
  21 #include <QtCore/QString>
  22
  23 #include "kopete_export.h"
  24 #include "kopeteonlinestatusmanager.h"
  25
  26 namespace Kopete {
  27
  28 namespace Status {
  29
  30 class StatusGroup;
  31
  32 /**
  33  * StatusItem is a base class for all status items. The items store
  34  * values that are needed to build status menu.
  35  *
  36  * The items are stored in StatusManager.
  37  *
  38  * IdentityManager is a singleton, you may uses it with @ref IdentityManager::self()
  39  *
  40  *@author Roman Jarosz <kedgedev@centrum.cz>
  41  */
  42 class KOPETE_EXPORT StatusItem : public QObject
  43 {
  44         Q_OBJECT
  45 public:
  46         /**
  47          * StatusItem constructor
  48          **/
  49         StatusItem();
  50         StatusItem( const QString& uid );
  51
  52         /**
  53          * Sets category
  54          **/
  55         void setCategory( OnlineStatusManager::Categories category );
  56
  57         /**
  58          * Returns category
  59          **/
  60         OnlineStatusManager::Categories category() const { return mCategory; }
  61
  62         /**
  63          * Sets title
  64          **/
  65         void setTitle( const QString& title );
  66
  67         /**
  68          * Returns title
  69          **/
  70         QString title() const { return mTitle; }
  71
  72         /**
  73          * Returns unique identifier
  74          **/
  75         QString uid() const { return mUid; }
  76
  77         /**
  78          * Returns true if StatusItem is group
  79          **/
  80         virtual bool isGroup() const = 0;
  81
  82         /**
  83          * Returns number of childes
  84          **/
  85         virtual int childCount() const = 0;
  86
  87         /**
  88          * Returns a StatusItem at given @p index or 0 if there is no item at given @p index
  89          **/
  90         virtual StatusItem *child( int /*index*/ ) const = 0;
  91
  92         /**
  93          * Returns index of this Item in parent group
  94          **/
  95         int index() const;
  96
  97         /**
  98          * Returns StatusGroup this Item belongs to
  99          **/
 100         StatusGroup *parentGroup() const;
 101
 102         /**
 103          * Creates a copy of StatusItem
 104          *
 105          * @note this copies also uid so it should only be used when we know
 106          * that the original or copy object will be destroyed
 107          **/
 108         virtual StatusItem* copy() const = 0;
 109
 110 Q_SIGNALS:
 111         /**
 112          * This signal is emitted whenever the item's content changes
 113          **/
 114         void changed();
 115
 116 private:
 117         OnlineStatusManager::Categories mCategory;
 118         QString mTitle;
 119         QString mUid;
 120
 121         StatusGroup *mParentItem;
 122         Q_DISABLE_COPY(StatusItem)
 123 };
 124
 125 /**
 126  * StatusGroup represents a group that can contain other StatusItems
 127  *
 128  *@author Roman Jarosz <kedgedev@centrum.cz>
 129  */
 130 class KOPETE_EXPORT StatusGroup : public StatusItem
 131 {
 132         Q_OBJECT
 133 public:
 134         /**
 135          * StatusGroup constructor
 136          **/
 137         StatusGroup();
 138         StatusGroup( const QString& uid );
 139
 140         /**
 141          * Returns true if StatusItem is group
 142          * @note for StatusGroup it always returns true;
 143          **/
 144         virtual bool isGroup() const { return true; }
 145
 146         /**
 147          * Returns number of childes
 148          **/
 149         virtual int childCount() const { return mChildItems.count(); }
 150
 151         /**
 152          * Returns a StatusItem at given @p index or 0 if there is no item at given @p index
 153          **/
 154         virtual StatusItem *child( int index ) const { return mChildItems.value( index, 0 ); }
 155
 156         /**
 157          * Returns list of all childes
 158          **/
 159         QList<StatusItem*> childList() const { return mChildItems; }
 160
 161         /**
 162          * Returns index for given StatusItem
 163          **/
 164         int indexOf( StatusItem *child ) const { return mChildItems.indexOf( child ); }
 165
 166         /**
 167          * Inserts @p child at given @p index
 168          **/
 169         void insertChild( int index, StatusItem *child );
 170
 171         /**
 172          * Inserts @p child at the end
 173          **/
 174         void appendChild( Kopete::Status::StatusItem *child );
 175
 176         /**
 177          * Removes @p child
 178          **/
 179         void removeChild( Kopete::Status::StatusItem *child );
 180
 181         /**
 182          * Creates a copy of this object
 183          *
 184          * @note this copies also uid so it should only be used when we know
 185          * that the original or copy object will be destroyed
 186          **/
 187         virtual StatusItem* copy() const;
 188 Q_SIGNALS:
 189         /**
 190          * This signal is emitted after new child was inserted is inserted at position @p index
 191          **/
 192         void childInserted( int index, Kopete::Status::StatusItem *child );
 193
 194         /**
 195          * This signal is emitted after child was removed
 196          **/
 197         void childRemoved( Kopete::Status::StatusItem *child );
 198
 199 private Q_SLOTS:
 200         void childDestroyed( QObject *object );
 201
 202 private:
 203         QList<StatusItem*> mChildItems;
 204 };
 205
 206 /**
 207  * Status represents a status which has title, message and category.
 208  * Values from this class are used to create status action with which user can change status.
 209  *
 210  *@author Roman Jarosz <kedgedev@centrum.cz>
 211  */
 212 class KOPETE_EXPORT Status : public StatusItem
 213 {
 214         Q_OBJECT
 215 public:
 216         /**
 217          * Status constructor
 218          **/
 219         Status();
 220         Status( const QString& uid );
 221
 222         /**
 223          * Returns true if the item is group
 224          * @note for Status it always returns false;
 225          **/
 226         virtual bool isGroup() const { return false; }
 227
 228         /**
 229          * Returns number of childes
 230          * @note for Status it always returns 0;
 231          **/
 232         virtual int childCount() const { return 0; }
 233
 234         /**
 235          * Returns the item at given @p index or 0 if there is no item at given @p index
 236          * @note for Status it always returns 0;
 237          **/
 238         virtual StatusItem *child( int ) const { return 0; }
 239
 240         /**
 241          * Set message
 242          **/
 243         void setMessage( const QString& message );
 244
 245         /**
 246          * Returns message
 247          **/
 248         QString message() const { return mMessage; }
 249
 250         /**
 251          * Creates a copy of this object
 252          *
 253          * @note this copies also uid so it should only be used when we know
 254          * that the original or copy object will be destroyed
 255          **/
 256         virtual StatusItem* copy() const;
 257
 258 private:
 259         QString mMessage;
 260 };
 261
 262 }
 263
 264 }
 265
 266 #endif