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
* heap.h - description
29
* ------------------------------------------
30
* begin : written in 2007 by Julien Puydt
31
* copyright : (c) 2007 by Julien Puydt
32
* description : declaration of the interface of a heap
33
* of presentities (equivalent of an addressbooks for
41
#include "presentity.h"
47
* @addtogroup presence
60
/** Returns the name of the Heap
61
* @return The Heap's name
63
virtual const std::string get_name () const = 0;
65
/** Get the list of Presentities by visiting them with a callback.
66
* @param The callback user to know about presentities (the return value
67
* means "go on" and allows stopping the visit)
69
virtual void visit_presentities (sigc::slot<bool, Presentity &>) = 0;
71
/** Populates a menu with the actions possible on the Heap.
72
* @param The builder to populate.
74
virtual bool populate_menu (MenuBuilder &) = 0;
76
/** Populates a menu with the actions possible on the given group
78
* @param The name of the group on which to act.
79
* @param The builder to populate.
81
virtual bool populate_menu_for_group (const std::string name,
85
* Signals on that object
88
/** This signal is emitted when the Heap has been updated.
90
sigc::signal<void> updated;
92
/** This signal is emitted when the Heap has been removed.
94
sigc::signal<void> removed;
96
/** This signal is emitted when a Presentity has been added to the Heap.
98
sigc::signal<void, Presentity &> presentity_added;
100
/** This signal is emitted when a Presentity has been updated in the Heap.
102
sigc::signal<void, Presentity &> presentity_updated;
104
/** This signal is emitted when a Presentity has been removed from the Heap.
106
sigc::signal<void, Presentity &> presentity_removed;
108
/** This chain allows the Heap to present forms to the user
110
ChainOfResponsibility<FormRequest*> questions;