kopete/libkopete/tasks/kopetecontacttaskbase.h

   1 /*
   2     kopetecontacttaskbase.h - Base task for all contact tasks
   3
   4     Copyright (c) 2007      by Michaël Larouche      <larouche@kde.org>
   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 #ifndef KOPETE_CONTACTTASKBASE_H
  18 #define KOPETE_CONTACTTASKBASE_H
  19
  20 #include <kopetetask.h>
  21 #include <kopete_export.h>
  22
  23 namespace Kopete
  24 {
  25
  26 class Contact;
  27 /**
  28  * @brief Base tasks for all contact related tasks
  29  *
  30  * This class contains all the common code and data
  31  * for all contact tasks.
  32  *
  33  * Derived must implement tastType() to allow setContact()
  34  * to automatically add the correct subtask from the protocol.
  35  *
  36  * @author Michaël Larouche <larouche@kde.org>
  37  */
  38 class KOPETE_EXPORT ContactTaskBase : public Kopete::Task
  39 {
  40         Q_OBJECT
  41 public:
  42         /**
  43          * @brief Default constructor
  44          *
  45          / You must set the contact with setContact()
  46          */
  47         explicit ContactTaskBase(QObject *parent = 0);
  48         /**
  49          * destructor
  50          */
  51         virtual ~ContactTaskBase();
  52
  53         /**
  54          * @brief Set the contact
  55          *
  56          * This method also add children tasks for
  57          * the specific protocol. You don't need
  58          * to do it yourself.
  59          */
  60         void setContact(Kopete::Contact *contact);
  61
  62 protected:
  63         /**
  64          * @brief Get access to Kopete::Contact
  65          * @return a Kopete::Contact pointer.
  66          */
  67         Kopete::Contact *contact();
  68
  69         /**
  70          * @brief Get the taskType
  71          *
  72          * This is the type of task from the devired class.
  73          * Used by setContact()
  74          */
  75         virtual QString taskType() const = 0;
  76
  77 private:
  78         class Private;
  79         Private * const d;
  80 };
  81
  82 }
  83 #endif