KDE 4.0 API Reference kopete/libkopete
KopeteEditAccountWidget Class Reference
#include <editaccountwidget.h>
Detailed Description
This class is used by the protocol plugins to add specific protocol fields in the add account wizard, or in the account preferences. If the given account is 0L, then you will have to create a new account in apply().
Each protocol has to subclass this class, and the protocol's edit account page MUST inherits from QWidget too.
We suggest to put at least these fields in the page:
- The User login, or the accountId. you can retrieve it from Kopete::Account::accountId(). This field has to be marked as ReadOnly or shown as a label if the account already exists. Remember that accountId should be constant after account creation!
- The password, and the remember password checkboxes.
- The auto connect checkbox: use Kopete::Account::excludeConnect() and Kopete::Account::setExcludeConnect() to get/set this flag.
You may add other custom fields, e.g. the nickname. To save or retrieve these settings use Kopete::ContactListElement::pluginData() with your protocol as plugin.
Definition at line 55 of file editaccountwidget.h.
Public Member Functions | |
| KopeteEditAccountWidget (Kopete::Account *account) | |
| virtual | ~KopeteEditAccountWidget () |
| virtual bool | validateData ()=0 |
| virtual Kopete::Account * | apply ()=0 |
Protected Member Functions | |
| Kopete::Account * | account () const |
| void | setAccount (Kopete::Account *account) |
Constructor & Destructor Documentation
| KopeteEditAccountWidget::KopeteEditAccountWidget | ( | Kopete::Account * | account | ) | [explicit] |
Constructor.
If 'account' is 0L we are in the 'add account wizard', otherwise we are editing an existing account.
Definition at line 27 of file editaccountwidget.cpp.
| KopeteEditAccountWidget::~KopeteEditAccountWidget | ( | ) | [virtual] |
Member Function Documentation
| virtual bool KopeteEditAccountWidget::validateData | ( | ) | [pure virtual] |
This method must be reimplemented.
It does the same as AddContactPage::validateData()
| virtual Kopete::Account* KopeteEditAccountWidget::apply | ( | ) | [pure virtual] |
Create a new account if we are in the 'add account wizard', otherwise update the existing account.
| Kopete::Account * KopeteEditAccountWidget::account | ( | ) | const [protected] |
Get a pointer to the Kopete::Account passed to the constructor.
You can modify it any way you like, just don't delete the object.
Definition at line 38 of file editaccountwidget.cpp.
| void KopeteEditAccountWidget::setAccount | ( | Kopete::Account * | account | ) | [protected] |
The documentation for this class was generated from the following files:
