kopete/libkopete/kopeteidentitymanager.h

   1 /*
   2     kopeteidentitymanager.h - Kopete Identity Manager
   3
   4     Copyright (c) 2007      by Gustavo Pichorim Boiko <gustavo.boiko@kdemail.net>
   5
   6     Kopete    (c) 2002-2007 by the Kopete developers <kopete-devel@kde.org>
   7
   8     *************************************************************************
   9     *                                                                       *
  10     * This library is free software; you can redistribute it and/or         *
  11     * modify it under the terms of the GNU Lesser General Public            *
  12     * License as published by the Free Software Foundation; either          *
  13     * version 2 of the License, or (at your option) any later version.      *
  14     *                                                                       *
  15     *************************************************************************
  16 */
  17
  18 #ifndef __kopeteidentitymanager_h__
  19 #define __kopeteidentitymanager_h__
  20
  21 #include <QtCore/QObject>
  22
  23 #include "kopete_export.h"
  24 #include "kopeteonlinestatus.h"
  25 #include "kopeteidentity.h"
  26 #include "kopetestatusmessage.h"
  27
  28 namespace Kopete
  29 {
  30
  31 /**
  32  * IdentityManager manages all defined identities in Kopete. You can
  33  * query them and globally set them all online or offline from here.
  34  *
  35  * IdentityManager is a singleton, you may uses it with @ref IdentityManager::self()
  36  *
  37  * @author Gustavo Pichorim Boiko <gustavo.boiko\@kdemail.net>
  38  */
  39 class KOPETE_EXPORT IdentityManager : public QObject
  40 {
  41         Q_OBJECT
  42
  43 public:
  44         /**
  45          * \brief Retrieve the instance of IdentityManager.
  46          *
  47          * The identity manager is a singleton class of which only a single
  48          * instance will exist. If no manager exists yet this function will
  49          * create one for you.
  50          *
  51          * \return the instance of the IdentityManager
  52          */
  53         static IdentityManager* self();
  54
  55         ~IdentityManager();
  56
  57         /**
  58          * \brief Retrieve the list of identities
  59          * \return a list of all the identities
  60          */
  61         const Identity::List & identities() const;
  62
  63         /**
  64          * \brief Return the identity asked
  65          * \param identityId is the ID for the identity
  66          * \return the Identity object found or NULL if no identity was found
  67          */
  68         Identity* findIdentity( const QString &identityId );
  69
  70
  71         /**
  72          * \brief Returs the default identity to be used
  73          *
  74          * This is the default identity configured in kopete. If no identity was created
  75          * yet, this function will create a new identity, set it as the default identity
  76          * and return it.
  77          * If there are identities already created, but none of them was set as the default,
  78          * it will return the first identity of the list.
  79          * @return the default identity
  80          */
  81         Identity* defaultIdentity();
  82
  83         /**
  84          * @brief Sets a new default identity
  85          *
  86          * By changing the default identity, you do NOT change the accounts' identity
  87          * association. They are kept as if nothing has changed
  88          */
  89         void setDefaultIdentity(Identity *ident);
  90
  91         /**
  92          * \brief Delete the identity and clean the config data
  93          *
  94          * This will mostly be called when no account is assigned to an identity
  95          */
  96         void removeIdentity( Identity *identity );
  97
  98         /**
  99          * @brief Register the identity.
 100          *
 101          * This adds the identity in the manager's identity list.
 102          * It will check no identities already exist with the same ID, if any, the identity is deleted. and not added
 103          *
 104          * @return @p identity, or 0L if the identity was deleted because id collision
 105          */
 106         Identity *registerIdentity( Identity *identity );
 107
 108 public slots:
 109
 110         /**
 111          * @brief Set all identities a status in the specified category
 112          *
 113          * @param category is one of the Kopete::OnlineStatusManager::Categories
 114          * @param statusMessage is the new status message
 115          * @param flags is a bitmask of SetOnlineStatusFlag
 116          */
 117         void setOnlineStatus( /*Kopete::OnlineStatusManager::Categories*/ uint category,
 118                               const Kopete::StatusMessage &statusMessage = Kopete::StatusMessage(), uint flags=0);
 119
 120         /**
 121          * \internal
 122          * Save the identity data to KConfig
 123          */
 124         void save();
 125
 126         /**
 127          * \internal
 128          * Load the identity data from KConfig
 129          */
 130         void load();
 131
 132 signals:
 133         /**
 134          * \brief Signals when an identity is ready for use
 135          */
 136         void identityRegistered( Kopete::Identity *identity );
 137
 138         /**
 139          * \brief Signals when an identity has been unregistered
 140          *
 141          * At this state, we are already in the Identity destructor.
 142          */
 143         void identityUnregistered( const Kopete::Identity *identity );
 144
 145         /**
 146          * \brief Signals when the default identity has changed
 147          */
 148         void defaultIdentityChanged( Kopete::Identity *identity );
 149
 150         void identityOnlineStatusChanged( Kopete::Identity *identity );
 151
 152 private:
 153         /**
 154          * Private constructor, because we're a singleton
 155          */
 156         IdentityManager();
 157
 158 private slots:
 159         void slotIdentityOnlineStatusChanged( Kopete::Identity *i );
 160
 161         /**
 162          * \internal
 163          * Unregister the identity.
 164          */
 165         void unregisterIdentity( const Kopete::Identity *identity );
 166
 167 private:
 168         static IdentityManager *s_self;
 169         class Private;
 170         Private *d;
 171 };
 172
 173 } //END namespace Kopete
 174
 175
 176 #endif
 177
 178