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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/*
* 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 <pidgin.h> may be included directly"
#endif
#ifndef PURPLE_UI_H
#define PURPLE_UI_H
#include <glib.h>
#include <glib-object.h>
G_BEGIN_DECLS
#define PURPLE_TYPE_UI (purple_ui_get_type())
G_DECLARE_DERIVABLE_TYPE(PurpleUi, purple_ui, PURPLE, UI, GObject)
/**
* PurpleUi:
*
* An abstract class representing a user interface. All user interfaces must
* create a subclass of this and pass it to [func@Purple.Core.init].
*
* Since: 3.0.0
*/
/**
* PurpleUiClass:
* @prefs_init: This function is called to initialize the ui's preferences.
* This is slowly being phased out for @get_settings_backend, but
* is still required.
* @start: Called when libpurple is done with its initialization when the user
* interface should start telling libpurple about the rest of the user
* interface's interfaces.
* @stop: Called after most of libpurple has been uninitialized.
* @get_settings_backend: Called to get the [class@Gio.SettingsBackend] that
* the UI is using.
*
* The base class for all user interfaces which is used to identify themselves
* to libpurple when calling [func@Purple.Core.init].
*
* Since: 3.0.0
*/
struct _PurpleUiClass {
/*< private >*/
GObjectClass parent;
/*< public >*/
void (*prefs_init)(PurpleUi *ui);
gboolean (*start)(PurpleUi *ui, GError **error);
void (*stop)(PurpleUi *ui);
gpointer (*get_settings_backend)(PurpleUi *ui);
/*< private >*/
gpointer reserved[4];
};
/**
* purple_ui_get_id:
* @ui: The instance.
*
* Gets the id for the user interface.
*
* Returns: id of the user interface.
*
* Since: 3.0.0
*/
const char *purple_ui_get_id(PurpleUi *ui);
/**
* purple_ui_get_name:
* @ui: The instance.
*
* Gets the name of @ui. This should be translated.
*
* Returns: The name of the user interface.
*
* Since: 3.0.0
*/
const char *purple_ui_get_name(PurpleUi *ui);
/**
* purple_ui_get_version:
* @ui: The instance.
*
* Gets the version of @ui.
*
* Returns: The version of the user interface.
*
* Since: 3.0.0
*/
const char *purple_ui_get_version(PurpleUi *ui);
/**
* purple_ui_get_website:
* @ui: The instance.
*
* Gets the website from @ui.
*
* Returns: (nullable): The website URI of the user interface or %NULL.
*
* Since: 3.0.0
*/
const char *purple_ui_get_website(PurpleUi *ui);
/**
* purple_ui_get_support_website:
* @ui: The instance.
*
* Gets the support website from @ui.
*
* Returns: (nullable): The support website URI of the user interface or %NULL.
*
* Since: 3.0.0
*/
const char *purple_ui_get_support_website(PurpleUi *ui);
/**
* purple_ui_get_client_type:
* @ui: The instance.
*
* Gets the client type from @ui.
*
* Returns: (transfer none): The client type of the user interface.
*
* Since: 3.0.0
*/
const char *purple_ui_get_client_type(PurpleUi *ui);
/**
* purple_ui_prefs_init:
* @ui: The instance.
*
* Tells @ui that it should be initializing its preferences.
*
* Note: This should only be called by libpurple.
*
* Since: 3.0.0
*/
void purple_ui_prefs_init(PurpleUi *ui);
/**
* purple_ui_start:
* @ui: The instance.
* @error: Return address for a #GError, or %NULL.
*
* Tells @ui that libpurple is done initializing and that @ui should continue
* its initialization.
*
* The user interface can return errors here which will be propagated by
* [func@Purple.Core.init] which calls this function.
*
* Note: This should only be called by libpurple.
*
* Returns: %TRUE if successful, otherwise %FALSE with @error optionally set.
*
* Since: 3.0.0
*/
gboolean purple_ui_start(PurpleUi *ui, GError **error);
/**
* purple_ui_stop:
* @ui: The instance.
*
* Tells @ui that libpurple is done shutting down.
*
* Note: This should only be called by libpurple.
*
* Since: 3.0.0
*/
void purple_ui_stop(PurpleUi *ui);
/**
* purple_ui_get_settings_backend:
* @ui: The instance:
*
* Get the [class@Gio.SettingsBackend] that @ui is using for its settings.
*
* Note: This should only be called by libpurple.
*
* Returns: (transfer full): The settings that @ui is using.
*
* Since: 3.0.0
*/
gpointer purple_ui_get_settings_backend(PurpleUi *ui);
G_END_DECLS
#endif /* PURPLE_UI_H */
|
