kopete/protocols/skype/skypeprotocol.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2005 Michal Vaner <michal.vaner@kdemail.net>
   3     Copyright (C) 2008-2009 Pali Rohár <pali.rohar@gmail.com>
   4
   5     This library is free software; you can redistribute it and/or
   6     modify it under the terms of the GNU Library General Public
   7     License version 2 as published by the Free Software Foundation.
   8
   9     This library is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     Library General Public License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to
  16     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17     Boston, MA 02111-1307, USA.
  18 */
  19 #ifndef SKYPEPROTOCOL_H
  20 #define SKYPEPROTOCOL_H
  21
  22 #include "kopeteprotocol.h"
  23 #include "kopeteproperty.h"
  24 #include <qstring.h>
  25
  26 class SkypeAccount;
  27 class SkypeProtocolPrivate;
  28
  29 namespace Kopete {
  30         class OnlineStatus;
  31 }
  32
  33 #define LAUNCH_ALLWAYS 0
  34 #define LAUNCH_NEEDED 1
  35 #define LAUNCH_NEVER 2
  36
  37 /**
  38  * @author Michal Vaner
  39  * @author Pali Rohár
  40  * @short Protocol to use external skype
  41  * This protocol is only binding for exteral skype program. The reason to write this was I did not like the skype as it was.
  42  */
  43 class SkypeProtocol : public Kopete::Protocol
  44 {
  45         Q_OBJECT
  46         private:
  47                 SkypeProtocolPrivate *d;
  48         public:
  49                 const Kopete::OnlineStatus Offline;
  50                 const Kopete::OnlineStatus Online;
  51                 const Kopete::OnlineStatus SkypeMe;
  52                 const Kopete::OnlineStatus Away;
  53                 const Kopete::OnlineStatus NotAvailable;
  54                 const Kopete::OnlineStatus DoNotDisturb;
  55                 const Kopete::OnlineStatus Invisible;
  56                 const Kopete::OnlineStatus Connecting;
  57                 const Kopete::OnlineStatus NotInList;
  58                 const Kopete::OnlineStatus NoAuth;
  59                 const Kopete::OnlineStatus Phone;
  60                 // contact properties
  61 /*              const Kopete::ContactPropertyTmpl propAwayMessage;
  62                 const Kopete::ContactPropertyTmpl propFirstName;
  63                 const Kopete::ContactPropertyTmpl propLastName;*/
  64                 const Kopete::PropertyTmpl propFullName;
  65 //              const Kopete::ContactPropertyTmpl propEmailAddress;
  66                 const Kopete::PropertyTmpl propPrivatePhone;
  67                 const Kopete::PropertyTmpl propPrivateMobilePhone;
  68                 const Kopete::PropertyTmpl propWorkPhone;
  69 //              const Kopete::ContactPropertyTmpl propWorkMobilePhone;
  70                 const Kopete::PropertyTmpl propLastSeen;
  71                 /**
  72                  * Constructor. This is called automatically on library load.
  73                  * @param parent Parent of the object.
  74                  * @param name Name of the object.
  75                  * @param args Arguments to allow creation by KGenericFactory.
  76                  * @see KGenericFactory
  77                  */
  78                 SkypeProtocol(QObject *parent, const QVariantList &);
  79                 /**
  80                  * Destructor.
  81                  */
  82                 ~SkypeProtocol();
  83                 /**
  84                  * Reimplementation of the methot that creates a new skype account.
  85                  * @param accountID ID of the account.
  86                  * @return At the moment NULL, but it will change soon.
  87                  */
  88                 virtual Kopete::Account *createNewAccount(const QString &accountID);
  89                 /**
  90                  * Reimplementation of the method that creates widget for adding contact to skype account.
  91                  * @param parent Parent widget. It will be showed inside.
  92                  * @param account Account to witch it aplies.
  93                  * @return At the moment NULL, but it will change soon.
  94                  */
  95                 virtual AddContactPage *createAddContactWidget(QWidget *parent, Kopete::Account *account);
  96                 /**
  97                  * Reimplementation of the method that creates widget for editing/creation of the skype account.
  98                  * @param account Account to what it applies. (0 means we create a new one)
  99                  * @param parent Parent widget. It will be showed inside it.
 100                  * @return NULL at the moment, but it will change soon.
 101                  */
 102                 virtual KopeteEditAccountWidget* createEditAccountWidget(Kopete::Account *account, QWidget *parent);
 103                 /**
 104                  * Skype plugin allows only one skype account at once. This answers weather one exists or not.
 105                  * @return true if some account exists and false if not
 106                  */
 107                 bool hasAccount() const;
 108                 /**
 109                  * Tells skype to remember this account
 110                  * @param account Pointer to the instance of the account
 111                  */
 112                 void registerAccount(SkypeAccount *account);
 113                 /**
 114                  * Removes account is some exists
 115                  */
 116                 void unregisterAccount();
 117                 /**
 118                  * Creates a contact from provided data
 119                  * @param metaContact Metacontact to add the contact into
 120                  * @param serializedData Some data to store the contact
 121                  * @param addressBookData Data inside the address book
 122                  * @return Brand new loaded contact
 123                  */
 124                 virtual Kopete::Contact *deserializeContact(Kopete::MetaContact *metaContact, const QMap<QString, QString> &serializedData, const QMap<QString, QString> &addressBokkData);
 125                 /**
 126                 * Access the instance of this protocol
 127                 */
 128                 static SkypeProtocol *protocol();
 129         public slots:
 130                 /**
 131                  * This enables or disables the "Call by skype" action depending on weather a contact(s) are selected and have skype contacts
 132                  */
 133                 void updateCallActionStatus();
 134                 /**
 135                  * This calls all selected skype contacts
 136                  */
 137                 void callContacts();
 138         protected:
 139                 static SkypeProtocol *s_protocol;
 140 };
 141
 142 #endif