finch/gntrequest.h

changeset 42678
0b9b81b6ff18
parent 42677
66b49e545c53
child 42679
192a8112562f
equal deleted inserted replaced
42677:66b49e545c53 42678:0b9b81b6ff18
1 /*
2 * finch
3 *
4 * Finch is the legal property of its developers, whose names are too numerous
5 * to list here. Please refer to the COPYRIGHT file distributed with this
6 * source distribution.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
21 */
22
23 #if !defined(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
24 # error "only <finch.h> may be included directly"
25 #endif
26
27 #ifndef FINCH_REQUEST_H
28 #define FINCH_REQUEST_H
29
30 #include <purple.h>
31
32 #include "gnt.h"
33
34 /**********************************************************************
35 * GNT Request API
36 **********************************************************************/
37
38 /**
39 * finch_request_get_ui_ops:
40 *
41 * Get the ui-functions.
42 *
43 * Returns: The PurpleRequestUiOps structure populated with the appropriate functions.
44 */
45 PurpleRequestUiOps *finch_request_get_ui_ops(void);
46
47 /**
48 * finch_request_init:
49 *
50 * Perform necessary initializations.
51 */
52 void finch_request_init(void);
53
54 /**
55 * finch_request_uninit:
56 *
57 * Perform necessary uninitializations.
58 */
59 void finch_request_uninit(void);
60
61 /**
62 * finch_request_save_in_prefs:
63 * @data: No longer used, set to %NULL.
64 * @page: The #PurpleRequestPage to save.
65 *
66 * Save the request fields in preferences where the id attribute of each field is the
67 * id of a preference.
68 */
69 void finch_request_save_in_prefs(gpointer data, PurpleRequestPage *page);
70
71 /**
72 * finch_request_field_get_widget:
73 * @field: The request field.
74 *
75 * Create a widget field for a request-field.
76 *
77 * Returns: (transfer full): A GntWidget for the request field.
78 */
79 GntWidget *finch_request_field_get_widget(PurpleRequestField *field);
80
81 #endif /* FINCH_REQUEST_H */
82

mercurial