kopete/libkopete/kopetestatusmanager.h

   1 /*
   2     kopetestatusmanager.h - Kopete Status Manager
   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 KOPETESTATUSMANAGER_H
  17 #define KOPETESTATUSMANAGER_H
  18
  19 #include <QtCore/QObject>
  20
  21 #include "kopete_export.h"
  22 #include "kopetestatusmessage.h"
  23
  24 class QDomElement;
  25
  26 namespace Kopete {
  27
  28 class Account;
  29
  30 namespace Status {
  31         class StatusGroup;
  32         class StatusItem;
  33 }
  34
  35 /**
  36  * StatusManager manages status items that are used to build status menu.
  37  * It also stores current status message and sets auto away status.
  38  *
  39  * StatusManager is a singleton, you may uses it with @ref StatusManager::self()
  40  *
  41  * @author Roman Jarosz <kedgedev@centrum.cz>
  42  */
  43 class KOPETE_EXPORT StatusManager : public QObject
  44 {
  45         Q_OBJECT
  46 public:
  47         /**
  48          * Get the only instance of StatusManager
  49          * @return StatusManager single instance
  50          */
  51         static StatusManager *self();
  52
  53         ~StatusManager();
  54
  55         /**
  56          * Save status data tree into XML file
  57          */
  58         void saveXML();
  59
  60         /**
  61          * Load status data tree into XML file
  62          */
  63         void loadXML();
  64
  65         /**
  66          * Set new status data tree
  67          */
  68         void setRootGroup( Status::StatusGroup * rootGroup );
  69
  70         /**
  71          * Get current status data tree
  72          */
  73         Status::StatusGroup *getRootGroup() const;
  74
  75         /**
  76          * Copy current status data tree
  77          */
  78         Status::StatusGroup *copyRootGroup() const;
  79
  80         /**
  81          * Find status item for given uid
  82          */
  83         const Status::StatusItem *itemForUid( const QString &uid ) const;
  84
  85         /**
  86          * Convert status item to XML structure
  87          *
  88          * @note it's public because it's also used for drag&drop
  89          */
  90         static QDomElement storeStatusItem( const Status::StatusItem *item );
  91
  92         /**
  93          * Restore status item from XML structure
  94          *
  95          * @note it's public because it's also used for drag&drop
  96          */
  97         static Status::StatusItem *parseStatusItem( QDomElement element );
  98
  99         /**
 100          * Remember current global status
 101          */
 102         void setGlobalStatus( uint category, const Kopete::StatusMessage &statusMessage = Kopete::StatusMessage() );
 103
 104         /**
 105          * Remember current global status message
 106          */
 107         void setGlobalStatusMessage( const Kopete::StatusMessage &statusMessage = Kopete::StatusMessage() );
 108
 109         /**
 110          * Get current global status message
 111          */
 112         Kopete::StatusMessage globalStatusMessage() const;
 113
 114         /**
 115          * Returns true if auto away status was set
 116          */
 117         bool autoAway();
 118
 119         /**
 120          * Returns true if global away status was set
 121          */
 122         bool globalAway();
 123
 124 public Q_SLOTS:
 125         /**
 126          * Undo auto away
 127          */
 128         void setActive();
 129
 130         /**
 131          * Set all online account to auto away status
 132          */
 133         void setAutoAway();
 134
 135 Q_SIGNALS:
 136         /**
 137          * This signal is emitted when root item of status data tree has changed.
 138          */
 139         void changed();
 140
 141         /**
 142          * This signal is emitted when global status has changed.
 143          */
 144         void globalStatusChanged();
 145
 146 private Q_SLOTS:
 147         void accountUnregistered( const Kopete::Account *account );
 148         void loadSettings();
 149         void loadBehaviorSettings();
 150
 151 private:
 152         StatusManager();
 153         void updateUidHash( Status::StatusItem *item );
 154
 155         Status::StatusGroup *defaultStatuses() const;
 156
 157         static StatusManager *instance;
 158
 159         class Private;
 160         Private * const d;
 161 };
 162
 163 }
 164
 165 #endif