3
* Ekiga -- A VoIP and Video-Conferencing application
4
* Copyright (C) 2000-2007 Damien Sandras
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or (at
9
* your option) any later version. This program is distributed in the hope
10
* that it will be useful, but WITHOUT ANY WARRANTY; without even the
11
* implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
* See the GNU General Public License for more details.
14
* You should have received a copy of the GNU General Public License along
15
* with this program; if not, write to the Free Software Foundation, Inc.,
16
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
18
* Ekiga is licensed under the GPL license and as a special exception, you
19
* have permission to link or otherwise combine this program with the
20
* programs OPAL, OpenH323 and PWLIB, and distribute the combination, without
21
* applying the requirements of the GNU GPL to the OPAL, OpenH323 and PWLIB
22
* programs, as long as you do follow the requirements of the GNU GPL for all
23
* the rest of the software thus combined.
28
* local-presentity.h - description
29
* ------------------------------------------
30
* begin : written in 2007 by Julien Puydt
31
* copyright : (c) 2007 by Julien Puydt
32
* description : declaration of a presentity for the local roster
38
#ifndef __LOCAL_PRESENTITY_H__
39
#define __LOCAL_PRESENTITY_H__
42
#include "presence-core.h"
43
#include "presentity.h"
50
* @addtogroup presence
56
* This class implements an Ekiga::Presentity.
58
* The Presentity is represented by an internal XML document.
60
* There is a private signal, 'trigger_saving', which will be emitted
61
* when appropriate to signal the Local::Heap that the XML tree has been
62
* modified, and hence needs saving.
64
class Presentity: public Ekiga::Presentity
69
* Constructors (and destructor)
71
Presentity (Ekiga::ServiceCore &_core,
74
Presentity (Ekiga::ServiceCore &_core,
75
const std::string _name,
76
const std::string _uri,
77
const std::set<std::string> _groups);
83
* Get elements of the presentity
85
const std::string get_name () const;
87
const std::string get_presence () const;
89
const std::string get_status () const;
91
const std::string get_avatar () const;
93
const std::set<std::string> get_groups () const;
95
const std::string get_uri () const;
99
* This will set a new presence string
100
* and emit the 'updated' signal to announce
101
* to the various components that the GmConf::Presentity
104
void set_presence (const std::string _presence);
108
* This will set a new status string
109
* and emit the 'updated' signal to announce
110
* to the various components that the GmConf::Presentity
113
void set_status (const std::string _status);
116
/** Populates the given Ekiga::MenuBuilder with the actions.
117
* Inherits from Ekiga::Presentity.
118
* @param: A MenuBuilder.
119
* @return: A populated menu.
121
bool populate_menu (Ekiga::MenuBuilder &);
124
/** Return the current node in the XML document
125
* describing the Presentity.
126
* @return: A pointer to the node.
128
xmlNodePtr get_node () const;
131
/** Rename the given group, if this Presentity belongs to it
134
void rename_group (const std::string old_name,
135
const std::string new_name);
138
/** Remove the current node from the XML document,
139
* emit the 'removed' signal so the different views
140
* know we're going away, and finally emit 'trigger_saving'
141
* so the Local::Heap knows about it.
147
* This signal makes the Local::Heap know that the XML tree changed
148
* and hence should be saved
150
sigc::signal<void> trigger_saving;
155
/** This function should be called when a presentity has
156
* to be edited. It uses a form with the known
157
* fields already filled in.
159
void edit_presentity ();
162
/** This is called when a form from edit_presentity
165
* It does error checking and edits the Presentity.
166
* It will also emit the 'updated' signal and the
167
* private 'trigger_saving' signal to trigger saving
168
* from the Local::Heap.
170
void edit_presentity_form_submitted (Ekiga::Form &result);
173
Ekiga::ServiceCore &core;
174
Ekiga::PresenceCore *presence_core;
177
xmlNodePtr name_node;
181
std::string presence;
185
std::map<std::string, xmlNodePtr> group_nodes;
186
std::set<std::string> groups;