request.h
Go to the documentation of this file.
1 
6 /* purple
7  *
8  * Purple is the legal property of its developers, whose names are too numerous
9  * to list here. Please refer to the COPYRIGHT file distributed with this
10  * source distribution.
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25  */
26 #ifndef _PURPLE_REQUEST_H_
27 #define _PURPLE_REQUEST_H_
28 
29 #include <stdlib.h>
30 #include <glib-object.h>
31 #include <glib.h>
32 
35 
36 #include "account.h"
37 
38 #define PURPLE_DEFAULT_ACTION_NONE -1
39 
43 typedef enum
44 {
53 
57 typedef enum
58 {
59  PURPLE_REQUEST_FIELD_NONE,
60  PURPLE_REQUEST_FIELD_STRING,
61  PURPLE_REQUEST_FIELD_INTEGER,
62  PURPLE_REQUEST_FIELD_BOOLEAN,
63  PURPLE_REQUEST_FIELD_CHOICE,
64  PURPLE_REQUEST_FIELD_LIST,
65  PURPLE_REQUEST_FIELD_LABEL,
66  PURPLE_REQUEST_FIELD_IMAGE,
67  PURPLE_REQUEST_FIELD_ACCOUNT
68 
70 
74 typedef struct
75 {
76  GList *groups;
77 
78  GHashTable *fields;
79 
80  GList *required_fields;
81 
82  void *ui_data;
83 
85 
89 typedef struct
90 {
91  PurpleRequestFields *fields_list;
92 
93  char *title;
94 
95  GList *fields;
96 
98 
99 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_REQUEST_C_)
100 
104 {
107 
108  char *id;
109  char *label;
110  char *type_hint;
111 
112  gboolean visible;
113  gboolean required;
114 
115  union
116  {
117  struct
118  {
119  gboolean multiline;
120  gboolean masked;
121  gboolean editable;
122  char *default_value;
123  char *value;
124 
125  } string;
126 
127  struct
128  {
129  int default_value;
130  int value;
131 
132  } integer;
133 
134  struct
135  {
136  gboolean default_value;
137  gboolean value;
138 
139  } boolean;
140 
141  struct
142  {
143  int default_value;
144  int value;
145 
146  GList *labels;
147 
148  } choice;
149 
150  struct
151  {
152  GList *items;
153  GList *icons;
154  GHashTable *item_data;
155  GList *selected;
156  GHashTable *selected_table;
157 
158  gboolean multiple_selection;
159 
160  } list;
161 
162  struct
163  {
164  PurpleAccount *default_account;
165  PurpleAccount *account;
166  gboolean show_all;
167 
168  PurpleFilterAccountFunc filter_func;
169 
170  } account;
171 
172  struct
173  {
174  unsigned int scale_x;
175  unsigned int scale_y;
176  const char *buffer;
177  gsize size;
178  } image;
179 
180  } u;
181 
182  void *ui_data;
183 
184 };
185 #endif
186 
190 typedef struct
191 {
193  void *(*request_input)(const char *title, const char *primary,
194  const char *secondary, const char *default_value,
195  gboolean multiline, gboolean masked, gchar *hint,
196  const char *ok_text, GCallback ok_cb,
197  const char *cancel_text, GCallback cancel_cb,
198  PurpleAccount *account, const char *who,
199  PurpleConversation *conv, void *user_data);
200 
202  void *(*request_choice)(const char *title, const char *primary,
203  const char *secondary, int default_value,
204  const char *ok_text, GCallback ok_cb,
205  const char *cancel_text, GCallback cancel_cb,
206  PurpleAccount *account, const char *who,
207  PurpleConversation *conv, void *user_data,
208  va_list choices);
209 
211  void *(*request_action)(const char *title, const char *primary,
212  const char *secondary, int default_action,
213  PurpleAccount *account, const char *who,
214  PurpleConversation *conv, void *user_data,
215  size_t action_count, va_list actions);
216 
218  void *(*request_fields)(const char *title, const char *primary,
219  const char *secondary, PurpleRequestFields *fields,
220  const char *ok_text, GCallback ok_cb,
221  const char *cancel_text, GCallback cancel_cb,
222  PurpleAccount *account, const char *who,
223  PurpleConversation *conv, void *user_data);
224 
226  void *(*request_file)(const char *title, const char *filename,
227  gboolean savedialog, GCallback ok_cb,
228  GCallback cancel_cb, PurpleAccount *account,
229  const char *who, PurpleConversation *conv,
230  void *user_data);
231 
232  void (*close_request)(PurpleRequestType type, void *ui_handle);
233 
235  void *(*request_folder)(const char *title, const char *dirname,
236  GCallback ok_cb, GCallback cancel_cb,
237  PurpleAccount *account, const char *who,
238  PurpleConversation *conv, void *user_data);
239 
241  void *(*request_action_with_icon)(const char *title, const char *primary,
242  const char *secondary, int default_action,
243  PurpleAccount *account, const char *who,
244  PurpleConversation *conv,
245  gconstpointer icon_data, gsize icon_size,
246  void *user_data,
247  size_t action_count, va_list actions);
248 
249  void (*_purple_reserved1)(void);
250  void (*_purple_reserved2)(void);
251  void (*_purple_reserved3)(void);
253 
254 typedef void (*PurpleRequestInputCb)(void *, const char *);
255 
260 typedef void (*PurpleRequestActionCb)(void *, int);
261 typedef void (*PurpleRequestChoiceCb)(void *, int);
262 typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields);
263 typedef void (*PurpleRequestFileCb)(void *, const char *filename);
264 
265 #ifdef __cplusplus
266 extern "C" {
267 #endif
268 
269 /**************************************************************************/
271 /**************************************************************************/
280 
287 
295  PurpleRequestFieldGroup *group);
296 
305 
315  const char *id);
316 
325 
335  const char *id);
336 
345  const PurpleRequestFields *fields);
346 
356  const PurpleRequestFields *fields, const char *id);
357 
366 const char *purple_request_fields_get_string(const PurpleRequestFields *fields,
367  const char *id);
368 
378  const char *id);
379 
389  const char *id);
390 
400  const char *id);
401 
411  const char *id);
412 
415 /**************************************************************************/
417 /**************************************************************************/
428 
435 
443  PurpleRequestField *field);
444 
453  const PurpleRequestFieldGroup *group);
454 
463  const PurpleRequestFieldGroup *group);
464 
467 /**************************************************************************/
469 /**************************************************************************/
481 PurpleRequestField *purple_request_field_new(const char *id, const char *text,
483 
490 
497 void purple_request_field_set_label(PurpleRequestField *field, const char *label);
498 
505 void purple_request_field_set_visible(PurpleRequestField *field, gboolean visible);
506 
517  const char *type_hint);
518 
526  gboolean required);
527 
536 
547 
555 const char *purple_request_field_get_id(const PurpleRequestField *field);
556 
564 const char *purple_request_field_get_label(const PurpleRequestField *field);
565 
574 
583 
592 
603 
615  gpointer ui_data);
616 
619 /**************************************************************************/
621 /**************************************************************************/
635  const char *text,
636  const char *default_value,
637  gboolean multiline);
638 
646  const char *default_value);
647 
655  const char *value);
656 
665  gboolean masked);
666 
674  gboolean editable);
675 
684  const PurpleRequestField *field);
685 
694 
703 
712 
721 
724 /**************************************************************************/
726 /**************************************************************************/
739  const char *text,
740  int default_value);
741 
749  int default_value);
750 
758 
767 
776 
779 /**************************************************************************/
781 /**************************************************************************/
796  const char *text,
797  gboolean default_value);
798 
806  gboolean default_value);
807 
815  gboolean value);
816 
825  const PurpleRequestField *field);
826 
835 
838 /**************************************************************************/
840 /**************************************************************************/
855  const char *text,
856  int default_value);
857 
865  const char *label);
866 
874  int default_value);
875 
883 
892 
901 
910 
913 /**************************************************************************/
915 /**************************************************************************/
926 PurpleRequestField *purple_request_field_list_new(const char *id, const char *text);
927 
936  gboolean multi_select);
937 
946  const PurpleRequestField *field);
947 
957  const char *text);
958 
969  const char *item, void *data);
970 
980  const char *item, const char* icon_path, void* data);
981 
989  const char *item);
990 
997 
1005  GList *items);
1006 
1016  const char *item);
1017 
1029  const PurpleRequestField *field);
1030 
1039 
1051 
1054 /**************************************************************************/
1056 /**************************************************************************/
1068  const char *text);
1069 
1072 /**************************************************************************/
1074 /**************************************************************************/
1087 PurpleRequestField *purple_request_field_image_new(const char *id, const char *text,
1088  const char *buf, gsize size);
1089 
1097 void purple_request_field_image_set_scale(PurpleRequestField *field, unsigned int x, unsigned int y);
1098 
1107 
1116 
1125 
1134 
1137 /**************************************************************************/
1139 /**************************************************************************/
1154  const char *text,
1155  PurpleAccount *account);
1156 
1164  PurpleAccount *default_value);
1165 
1173  PurpleAccount *value);
1174 
1185  gboolean show_all);
1186 
1197  PurpleFilterAccountFunc filter_func);
1198 
1207  const PurpleRequestField *field);
1208 
1217  const PurpleRequestField *field);
1218 
1229  const PurpleRequestField *field);
1230 
1241 PurpleFilterAccountFunc purple_request_field_account_get_filter(
1242  const PurpleRequestField *field);
1243 
1246 /**************************************************************************/
1248 /**************************************************************************/
1297 void *purple_request_input(void *handle, const char *title, const char *primary,
1298  const char *secondary, const char *default_value, gboolean multiline,
1299  gboolean masked, gchar *hint,
1300  const char *ok_text, GCallback ok_cb,
1301  const char *cancel_text, GCallback cancel_cb,
1302  PurpleAccount *account, const char *who, PurpleConversation *conv,
1303  void *user_data);
1304 
1338 void *purple_request_choice(void *handle, const char *title, const char *primary,
1339  const char *secondary, int default_value,
1340  const char *ok_text, GCallback ok_cb,
1341  const char *cancel_text, GCallback cancel_cb,
1342  PurpleAccount *account, const char *who, PurpleConversation *conv,
1343  void *user_data, ...) G_GNUC_NULL_TERMINATED;
1344 
1348 void *purple_request_choice_varg(void *handle, const char *title,
1349  const char *primary, const char *secondary, int default_value,
1350  const char *ok_text, GCallback ok_cb,
1351  const char *cancel_text, GCallback cancel_cb,
1352  PurpleAccount *account, const char *who, PurpleConversation *conv,
1353  void *user_data, va_list choices);
1354 
1390 void *purple_request_action(void *handle, const char *title, const char *primary,
1391  const char *secondary, int default_action, PurpleAccount *account,
1392  const char *who, PurpleConversation *conv, void *user_data,
1393  size_t action_count, ...);
1394 
1398 void *purple_request_action_varg(void *handle, const char *title,
1399  const char *primary, const char *secondary, int default_action,
1400  PurpleAccount *account, const char *who, PurpleConversation *conv,
1401  void *user_data, size_t action_count, va_list actions);
1402 
1408 void *purple_request_action_with_icon(void *handle, const char *title,
1409  const char *primary, const char *secondary, int default_action,
1410  PurpleAccount *account, const char *who, PurpleConversation *conv,
1411  gconstpointer icon_data, gsize icon_size, void *user_data,
1412  size_t action_count, ...);
1413 
1419 void *purple_request_action_with_icon_varg(void *handle, const char *title,
1420  const char *primary, const char *secondary, int default_action,
1421  PurpleAccount *account, const char *who, PurpleConversation *conv,
1422  gconstpointer icon_data, gsize icon_size,
1423  void *user_data, size_t action_count, va_list actions);
1424 
1425 
1455 void *purple_request_fields(void *handle, const char *title, const char *primary,
1456  const char *secondary, PurpleRequestFields *fields,
1457  const char *ok_text, GCallback ok_cb,
1458  const char *cancel_text, GCallback cancel_cb,
1459  PurpleAccount *account, const char *who, PurpleConversation *conv,
1460  void *user_data);
1461 
1468 void purple_request_close(PurpleRequestType type, void *uihandle);
1469 
1478 void purple_request_close_with_handle(void *handle);
1479 
1483 #define purple_request_yes_no(handle, title, primary, secondary, \
1484  default_action, account, who, conv, \
1485  user_data, yes_cb, no_cb) \
1486  purple_request_action((handle), (title), (primary), (secondary), \
1487  (default_action), account, who, conv, (user_data), 2, \
1488  _("_Yes"), (yes_cb), _("_No"), (no_cb))
1489 
1493 #define purple_request_ok_cancel(handle, title, primary, secondary, \
1494  default_action, account, who, conv, \
1495  user_data, ok_cb, cancel_cb) \
1496  purple_request_action((handle), (title), (primary), (secondary), \
1497  (default_action), account, who, conv, (user_data), 2, \
1498  _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb))
1499 
1503 #define purple_request_accept_cancel(handle, title, primary, secondary, \
1504  default_action, account, who, conv, \
1505  user_data, accept_cb, cancel_cb) \
1506  purple_request_action((handle), (title), (primary), (secondary), \
1507  (default_action), account, who, conv, (user_data), 2, \
1508  _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
1509 
1514 #define purple_request_accept_cancel_with_icon(handle, title, primary, secondary, \
1515  default_action, account, who, conv, \
1516  icon_data, icon_size, \
1517  user_data, accept_cb, cancel_cb) \
1518  purple_request_action_with_icon((handle), (title), (primary), (secondary), \
1519  (default_action), account, who, conv, icon_data, icon_size, \
1520  (user_data), 2, \
1521  _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
1522 
1547 void *purple_request_file(void *handle, const char *title, const char *filename,
1548  gboolean savedialog, GCallback ok_cb, GCallback cancel_cb,
1549  PurpleAccount *account, const char *who, PurpleConversation *conv,
1550  void *user_data);
1551 
1574 void *purple_request_folder(void *handle, const char *title, const char *dirname,
1575  GCallback ok_cb, GCallback cancel_cb,
1576  PurpleAccount *account, const char *who, PurpleConversation *conv,
1577  void *user_data);
1578 
1581 /**************************************************************************/
1583 /**************************************************************************/
1593 
1601 
1604 #ifdef __cplusplus
1605 }
1606 #endif
1607 
1608 #endif /* _PURPLE_REQUEST_H_ */