1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* Ekiga -- A VoIP and Video-Conferencing application
* Copyright (C) 2000-2009 Damien Sandras <dsandras@seconix.com>
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version. This program is distributed in the hope
* that it will be useful, but WITHOUT ANY WARRANTY; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Ekiga is licensed under the GPL license and as a special exception, you
* have permission to link or otherwise combine this program with the
* programs OPAL, OpenH323 and PWLIB, and distribute the combination, without
* applying the requirements of the GNU GPL to the OPAL, OpenH323 and PWLIB
* programs, as long as you do follow the requirements of the GNU GPL for all
* the rest of the software thus combined.
*/
/*
* account.h - description
* ------------------------------------------
* begin : written in 2008 by Damien Sandras
* copyright : (c) 2008 by Damien Sandras
* description : declaration of the interface of an AccountManager
* Account
*
*/
#ifndef __ACCOUNT_H__
#define __ACCOUNT_H__
#include <set>
#include <map>
#include <string>
#include "account-core.h"
#include "chain-of-responsibility.h"
#include "form-request.h"
#include "menu-builder.h"
namespace Ekiga
{
/**
* @addtogroup accounts
* @{
*/
class Account
{
public:
/** The destructor.
*/
virtual ~Account () { }
/** Returns the name of the Ekiga::Account.
* This function is purely virtual and should be implemented by the
* Ekiga::Account descendant.
* @return The name of the Ekiga::Contact.
*/
virtual const std::string get_name () const = 0;
/** Returns the address of record for that Ekiga::Account.
* @return The address of record.
*/
virtual const std::string get_aor () const = 0;
/** Returns the hostname for the Ekiga::Account.
* This function is purely virtual and should be implemented by the
* Ekiga::Account descendant.
* @return The host name of the Ekiga::Account.
*/
virtual const std::string get_host () const = 0;
/** Subscribe the given account.
* This function is purely virtual and should be implemented by the
* Ekiga::Account descendant.
*/
virtual void enable () = 0;
/** Unsubscribe the given account.
* This function is purely virtual and should be implemented by the
* Ekiga::Account descendant.
*/
virtual void disable () = 0;
/** Return true if the account is enabled.
* It does not mean that the account is successfully registered, it
* just means it is enabled.
* This function is purely virtual and should be implemented by the
* Ekiga::Account descendant.
*/
virtual bool is_enabled () const = 0;
/** Return true if the account is active.
* This function is purely virtual and should be implemented by the
* Ekiga::Account descendant.
*/
virtual bool is_active () const = 0;
/** Create the menu for that account and its actions.
* This function is purely virtual and should be implemented by
* the descendant of the Ekiga::Contact.
* @param A MenuBuilder object to populate.
*/
virtual bool populate_menu (MenuBuilder &) = 0;
/**
* Signals on that object
*/
/** This signal is emitted when the Account has been updated.
*/
sigc::signal0<void> updated;
/** This signal is emitted when the Account has been removed.
*/
sigc::signal0<void> removed;
/** This signal is emitted when there is a new registration event for
* the Account.
* @param: state is the state
* info contains information about the registration status
*/
sigc::signal2<void, Ekiga::AccountCore::RegistrationState, std::string> registration_event;
/** This signal is emitted when there is a new message waiting indication
* @param: mwi is the message waiting indication
*/
sigc::signal1<void, std::string> mwi_event;
/** This chain allows the Account to present forms to the user
*/
ChainOfResponsibility<FormRequest*> questions;
};
/**
* @}
*/
};
#endif
|