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
|
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_WHITEBOARD_MANAGER_H
#define PURPLE_WHITEBOARD_MANAGER_H
#include <glib.h>
#include <glib-object.h>
#include <libpurple/purplewhiteboard.h>
G_BEGIN_DECLS
/**
* PURPLE_WHITEBOARD_MANAGER_DOMAIN:
*
* A #GError domain for errors from #PurpleWhiteboardManager.
*
* Since: 3.0.0
*/
#define PURPLE_WHITEBOARD_MANAGER_DOMAIN (g_quark_from_static_string("purple-whiteboard-manager"))
#define PURPLE_TYPE_WHITEBOARD_MANAGER (purple_whiteboard_manager_get_type())
/**
* PurpleWhiteboardManager:
*
* #PurpleWhiteboardManager keeps track of all whiteboards and emits signals
* when whiteboards are registered and unregistered.
*
* Since: 3.0.0
*/
G_DECLARE_FINAL_TYPE(PurpleWhiteboardManager, purple_whiteboard_manager,
PURPLE, WHITEBOARD_MANAGER, GObject)
/**
* purple_whiteboard_manager_get_default:
*
* Gets the default #PurpleWhiteboardManager instance.
*
* Returns: (transfer none): The default #PurpleWhiteboardManager instance.
*
* Since: 3.0.0
*/
PurpleWhiteboardManager *purple_whiteboard_manager_get_default(void);
/**
* purple_whiteboard_manager_get_default_as_model:
*
* Gets the default manager as a [iface@Gio.ListModel].
*
* Returns: (transfer none): The default manager cast to a
* [iface@Gio.ListModel].
*
* Since: 3.0.0
*/
GListModel *purple_whiteboard_manager_get_default_as_model(void);
/**
* purple_whiteboard_manager_register:
* @manager: The #PurpleWhiteboardManager instance.
* @whiteboard: The #PurpleWhiteboard to register.
* @error: Return address for a #GError, or %NULL.
*
* Registers @whiteboard with @manager.
*
* Returns: %TRUE if @whiteboard was successfully registered with @manager,
* %FALSE otherwise.
*
* Since: 3.0.0
*/
gboolean purple_whiteboard_manager_register(PurpleWhiteboardManager *manager, PurpleWhiteboard *whiteboard, GError **error);
/**
* purple_whiteboard_manager_unregister:
* @manager: The #PurpleWhiteboardManager instance.
* @whiteboard: The #PurpleWhiteboard to unregister.
* @error: Return address for a #GError, or %NULL.
*
* Unregisters @whiteboard from @manager.
*
* Returns: %TRUE if @whiteboard was successfully unregistered from @manager,
* %FALSE otherwise.
*
* Since: 3.0.0
*/
gboolean purple_whiteboard_manager_unregister(PurpleWhiteboardManager *manager, PurpleWhiteboard *whiteboard, GError **error);
/**
* purple_whiteboard_manager_find:
* @manager: The #PurpleWhiteboardManager instance.
* @id: The id of the #PurpleWhiteboard to find.
*
* Gets the #PurpleWhiteboard identified by @id if found, otherwise %NULL.
*
* Returns: (transfer none): The #PurpleWhiteboard identified by @id or %NULL.
*
* Since: 3.0.0
*/
PurpleWhiteboard *purple_whiteboard_manager_find(PurpleWhiteboardManager *manager, const gchar *id);
G_END_DECLS
#endif /* PURPLE_WHITEBOARD_MANAGER_H */
|
