kopete/libkopete/ui/editaccountwidget.h

   1 /*
   2     editaccountwidget.h - Kopete Account Widget
   3
   4     Copyright (c) 2002-2003 by Martijn Klingens      <klingens@kde.org>
   5     Copyright (c) 2003      by Olivier Goffart       <ogoffart@kde.org>
   6
   7     Kopete    (c) 2002-2003 by the Kopete developers <kopete-devel@kde.org>
   8
   9     *************************************************************************
  10     *                                                                       *
  11     * This library is free software; you can redistribute it and/or         *
  12     * modify it under the terms of the GNU Lesser General Public            *
  13     * License as published by the Free Software Foundation; either          *
  14     * version 2 of the License, or (at your option) any later version.      *
  15     *                                                                       *
  16     *************************************************************************
  17 */
  18
  19 #ifndef EDITACCOUNTWIDGET_H
  20 #define EDITACCOUNTWIDGET_H
  21
  22 #include "kopete_export.h"
  23
  24 namespace Kopete
  25 {
  26 class Account;
  27 }
  28
  29 class KopeteEditAccountWidgetPrivate;
  30
  31 /**
  32  * @author Olivier Goffart <ogoffart@kde.org>
  33  *
  34  * This class is used by the protocol plugins to add specific protocol fields in the add account wizard,
  35  * or in the account preferences. If the given account is 0L, then you will have to create a new account
  36  * in @ref apply().
  37  *
  38  * Each protocol has to subclass this class, and the protocol's edit account page MUST inherits from
  39  * QWidget too.
  40  *
  41  * We suggest to put at least these fields in the page:
  42  *
  43  * - The User login, or the accountId. you can retrieve it from @ref Kopete::Account::accountId(). This
  44  *   field has to be marked as ReadOnly or shown as a label if the account already exists. Remember
  45  *   that accountId should be constant after account creation!
  46  *
  47  * - The password, and the remember password checkboxes.
  48  *
  49  * - The auto connect checkbox: use @ref Kopete::Account::excludeConnect() and
  50  *   @ref Kopete::Account::setExcludeConnect() to get/set this flag.
  51  *
  52  * You may add other custom fields, e.g. the nickname. To save or retrieve these settings use
  53  * @ref Kopete::ContactListElement::pluginData() with your protocol as plugin.
  54  */
  55 class KOPETE_EXPORT KopeteEditAccountWidget
  56 {
  57 public:
  58         /**
  59          * Constructor.
  60          *
  61          * If 'account' is 0L we are in the 'add account wizard', otherwise
  62          * we are editing an existing account.
  63          */
  64         explicit KopeteEditAccountWidget( Kopete::Account *account );
  65
  66         /**
  67          * Destructor
  68          */
  69         virtual ~KopeteEditAccountWidget();
  70
  71         /**
  72          * This method must be reimplemented.
  73          * It does the same as @ref AddContactPage::validateData()
  74          */
  75         virtual bool validateData() = 0;
  76
  77         /**
  78          * Create a new account if we are in the 'add account wizard',
  79          * otherwise update the existing account.
  80          */
  81         virtual Kopete::Account *apply() = 0;
  82
  83 protected:
  84         /**
  85          * Get a pointer to the Kopete::Account passed to the constructor.
  86          * You can modify it any way you like, just don't delete the object.
  87          */
  88         Kopete::Account * account() const;
  89
  90         /**
  91          * Set the account
  92          */
  93         // FIXME: Is it possible to make the API not require this? A const account
  94         //        in this widget seems a lot cleaner to me - Martijn
  95         void setAccount( Kopete::Account *account );
  96
  97 private:
  98         KopeteEditAccountWidgetPrivate *d;
  99 };
 100
 101 // vim: set noet ts=4 sts=4 sw=4:
 102
 103 #endif
 104