KDE 4.0 API Reference kopete/libkopete
Kopete::PasswordedAccount Class Reference
#include <kopetepasswordedaccount.h>
Detailed Description
An account requiring a password to connect.Instead of reimplementing connect() in your subclass, reimplement connectWithPassword.
Definition at line 36 of file kopetepasswordedaccount.h.
Public Slots | |
| virtual void | connectWithPassword (const QString &password)=0 |
Public Member Functions | |
| PasswordedAccount (Protocol *parent, const QString &acctId, bool allowBlankPassword=false) | |
| virtual | ~PasswordedAccount () |
| Password & | password () |
| void | connect () |
| void | connect (const OnlineStatus &initialStatus) |
| OnlineStatus | initialStatus () |
| virtual bool | removeAccount () |
Protected Slots | |
| virtual void | disconnected (Kopete::Account::DisconnectReason reason) |
Protected Member Functions | |
| virtual QString | passwordPrompt () |
Constructor & Destructor Documentation
| Kopete::PasswordedAccount::PasswordedAccount | ( | Kopete::Protocol * | parent, | |
| const QString & | acctId, | |||
| bool | allowBlankPassword = false | |||
| ) |
KopetePasswordedAccount constructor.
- Parameters:
-
parent The protocol this account connects via acctId The ID of this account - should be unique within this protocol maxPasswordLength The maximum length for passwords for this account, or 0 for no limit allowBlankPassword If this protocol allows blank passwords. Note that this will mean that name The name for this QObject
Definition at line 34 of file kopetepasswordedaccount.cpp.
| Kopete::PasswordedAccount::~PasswordedAccount | ( | ) | [virtual] |
Definition at line 39 of file kopetepasswordedaccount.cpp.
Member Function Documentation
| Kopete::Password & Kopete::PasswordedAccount::password | ( | ) |
Returns a reference to the password object stored in this account.
Definition at line 44 of file kopetepasswordedaccount.cpp.
| void Kopete::PasswordedAccount::connect | ( | ) |
Definition at line 49 of file kopetepasswordedaccount.cpp.
| void Kopete::PasswordedAccount::connect | ( | const OnlineStatus & | initialStatus | ) | [virtual] |
Go online for this service.
- Parameters:
-
initialStatus is the status to connect with. If it is an invalid status for this account, the default online for the account should be used.
Implements Kopete::Account.
Definition at line 55 of file kopetepasswordedaccount.cpp.
| Kopete::OnlineStatus Kopete::PasswordedAccount::initialStatus | ( | ) |
| bool Kopete::PasswordedAccount::removeAccount | ( | ) | [virtual] |
Remove the account from the server.
Reimplementation of Account::removeAccount() to remove the password from the wallet. if your protocol reimplements this function, this function should still be called.
- Returns:
- Always true
Reimplemented from Kopete::Account.
Definition at line 85 of file kopetepasswordedaccount.cpp.
| virtual void Kopete::PasswordedAccount::connectWithPassword | ( | const QString & | password | ) | [pure virtual, slot] |
Called when your account should attempt to connect.
- Parameters:
-
password The password to connect with, or QString() if the user wished to cancel the connection attempt.
Implemented in Kopete::ManagedConnectionAccount.
| QString Kopete::PasswordedAccount::passwordPrompt | ( | ) | [protected, virtual] |
Returns the prompt shown to the user when requesting their password.
The default implementation should be adequate in most cases; override if you have a custom message to show the user.
Definition at line 72 of file kopetepasswordedaccount.cpp.
| void Kopete::PasswordedAccount::disconnected | ( | Kopete::Account::DisconnectReason | reason | ) | [protected, virtual, slot] |
The service has been disconnected.
You have to call this method when you are disconnected. Depending on the value of reason, this function may attempt to reconnect to the server.
- BadPassword will ask again for the password
- OtherClient will show a message box
- Parameters:
-
reason the reason for the disconnection.
Reimplemented from Kopete::Account.
Definition at line 91 of file kopetepasswordedaccount.cpp.
The documentation for this class was generated from the following files:
