Mercurial > pidgin.yaz
annotate libpurple/request.h @ 32637:5aa171c8776b
Fix a bunch of tiny problems generating our doxygen documentation
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sun, 18 Sep 2011 20:46:06 +0000 |
parents | 694382c3d150 |
children | 02a2e8183b1d |
rev | line source |
---|---|
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
2 * @file request.h Request API |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
3 * @ingroup core |
20074
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19680
diff
changeset
|
4 */ |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19680
diff
changeset
|
5 |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19680
diff
changeset
|
6 /* purple |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
7 * |
15823 | 8 * Purple is the legal property of its developers, whose names are too numerous |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
9 * to list here. Please refer to the COPYRIGHT file distributed with this |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
10 * source distribution. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
11 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
12 * This program is free software; you can redistribute it and/or modify |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
13 * it under the terms of the GNU General Public License as published by |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
14 * the Free Software Foundation; either version 2 of the License, or |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
15 * (at your option) any later version. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
16 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
17 * This program is distributed in the hope that it will be useful, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
20 * GNU General Public License for more details. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
21 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
22 * You should have received a copy of the GNU General Public License |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
19680
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
19408
diff
changeset
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
25 */ |
15823 | 26 #ifndef _PURPLE_REQUEST_H_ |
27 #define _PURPLE_REQUEST_H_ | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
28 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
29 #include <stdlib.h> |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
30 #include <glib-object.h> |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
31 #include <glib.h> |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
32 |
32637
5aa171c8776b
Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <mark@kingant.net>
parents:
32614
diff
changeset
|
33 /** |
5aa171c8776b
Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <mark@kingant.net>
parents:
32614
diff
changeset
|
34 * A request field. |
5aa171c8776b
Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <mark@kingant.net>
parents:
32614
diff
changeset
|
35 */ |
25328
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
36 typedef struct _PurpleRequestField PurpleRequestField; |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
37 |
32452
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
38 /** |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
39 * Multiple fields request data. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
40 */ |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
41 typedef struct _PurpleRequestFields PurpleRequestFields; |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
42 |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
43 /** |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
44 * A group of fields with a title. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
45 */ |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
46 typedef struct _PurpleRequestFieldGroup PurpleRequestFieldGroup; |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
47 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
48 #include "account.h" |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
49 |
15823 | 50 #define PURPLE_DEFAULT_ACTION_NONE -1 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
51 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
52 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
53 * Request types. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
54 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
55 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
56 { |
15823 | 57 PURPLE_REQUEST_INPUT = 0, /**< Text input request. */ |
58 PURPLE_REQUEST_CHOICE, /**< Multiple-choice request. */ | |
59 PURPLE_REQUEST_ACTION, /**< Action request. */ | |
60 PURPLE_REQUEST_FIELDS, /**< Multiple fields request. */ | |
61 PURPLE_REQUEST_FILE, /**< File open or save request. */ | |
62 PURPLE_REQUEST_FOLDER /**< Folder selection request. */ | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
63 |
15823 | 64 } PurpleRequestType; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
65 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
66 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
67 * A type of field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
68 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
69 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
70 { |
15823 | 71 PURPLE_REQUEST_FIELD_NONE, |
72 PURPLE_REQUEST_FIELD_STRING, | |
73 PURPLE_REQUEST_FIELD_INTEGER, | |
74 PURPLE_REQUEST_FIELD_BOOLEAN, | |
75 PURPLE_REQUEST_FIELD_CHOICE, | |
76 PURPLE_REQUEST_FIELD_LIST, | |
77 PURPLE_REQUEST_FIELD_LABEL, | |
78 PURPLE_REQUEST_FIELD_IMAGE, | |
21566
593d119b7980
disapproval of revision 'c52c996c95bec84928db81dc592640366ff5a432'
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21218
diff
changeset
|
79 PURPLE_REQUEST_FIELD_ACCOUNT |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
80 |
15823 | 81 } PurpleRequestFieldType; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
82 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
83 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
84 * Request UI operations. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
85 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
86 typedef struct |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
87 { |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
88 /** @see purple_request_input(). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
89 void *(*request_input)(const char *title, const char *primary, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
90 const char *secondary, const char *default_value, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
91 gboolean multiline, gboolean masked, gchar *hint, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
92 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
93 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
94 PurpleAccount *account, const char *who, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
95 PurpleConversation *conv, void *user_data); |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
96 |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
97 /** @see purple_request_choice_varg(). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
98 void *(*request_choice)(const char *title, const char *primary, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
99 const char *secondary, int default_value, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
100 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
101 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
102 PurpleAccount *account, const char *who, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
103 PurpleConversation *conv, void *user_data, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
104 va_list choices); |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
105 |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
106 /** @see purple_request_action_varg(). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
107 void *(*request_action)(const char *title, const char *primary, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
108 const char *secondary, int default_action, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
109 PurpleAccount *account, const char *who, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
110 PurpleConversation *conv, void *user_data, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
111 size_t action_count, va_list actions); |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
112 |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
113 /** @see purple_request_fields(). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
114 void *(*request_fields)(const char *title, const char *primary, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
115 const char *secondary, PurpleRequestFields *fields, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
116 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
117 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
118 PurpleAccount *account, const char *who, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
119 PurpleConversation *conv, void *user_data); |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
120 |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
121 /** @see purple_request_file(). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
122 void *(*request_file)(const char *title, const char *filename, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
123 gboolean savedialog, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
124 GCallback cancel_cb, PurpleAccount *account, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
125 const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
126 void *user_data); |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
127 |
15823 | 128 void (*close_request)(PurpleRequestType type, void *ui_handle); |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
129 |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
130 /** @see purple_request_folder(). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
131 void *(*request_folder)(const char *title, const char *dirname, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
132 GCallback ok_cb, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
133 PurpleAccount *account, const char *who, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
134 PurpleConversation *conv, void *user_data); |
16672
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
16550
diff
changeset
|
135 |
30265
e72f6383095b
It seems like the _varg should be at the end.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
30255
diff
changeset
|
136 /** @see purple_request_action_with_icon_varg(). */ |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
137 void *(*request_action_with_icon)(const char *title, const char *primary, |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
138 const char *secondary, int default_action, |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
139 PurpleAccount *account, const char *who, |
31533
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
140 PurpleConversation *conv, |
30249
905e291986bc
Whitespace trim.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
30229
diff
changeset
|
141 gconstpointer icon_data, gsize icon_size, |
905e291986bc
Whitespace trim.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
30229
diff
changeset
|
142 void *user_data, |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
143 size_t action_count, va_list actions); |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
144 |
16672
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
16550
diff
changeset
|
145 void (*_purple_reserved1)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
16550
diff
changeset
|
146 void (*_purple_reserved2)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
16550
diff
changeset
|
147 void (*_purple_reserved3)(void); |
15823 | 148 } PurpleRequestUiOps; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
149 |
15823 | 150 typedef void (*PurpleRequestInputCb)(void *, const char *); |
22444
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
151 |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
152 /** The type of callbacks passed to purple_request_action(). The first |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
153 * argument is the @a user_data parameter; the second is the index in the list |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
154 * of actions of the one chosen. |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
155 */ |
15823 | 156 typedef void (*PurpleRequestActionCb)(void *, int); |
157 typedef void (*PurpleRequestChoiceCb)(void *, int); | |
158 typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields); | |
159 typedef void (*PurpleRequestFileCb)(void *, const char *filename); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
160 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
161 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
162 extern "C" { |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
163 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
164 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
165 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
166 /** @name Field List API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
167 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
168 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
169 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
170 /** |
15823 | 171 * Creates a list of fields to pass to purple_request_fields(). |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
172 * |
15823 | 173 * @return A PurpleRequestFields structure. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
174 */ |
15823 | 175 PurpleRequestFields *purple_request_fields_new(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
176 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
177 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
178 * Destroys a list of fields. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
179 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
180 * @param fields The list of fields to destroy. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
181 */ |
15823 | 182 void purple_request_fields_destroy(PurpleRequestFields *fields); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
183 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
184 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
185 * Adds a group of fields to the list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
186 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
187 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
188 * @param group The group to add. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
189 */ |
15823 | 190 void purple_request_fields_add_group(PurpleRequestFields *fields, |
191 PurpleRequestFieldGroup *group); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
192 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
193 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
194 * Returns a list of all groups in a field list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
195 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
196 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
197 * |
20891
59c9c04879af
Replace a bunch of @return markers with @constreturn markers. I believe these
Etan Reisner <pidgin@unreliablesource.net>
parents:
20074
diff
changeset
|
198 * @constreturn A list of groups. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
199 */ |
15823 | 200 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
201 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
202 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
203 * Returns whether or not the field with the specified ID exists. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
204 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
205 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
206 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
207 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
208 * @return TRUE if the field exists, or FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
209 */ |
15823 | 210 gboolean purple_request_fields_exists(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
211 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
212 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
213 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
214 * Returns a list of all required fields. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
215 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
216 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
217 * |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
218 * @constreturn The list of required fields. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
219 */ |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
220 GList *purple_request_fields_get_required(const PurpleRequestFields *fields); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
221 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
222 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
223 * Returns whether or not a field with the specified ID is required. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
224 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
225 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
226 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
227 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
228 * @return TRUE if the specified field is required, or FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
229 */ |
15823 | 230 gboolean purple_request_fields_is_field_required(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
231 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
232 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
233 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
234 * Returns whether or not all required fields have values. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
235 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
236 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
237 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
238 * @return TRUE if all required fields have values, or FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
239 */ |
15823 | 240 gboolean purple_request_fields_all_required_filled( |
241 const PurpleRequestFields *fields); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
242 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
243 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
244 * Return the field with the specified ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
245 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
246 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
247 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
248 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
249 * @return The field, if found. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
250 */ |
15823 | 251 PurpleRequestField *purple_request_fields_get_field( |
252 const PurpleRequestFields *fields, const char *id); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
253 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
254 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
255 * Returns the string value of a field with the specified ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
256 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
257 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
258 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
259 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
260 * @return The string value, if found, or @c NULL otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
261 */ |
15823 | 262 const char *purple_request_fields_get_string(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
263 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
264 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
265 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
266 * Returns the integer value of a field with the specified ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
267 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
268 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
269 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
270 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
271 * @return The integer value, if found, or 0 otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
272 */ |
15823 | 273 int purple_request_fields_get_integer(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
274 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
275 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
276 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
277 * Returns the boolean value of a field with the specified ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
278 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
279 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
280 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
281 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
282 * @return The boolean value, if found, or @c FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
283 */ |
15823 | 284 gboolean purple_request_fields_get_bool(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
285 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
286 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
287 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
288 * Returns the choice index of a field with the specified ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
289 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
290 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
291 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
292 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
293 * @return The choice index, if found, or -1 otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
294 */ |
15823 | 295 int purple_request_fields_get_choice(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
296 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
297 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
298 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
299 * Returns the account of a field with the specified ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
300 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
301 * @param fields The fields list. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
302 * @param id The ID of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
303 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
304 * @return The account value, if found, or NULL otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
305 */ |
15823 | 306 PurpleAccount *purple_request_fields_get_account(const PurpleRequestFields *fields, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
307 const char *id); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
308 |
32452
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
309 /** |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
310 * Returns the UI data associated with this object. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
311 * |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
312 * @param fields The fields list. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
313 * |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
314 * @return The UI data associated with this object. This is a |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
315 * convenience field provided to the UIs--it is not |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
316 * used by the libuprple core. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
317 */ |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
318 gpointer purple_request_fields_get_ui_data(const PurpleRequestFields *fields); |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
319 |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
320 /** |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
321 * Set the UI data associated with this object. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
322 * |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
323 * @param fields The fields list. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
324 * @param ui_data A pointer to associate with this object. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
325 */ |
32637
5aa171c8776b
Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <mark@kingant.net>
parents:
32614
diff
changeset
|
326 void purple_request_fields_set_ui_data(PurpleRequestFields *fields, gpointer ui_data); |
32452
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
327 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
328 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
329 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
330 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
331 /** @name Fields Group API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
332 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
333 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
334 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
335 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
336 * Creates a fields group with an optional title. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
337 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
338 * @param title The optional title to give the group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
339 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
340 * @return A new fields group |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
341 */ |
15823 | 342 PurpleRequestFieldGroup *purple_request_field_group_new(const char *title); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
343 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
344 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
345 * Destroys a fields group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
346 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
347 * @param group The group to destroy. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
348 */ |
15823 | 349 void purple_request_field_group_destroy(PurpleRequestFieldGroup *group); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
350 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
351 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
352 * Adds a field to the group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
353 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
354 * @param group The group to add the field to. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
355 * @param field The field to add to the group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
356 */ |
15823 | 357 void purple_request_field_group_add_field(PurpleRequestFieldGroup *group, |
358 PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
359 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
360 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
361 * Returns the title of a fields group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
362 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
363 * @param group The group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
364 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
365 * @return The title, if set. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
366 */ |
15823 | 367 const char *purple_request_field_group_get_title( |
368 const PurpleRequestFieldGroup *group); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
369 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
370 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
371 * Returns a list of all fields in a group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
372 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
373 * @param group The group. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
374 * |
20891
59c9c04879af
Replace a bunch of @return markers with @constreturn markers. I believe these
Etan Reisner <pidgin@unreliablesource.net>
parents:
20074
diff
changeset
|
375 * @constreturn The list of fields in the group. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
376 */ |
15823 | 377 GList *purple_request_field_group_get_fields( |
378 const PurpleRequestFieldGroup *group); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
379 |
32452
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
380 /** |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
381 * Returns a list of all fields in a group. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
382 * |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
383 * @param group The group. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
384 * |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
385 * @constreturn The list of fields in the group. |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
386 */ |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
387 PurpleRequestFields *purple_request_field_group_get_fields_list( |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
388 const PurpleRequestFieldGroup *group); |
4a0bc7b7957b
A small bit of hide-a-struct
Mark Doliner <mark@kingant.net>
parents:
32392
diff
changeset
|
389 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
390 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
391 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
392 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
393 /** @name Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
394 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
395 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
396 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
397 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
398 * Creates a field of the specified type. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
399 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
400 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
401 * @param text The text label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
402 * @param type The type of field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
403 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
404 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
405 */ |
15823 | 406 PurpleRequestField *purple_request_field_new(const char *id, const char *text, |
407 PurpleRequestFieldType type); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
408 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
409 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
410 * Destroys a field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
411 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
412 * @param field The field to destroy. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
413 */ |
15823 | 414 void purple_request_field_destroy(PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
415 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
416 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
417 * Sets the label text of a field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
418 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
419 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
420 * @param label The text label. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
421 */ |
15823 | 422 void purple_request_field_set_label(PurpleRequestField *field, const char *label); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
423 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
424 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
425 * Sets whether or not a field is visible. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
426 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
427 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
428 * @param visible TRUE if visible, or FALSE if not. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
429 */ |
15823 | 430 void purple_request_field_set_visible(PurpleRequestField *field, gboolean visible); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
431 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
432 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
433 * Sets the type hint for the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
434 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
435 * This is optionally used by the UIs to provide such features as |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
436 * auto-completion for type hints like "account" and "screenname". |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
437 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
438 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
439 * @param type_hint The type hint. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
440 */ |
15823 | 441 void purple_request_field_set_type_hint(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
442 const char *type_hint); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
443 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
444 /** |
32304
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
445 * Sets the tooltip for the field. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
446 * |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
447 * This is optionally used by the UIs to provide a tooltip for |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
448 * the field. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
449 * |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
450 * @param field The field. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
451 * @param tooltip The tooltip text. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
452 */ |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
453 void purple_request_field_set_tooltip(PurpleRequestField *field, |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
454 const char *tooltip); |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
455 |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
456 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
457 * Sets whether or not a field is required. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
458 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
459 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
460 * @param required TRUE if required, or FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
461 */ |
15823 | 462 void purple_request_field_set_required(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
463 gboolean required); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
464 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
465 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
466 * Returns the type of a field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
467 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
468 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
469 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
470 * @return The field's type. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
471 */ |
15823 | 472 PurpleRequestFieldType purple_request_field_get_type(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
473 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
474 /** |
25328
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
475 * Returns the group for the field. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
476 * |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
477 * @param field The field. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
478 * |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
479 * @return The UI data. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25328
diff
changeset
|
480 * |
25328
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
481 * @since 2.6.0 |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
482 */ |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
483 PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field); |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
484 |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
485 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
486 * Returns the ID of a field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
487 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
488 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
489 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
490 * @return The ID |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
491 */ |
15823 | 492 const char *purple_request_field_get_id(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
493 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
494 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
495 * Returns the label text of a field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
496 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
497 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
498 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
499 * @return The label text. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
500 */ |
15823 | 501 const char *purple_request_field_get_label(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
502 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
503 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
504 * Returns whether or not a field is visible. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
505 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
506 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
507 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
508 * @return TRUE if the field is visible. FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
509 */ |
15823 | 510 gboolean purple_request_field_is_visible(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
511 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
512 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
513 * Returns the field's type hint. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
514 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
515 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
516 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
517 * @return The field's type hint. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
518 */ |
15823 | 519 const char *purple_request_field_get_type_hint(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
520 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
521 /** |
32304
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
522 * Returns the field's tooltip. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
523 * |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
524 * @param field The field. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
525 * |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
526 * @return The field's tooltip. |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
527 */ |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
528 const char *purple_request_field_get_tooltip(const PurpleRequestField *field); |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
529 |
a88631af0f5e
Add API: purple_request_field_set_tooltip & purple_request_field_get_tooltip
andrew.victor@mxit.com
parents:
31533
diff
changeset
|
530 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
531 * Returns whether or not a field is required. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
532 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
533 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
534 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
535 * @return TRUE if the field is required, or FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
536 */ |
15823 | 537 gboolean purple_request_field_is_required(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
538 |
25328
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
539 /** |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
540 * Returns the ui_data for a field. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
541 * |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
542 * @param field The field. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
543 * |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
544 * @return The UI data. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25328
diff
changeset
|
545 * |
25328
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
546 * @since 2.6.0 |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
547 */ |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
548 gpointer purple_request_field_get_ui_data(const PurpleRequestField *field); |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
549 |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
550 /** |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
551 * Sets the ui_data for a field. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
552 * |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
553 * @param field The field. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
554 * @param ui_data The UI data. |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
555 * |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
556 * @return The UI data. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25328
diff
changeset
|
557 * |
25328
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
558 * @since 2.6.0 |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
559 */ |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
560 void purple_request_field_set_ui_data(PurpleRequestField *field, |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
561 gpointer ui_data); |
5d681e194fb3
Hide the PurpleRequestField struct. I figured this one would be easy and
Richard Laager <rlaager@wiktel.com>
parents:
22444
diff
changeset
|
562 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
563 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
564 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
565 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
566 /** @name String Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
567 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
568 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
569 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
570 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
571 * Creates a string request field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
572 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
573 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
574 * @param text The text label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
575 * @param default_value The optional default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
576 * @param multiline Whether or not this should be a multiline string. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
577 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
578 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
579 */ |
15823 | 580 PurpleRequestField *purple_request_field_string_new(const char *id, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
581 const char *text, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
582 const char *default_value, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
583 gboolean multiline); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
584 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
585 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
586 * Sets the default value in a string field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
587 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
588 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
589 * @param default_value The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
590 */ |
15823 | 591 void purple_request_field_string_set_default_value(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
592 const char *default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
593 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
594 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
595 * Sets the value in a string field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
596 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
597 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
598 * @param value The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
599 */ |
15823 | 600 void purple_request_field_string_set_value(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
601 const char *value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
602 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
603 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
604 * Sets whether or not a string field is masked |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
605 * (commonly used for password fields). |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
606 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
607 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
608 * @param masked The masked value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
609 */ |
15823 | 610 void purple_request_field_string_set_masked(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
611 gboolean masked); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
612 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
613 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
614 * Sets whether or not a string field is editable. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
615 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
616 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
617 * @param editable The editable value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
618 */ |
15823 | 619 void purple_request_field_string_set_editable(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
620 gboolean editable); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
621 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
622 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
623 * Returns the default value in a string field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
624 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
625 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
626 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
627 * @return The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
628 */ |
15823 | 629 const char *purple_request_field_string_get_default_value( |
630 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
631 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
632 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
633 * Returns the user-entered value in a string field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
634 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
635 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
636 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
637 * @return The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
638 */ |
15823 | 639 const char *purple_request_field_string_get_value(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
640 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
641 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
642 * Returns whether or not a string field is multi-line. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
643 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
644 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
645 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
646 * @return @c TRUE if the field is mulit-line, or @c FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
647 */ |
15823 | 648 gboolean purple_request_field_string_is_multiline(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
649 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
650 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
651 * Returns whether or not a string field is masked. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
652 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
653 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
654 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
655 * @return @c TRUE if the field is masked, or @c FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
656 */ |
15823 | 657 gboolean purple_request_field_string_is_masked(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
658 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
659 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
660 * Returns whether or not a string field is editable. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
661 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
662 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
663 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
664 * @return @c TRUE if the field is editable, or @c FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
665 */ |
15823 | 666 gboolean purple_request_field_string_is_editable(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
667 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
668 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
669 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
670 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
671 /** @name Integer Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
672 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
673 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
674 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
675 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
676 * Creates an integer field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
677 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
678 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
679 * @param text The text label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
680 * @param default_value The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
681 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
682 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
683 */ |
15823 | 684 PurpleRequestField *purple_request_field_int_new(const char *id, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
685 const char *text, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
686 int default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
687 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
688 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
689 * Sets the default value in an integer field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
690 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
691 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
692 * @param default_value The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
693 */ |
15823 | 694 void purple_request_field_int_set_default_value(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
695 int default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
696 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
697 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
698 * Sets the value in an integer field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
699 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
700 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
701 * @param value The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
702 */ |
15823 | 703 void purple_request_field_int_set_value(PurpleRequestField *field, int value); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
704 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
705 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
706 * Returns the default value in an integer field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
707 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
708 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
709 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
710 * @return The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
711 */ |
15823 | 712 int purple_request_field_int_get_default_value(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
713 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
714 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
715 * Returns the user-entered value in an integer field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
716 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
717 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
718 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
719 * @return The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
720 */ |
15823 | 721 int purple_request_field_int_get_value(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
722 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
723 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
724 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
725 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
726 /** @name Boolean Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
727 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
728 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
729 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
730 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
731 * Creates a boolean field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
732 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
733 * This is often represented as a checkbox. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
734 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
735 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
736 * @param text The text label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
737 * @param default_value The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
738 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
739 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
740 */ |
15823 | 741 PurpleRequestField *purple_request_field_bool_new(const char *id, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
742 const char *text, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
743 gboolean default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
744 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
745 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
746 * Sets the default value in an boolean field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
747 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
748 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
749 * @param default_value The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
750 */ |
15823 | 751 void purple_request_field_bool_set_default_value(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
752 gboolean default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
753 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
754 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
755 * Sets the value in an boolean field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
756 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
757 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
758 * @param value The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
759 */ |
15823 | 760 void purple_request_field_bool_set_value(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
761 gboolean value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
762 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
763 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
764 * Returns the default value in an boolean field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
765 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
766 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
767 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
768 * @return The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
769 */ |
15823 | 770 gboolean purple_request_field_bool_get_default_value( |
771 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
772 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
773 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
774 * Returns the user-entered value in an boolean field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
775 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
776 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
777 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
778 * @return The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
779 */ |
15823 | 780 gboolean purple_request_field_bool_get_value(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
781 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
782 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
783 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
784 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
785 /** @name Choice Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
786 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
787 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
788 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
789 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
790 * Creates a multiple choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
791 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
792 * This is often represented as a group of radio buttons. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
793 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
794 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
795 * @param text The optional label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
796 * @param default_value The default choice. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
797 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
798 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
799 */ |
15823 | 800 PurpleRequestField *purple_request_field_choice_new(const char *id, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
801 const char *text, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
802 int default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
803 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
804 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
805 * Adds a choice to a multiple choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
806 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
807 * @param field The choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
808 * @param label The choice label. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
809 */ |
15823 | 810 void purple_request_field_choice_add(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
811 const char *label); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
812 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
813 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
814 * Sets the default value in an choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
815 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
816 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
817 * @param default_value The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
818 */ |
15823 | 819 void purple_request_field_choice_set_default_value(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
820 int default_value); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
821 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
822 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
823 * Sets the value in an choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
824 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
825 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
826 * @param value The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
827 */ |
15823 | 828 void purple_request_field_choice_set_value(PurpleRequestField *field, int value); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
829 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
830 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
831 * Returns the default value in an choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
832 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
833 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
834 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
835 * @return The default value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
836 */ |
15823 | 837 int purple_request_field_choice_get_default_value(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
838 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
839 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
840 * Returns the user-entered value in an choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
841 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
842 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
843 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
844 * @return The value. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
845 */ |
15823 | 846 int purple_request_field_choice_get_value(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
847 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
848 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
849 * Returns a list of labels in a choice field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
850 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
851 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
852 * |
20891
59c9c04879af
Replace a bunch of @return markers with @constreturn markers. I believe these
Etan Reisner <pidgin@unreliablesource.net>
parents:
20074
diff
changeset
|
853 * @constreturn The list of labels. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
854 */ |
15823 | 855 GList *purple_request_field_choice_get_labels(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
856 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
857 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
858 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
859 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
860 /** @name List Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
861 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
862 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
863 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
864 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
865 * Creates a multiple list item field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
866 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
867 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
868 * @param text The optional label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
869 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
870 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
871 */ |
15823 | 872 PurpleRequestField *purple_request_field_list_new(const char *id, const char *text); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
873 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
874 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
875 * Sets whether or not a list field allows multiple selection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
876 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
877 * @param field The list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
878 * @param multi_select TRUE if multiple selection is enabled, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
879 * or FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
880 */ |
15823 | 881 void purple_request_field_list_set_multi_select(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
882 gboolean multi_select); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
883 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
884 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
885 * Returns whether or not a list field allows multiple selection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
886 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
887 * @param field The list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
888 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
889 * @return TRUE if multiple selection is enabled, or FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
890 */ |
15823 | 891 gboolean purple_request_field_list_get_multi_select( |
892 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
893 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
894 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
895 * Returns the data for a particular item. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
896 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
897 * @param field The list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
898 * @param text The item text. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
899 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
900 * @return The data associated with the item. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
901 */ |
15823 | 902 void *purple_request_field_list_get_data(const PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
903 const char *text); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
904 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
905 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
906 * Adds an item to a list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
907 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
908 * @param field The list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
909 * @param item The list item. |
29822
cc1e35fa774d
Deprecate purple_request_field_list_add()
Richard Laager <rlaager@wiktel.com>
parents:
29821
diff
changeset
|
910 * @param icon_path The path to icon file, or @c NULL for no icon. |
29812
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
911 * @param data The associated data. |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
912 */ |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
913 void purple_request_field_list_add_icon(PurpleRequestField *field, |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
914 const char *item, const char* icon_path, void* data); |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
915 |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
916 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
917 * Adds a selected item to the list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
918 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
919 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
920 * @param item The item to add. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
921 */ |
15823 | 922 void purple_request_field_list_add_selected(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
923 const char *item); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
924 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
925 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
926 * Clears the list of selected items in a list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
927 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
928 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
929 */ |
15823 | 930 void purple_request_field_list_clear_selected(PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
931 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
932 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
933 * Sets a list of selected items in a list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
934 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
935 * @param field The field. |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
936 * @param items The list of selected items, which is not modified or freed. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
937 */ |
15823 | 938 void purple_request_field_list_set_selected(PurpleRequestField *field, |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
939 GList *items); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
940 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
941 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
942 * Returns whether or not a particular item is selected in a list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
943 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
944 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
945 * @param item The item. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
946 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
947 * @return TRUE if the item is selected. FALSE otherwise. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
948 */ |
15823 | 949 gboolean purple_request_field_list_is_selected(const PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
950 const char *item); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
951 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
952 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
953 * Returns a list of selected items in a list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
954 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
955 * To retrieve the data for each item, use |
15823 | 956 * purple_request_field_list_get_data(). |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
957 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
958 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
959 * |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
960 * @constreturn The list of selected items. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
961 */ |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
962 GList *purple_request_field_list_get_selected( |
15823 | 963 const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
964 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
965 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
966 * Returns a list of items in a list field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
967 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
968 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
969 * |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
970 * @constreturn The list of items. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
971 */ |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
16672
diff
changeset
|
972 GList *purple_request_field_list_get_items(const PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
973 |
29812
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
974 /** |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
975 * Returns a list of icons in a list field. |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
976 * |
29821
50dbd779f1bb
Deprecate purple_request_field_list_add() in favor of the new
Richard Laager <rlaager@wiktel.com>
parents:
29814
diff
changeset
|
977 * The icons will correspond with the items, in order. |
50dbd779f1bb
Deprecate purple_request_field_list_add() in favor of the new
Richard Laager <rlaager@wiktel.com>
parents:
29814
diff
changeset
|
978 * |
29812
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
979 * @param field The field. |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
980 * |
29821
50dbd779f1bb
Deprecate purple_request_field_list_add() in favor of the new
Richard Laager <rlaager@wiktel.com>
parents:
29814
diff
changeset
|
981 * @constreturn The list of icons or @c NULL (i.e. the empty GList) if no |
50dbd779f1bb
Deprecate purple_request_field_list_add() in favor of the new
Richard Laager <rlaager@wiktel.com>
parents:
29814
diff
changeset
|
982 * items have icons. |
29812
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
983 */ |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
984 GList *purple_request_field_list_get_icons(const PurpleRequestField *field); |
365b90fa23cf
This patch comes from the combined work of contributors minstrel, NightFox,
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
22444
diff
changeset
|
985 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
986 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
987 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
988 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
989 /** @name Label Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
990 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
991 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
992 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
993 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
994 * Creates a label field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
995 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
996 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
997 * @param text The label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
998 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
999 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1000 */ |
15823 | 1001 PurpleRequestField *purple_request_field_label_new(const char *id, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1002 const char *text); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1003 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1004 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1005 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1006 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1007 /** @name Image Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1008 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1009 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1010 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1011 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1012 * Creates an image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1013 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1014 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1015 * @param text The label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1016 * @param buf The image data. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1017 * @param size The size of the data in @a buffer. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1018 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1019 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1020 */ |
15823 | 1021 PurpleRequestField *purple_request_field_image_new(const char *id, const char *text, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1022 const char *buf, gsize size); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1023 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1024 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1025 * Sets the scale factors of an image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1026 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1027 * @param field The image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1028 * @param x The x scale factor. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1029 * @param y The y scale factor. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1030 */ |
15823 | 1031 void purple_request_field_image_set_scale(PurpleRequestField *field, unsigned int x, unsigned int y); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1032 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1033 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1034 * Returns pointer to the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1035 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1036 * @param field The image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1037 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1038 * @return Pointer to the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1039 */ |
15823 | 1040 const char *purple_request_field_image_get_buffer(PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1041 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1042 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1043 * Returns size (in bytes) of the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1044 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1045 * @param field The image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1046 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1047 * @return Size of the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1048 */ |
15823 | 1049 gsize purple_request_field_image_get_size(PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1050 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1051 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1052 * Returns X scale coefficient of the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1053 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1054 * @param field The image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1055 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1056 * @return X scale coefficient of the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1057 */ |
15823 | 1058 unsigned int purple_request_field_image_get_scale_x(PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1059 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1060 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1061 * Returns Y scale coefficient of the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1062 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1063 * @param field The image field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1064 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1065 * @return Y scale coefficient of the image. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1066 */ |
15823 | 1067 unsigned int purple_request_field_image_get_scale_y(PurpleRequestField *field); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1068 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1069 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1070 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1071 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1072 /** @name Account Field API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1073 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1074 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1075 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1076 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1077 * Creates an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1078 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1079 * By default, this field will not show offline accounts. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1080 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1081 * @param id The field ID. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1082 * @param text The text label of the field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1083 * @param account The optional default account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1084 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1085 * @return The new field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1086 */ |
15823 | 1087 PurpleRequestField *purple_request_field_account_new(const char *id, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1088 const char *text, |
15823 | 1089 PurpleAccount *account); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1090 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1091 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1092 * Sets the default account on an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1093 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1094 * @param field The account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1095 * @param default_value The default account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1096 */ |
15823 | 1097 void purple_request_field_account_set_default_value(PurpleRequestField *field, |
1098 PurpleAccount *default_value); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1099 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1100 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1101 * Sets the account in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1102 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1103 * @param field The account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1104 * @param value The account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1105 */ |
15823 | 1106 void purple_request_field_account_set_value(PurpleRequestField *field, |
1107 PurpleAccount *value); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1108 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1109 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1110 * Sets whether or not to show all accounts in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1111 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1112 * If TRUE, all accounts, online or offline, will be shown. If FALSE, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1113 * only online accounts will be shown. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1114 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1115 * @param field The account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1116 * @param show_all Whether or not to show all accounts. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1117 */ |
15823 | 1118 void purple_request_field_account_set_show_all(PurpleRequestField *field, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1119 gboolean show_all); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1120 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1121 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1122 * Sets the account filter function in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1123 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1124 * This function will determine which accounts get displayed and which |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1125 * don't. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1126 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1127 * @param field The account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1128 * @param filter_func The account filter function. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1129 */ |
15823 | 1130 void purple_request_field_account_set_filter(PurpleRequestField *field, |
1131 PurpleFilterAccountFunc filter_func); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1132 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1133 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1134 * Returns the default account in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1135 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1136 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1137 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1138 * @return The default account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1139 */ |
15823 | 1140 PurpleAccount *purple_request_field_account_get_default_value( |
1141 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1142 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1143 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1144 * Returns the user-entered account in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1145 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1146 * @param field The field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1147 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1148 * @return The user-entered account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1149 */ |
15823 | 1150 PurpleAccount *purple_request_field_account_get_value( |
1151 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1152 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1153 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1154 * Returns whether or not to show all accounts in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1155 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1156 * If TRUE, all accounts, online or offline, will be shown. If FALSE, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1157 * only online accounts will be shown. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1158 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1159 * @param field The account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1160 * @return Whether or not to show all accounts. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1161 */ |
15823 | 1162 gboolean purple_request_field_account_get_show_all( |
1163 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1164 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1165 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1166 * Returns the account filter function in an account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1167 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1168 * This function will determine which accounts get displayed and which |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1169 * don't. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1170 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1171 * @param field The account field. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1172 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1173 * @return The account filter function. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1174 */ |
15823 | 1175 PurpleFilterAccountFunc purple_request_field_account_get_filter( |
1176 const PurpleRequestField *field); | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1177 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1178 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1179 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1180 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1181 /** @name Request API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1182 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1183 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1184 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1185 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1186 * Prompts the user for text input. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1187 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1188 * @param handle The plugin or connection handle. For some |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1189 * things this is <em>extremely</em> important. The |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1190 * handle is used to programmatically close the request |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1191 * dialog when it is no longer needed. For PRPLs this |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1192 * is often a pointer to the #PurpleConnection |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1193 * instance. For plugins this should be a similar, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1194 * unique memory location. This value is important |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1195 * because it allows a request to be closed with |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1196 * purple_request_close_with_handle() when, for |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1197 * example, you sign offline. If the request is |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1198 * <em>not</em> closed it is <strong>very</strong> |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1199 * likely to cause a crash whenever the callback |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1200 * handler functions are triggered. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1201 * @param title The title of the message, or @c NULL if it should have |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1202 * no title. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1203 * @param primary The main point of the message, or @c NULL if you're |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1204 * feeling enigmatic. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1205 * @param secondary Secondary information, or @c NULL if there is none. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1206 * @param default_value The default value. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1207 * @param multiline @c TRUE if the inputted text can span multiple lines. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1208 * @param masked @c TRUE if the inputted text should be masked in some |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1209 * way (such as by displaying characters as stars). This |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1210 * might be because the input is some kind of password. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1211 * @param hint Optionally suggest how the input box should appear. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1212 * Use "html", for example, to allow the user to enter |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1213 * HTML. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1214 * @param ok_text The text for the @c OK button, which may not be @c NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1215 * @param ok_cb The callback for the @c OK button, which may not be @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1216 * NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1217 * @param cancel_text The text for the @c Cancel button, which may not be @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1218 * NULL. |
21874
c2af0701d9cc
cancel_cb can be NULL here too.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21873
diff
changeset
|
1219 * @param cancel_cb The callback for the @c Cancel button, which may be |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1220 * @c NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1221 * @param account The #PurpleAccount associated with this request, or @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1222 * NULL if none is. |
21873
5e23a3d7efef
I'm happy to report that my spelling is coming along in leanps and nbounds.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21872
diff
changeset
|
1223 * @param who The username of the buddy associated with this request, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1224 * or @c NULL if none is. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1225 * @param conv The #PurpleConversation associated with this request, or |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1226 * @c NULL if none is. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1227 * @param user_data The data to pass to the callback. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1228 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1229 * @return A UI-specific handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1230 */ |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1231 void *purple_request_input(void *handle, const char *title, const char *primary, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1232 const char *secondary, const char *default_value, gboolean multiline, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1233 gboolean masked, gchar *hint, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1234 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1235 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1236 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1237 void *user_data); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1238 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1239 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1240 * Prompts the user for multiple-choice input. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1241 * |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1242 * @param handle The plugin or connection handle. For some things this |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1243 * is <em>extremely</em> important. See the comments on |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1244 * purple_request_input(). |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1245 * @param title The title of the message, or @c NULL if it should have |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1246 * no title. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1247 * @param primary The main point of the message, or @c NULL if you're |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1248 * feeling enigmatic. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1249 * @param secondary Secondary information, or @c NULL if there is none. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1250 * @param default_value The default choice; this should be one of the values |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1251 * listed in the varargs. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1252 * @param ok_text The text for the @c OK button, which may not be @c NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1253 * @param ok_cb The callback for the @c OK button, which may not be @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1254 * NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1255 * @param cancel_text The text for the @c Cancel button, which may not be @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1256 * NULL. |
21872
050218f87c21
Sadrul informs me that cancel_cb may in fact be NULL.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21869
diff
changeset
|
1257 * @param cancel_cb The callback for the @c Cancel button, or @c NULL to |
050218f87c21
Sadrul informs me that cancel_cb may in fact be NULL.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21869
diff
changeset
|
1258 * do nothing. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1259 * @param account The #PurpleAccount associated with this request, or @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1260 * NULL if none is. |
21873
5e23a3d7efef
I'm happy to report that my spelling is coming along in leanps and nbounds.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21872
diff
changeset
|
1261 * @param who The username of the buddy associated with this request, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1262 * or @c NULL if none is. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1263 * @param conv The #PurpleConversation associated with this request, or |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1264 * @c NULL if none is. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1265 * @param user_data The data to pass to the callback. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1266 * @param ... The choices, which should be pairs of <tt>char *</tt> |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1267 * descriptions and <tt>int</tt> values, terminated with a |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1268 * @c NULL parameter. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1269 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1270 * @return A UI-specific handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1271 */ |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1272 void *purple_request_choice(void *handle, const char *title, const char *primary, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1273 const char *secondary, int default_value, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1274 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1275 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1276 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1277 void *user_data, ...) G_GNUC_NULL_TERMINATED; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1278 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1279 /** |
22444
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
1280 * <tt>va_list</tt> version of purple_request_choice(); see its documentation. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1281 */ |
15823 | 1282 void *purple_request_choice_varg(void *handle, const char *title, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1283 const char *primary, const char *secondary, int default_value, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1284 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1285 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1286 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1287 void *user_data, va_list choices); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1288 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1289 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1290 * Prompts the user for an action. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1291 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1292 * This is often represented as a dialog with a button for each action. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1293 * |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1294 * @param handle The plugin or connection handle. For some things this |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1295 * is <em>extremely</em> important. See the comments on |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1296 * purple_request_input(). |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1297 * @param title The title of the message, or @c NULL if it should have |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1298 * no title. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1299 * @param primary The main point of the message, or @c NULL if you're |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1300 * feeling enigmatic. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1301 * @param secondary Secondary information, or @c NULL if there is none. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1302 * @param default_action The default action, zero-indexed; if the third action |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1303 * supplied should be the default, supply <tt>2</tt>. |
22136
9df0a8c7c9b7
* Clarify the documentation for purple_request_action's 'default_ation'
Mark Doliner <mark@kingant.net>
parents:
21874
diff
changeset
|
1304 * The should be the action that users are most likely |
9df0a8c7c9b7
* Clarify the documentation for purple_request_action's 'default_ation'
Mark Doliner <mark@kingant.net>
parents:
21874
diff
changeset
|
1305 * to select. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1306 * @param account The #PurpleAccount associated with this request, or @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1307 * NULL if none is. |
21873
5e23a3d7efef
I'm happy to report that my spelling is coming along in leanps and nbounds.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21872
diff
changeset
|
1308 * @param who The username of the buddy associated with this request, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1309 * or @c NULL if none is. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1310 * @param conv The #PurpleConversation associated with this request, or |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1311 * @c NULL if none is. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1312 * @param user_data The data to pass to the callback. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1313 * @param action_count The number of actions. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1314 * @param ... A list of actions. These are pairs of |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1315 * arguments. The first of each pair is the |
22444
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
1316 * <tt>char *</tt> label that appears on the button. It |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
1317 * should have an underscore before the letter you want |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
1318 * to use as the accelerator key for the button. The |
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
1319 * second of each pair is the #PurpleRequestActionCb |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1320 * function to use when the button is clicked. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1321 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1322 * @return A UI-specific handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1323 */ |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1324 void *purple_request_action(void *handle, const char *title, const char *primary, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1325 const char *secondary, int default_action, PurpleAccount *account, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1326 const char *who, PurpleConversation *conv, void *user_data, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1327 size_t action_count, ...); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1328 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1329 /** |
22444
6cfb6e26787f
Remove duplicated docs for _varg variants of request functions; correct and
Will Thompson <will.thompson@collabora.co.uk>
parents:
22136
diff
changeset
|
1330 * <tt>va_list</tt> version of purple_request_action(); see its documentation. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1331 */ |
15823 | 1332 void *purple_request_action_varg(void *handle, const char *title, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1333 const char *primary, const char *secondary, int default_action, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1334 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1335 void *user_data, size_t action_count, va_list actions); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1336 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1337 /** |
31533
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1338 * Version of purple_request_action() supplying an image for the UI to |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1339 * optionally display as an icon in the dialog; see its documentation |
30255
2a1e4a000e87
ChangeLog new functionallity
Marcus Lundblad <ml@update.uu.se>
parents:
30249
diff
changeset
|
1340 * @since 2.7.0 |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1341 */ |
31533
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1342 void *purple_request_action_with_icon(void *handle, const char *title, |
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1343 const char *primary, const char *secondary, int default_action, |
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1344 PurpleAccount *account, const char *who, PurpleConversation *conv, |
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1345 gconstpointer icon_data, gsize icon_size, void *user_data, |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1346 size_t action_count, ...); |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1347 |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1348 /** |
31533
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1349 * <tt>va_list</tt> version of purple_request_action_with_icon(); |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1350 * see its documentation. |
30255
2a1e4a000e87
ChangeLog new functionallity
Marcus Lundblad <ml@update.uu.se>
parents:
30249
diff
changeset
|
1351 * @since 2.7.0 |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1352 */ |
30265
e72f6383095b
It seems like the _varg should be at the end.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
30255
diff
changeset
|
1353 void *purple_request_action_with_icon_varg(void *handle, const char *title, |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1354 const char *primary, const char *secondary, int default_action, |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1355 PurpleAccount *account, const char *who, PurpleConversation *conv, |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1356 gconstpointer icon_data, gsize icon_size, |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1357 void *user_data, size_t action_count, va_list actions); |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1358 |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1359 |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1360 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1361 * Displays groups of fields for the user to fill in. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1362 * |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1363 * @param handle The plugin or connection handle. For some things this |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1364 * is <em>extremely</em> important. See the comments on |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1365 * purple_request_input(). |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1366 * @param title The title of the message, or @c NULL if it should have |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1367 * no title. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1368 * @param primary The main point of the message, or @c NULL if you're |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1369 * feeling enigmatic. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1370 * @param secondary Secondary information, or @c NULL if there is none. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1371 * @param fields The list of fields. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1372 * @param ok_text The text for the @c OK button, which may not be @c NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1373 * @param ok_cb The callback for the @c OK button, which may not be @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1374 * NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1375 * @param cancel_text The text for the @c Cancel button, which may not be @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1376 * NULL. |
21874
c2af0701d9cc
cancel_cb can be NULL here too.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21873
diff
changeset
|
1377 * @param cancel_cb The callback for the @c Cancel button, which may be |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1378 * @c NULL. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1379 * @param account The #PurpleAccount associated with this request, or @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1380 * NULL if none is |
21873
5e23a3d7efef
I'm happy to report that my spelling is coming along in leanps and nbounds.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21872
diff
changeset
|
1381 * @param who The username of the buddy associated with this request, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1382 * or @c NULL if none is |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1383 * @param conv The #PurpleConversation associated with this request, or |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1384 * @c NULL if none is |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1385 * @param user_data The data to pass to the callback. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1386 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1387 * @return A UI-specific handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1388 */ |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1389 void *purple_request_fields(void *handle, const char *title, const char *primary, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1390 const char *secondary, PurpleRequestFields *fields, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1391 const char *ok_text, GCallback ok_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1392 const char *cancel_text, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1393 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1394 void *user_data); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1395 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1396 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1397 * Closes a request. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1398 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1399 * @param type The request type. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1400 * @param uihandle The request UI handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1401 */ |
15823 | 1402 void purple_request_close(PurpleRequestType type, void *uihandle); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1403 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1404 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1405 * Closes all requests registered with the specified handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1406 * |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1407 * @param handle The handle, as supplied as the @a handle parameter to one of the |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1408 * <tt>purple_request_*</tt> functions. |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1409 * |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1410 * @see purple_request_input(). |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1411 */ |
15823 | 1412 void purple_request_close_with_handle(void *handle); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1413 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1414 /** |
15823 | 1415 * A wrapper for purple_request_action() that uses @c Yes and @c No buttons. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1416 */ |
20598
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1417 #define purple_request_yes_no(handle, title, primary, secondary, \ |
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1418 default_action, account, who, conv, \ |
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1419 user_data, yes_cb, no_cb) \ |
15823 | 1420 purple_request_action((handle), (title), (primary), (secondary), \ |
20598
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1421 (default_action), account, who, conv, (user_data), 2, \ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1422 _("_Yes"), (yes_cb), _("_No"), (no_cb)) |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1423 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1424 /** |
15823 | 1425 * A wrapper for purple_request_action() that uses @c OK and @c Cancel buttons. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1426 */ |
20598
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1427 #define purple_request_ok_cancel(handle, title, primary, secondary, \ |
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1428 default_action, account, who, conv, \ |
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1429 user_data, ok_cb, cancel_cb) \ |
15823 | 1430 purple_request_action((handle), (title), (primary), (secondary), \ |
20598
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1431 (default_action), account, who, conv, (user_data), 2, \ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1432 _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb)) |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1433 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1434 /** |
15823 | 1435 * A wrapper for purple_request_action() that uses Accept and Cancel buttons. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1436 */ |
20598
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1437 #define purple_request_accept_cancel(handle, title, primary, secondary, \ |
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1438 default_action, account, who, conv, \ |
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1439 user_data, accept_cb, cancel_cb) \ |
15823 | 1440 purple_request_action((handle), (title), (primary), (secondary), \ |
20598
285bb637a2b7
Updated hinting to be less invasive
Gabriel Schulhof <nix@go-nix.ca>
parents:
20597
diff
changeset
|
1441 (default_action), account, who, conv, (user_data), 2, \ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1442 _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb)) |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1443 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1444 /** |
31533
44f53d3fc54f
Remove trailing whitespace
Richard Laager <rlaager@wiktel.com>
parents:
30265
diff
changeset
|
1445 * A wrapper for purple_request_action_with_icon() that uses Accept and Cancel |
30205
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1446 * buttons. |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1447 */ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1448 #define purple_request_accept_cancel_with_icon(handle, title, primary, secondary, \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1449 default_action, account, who, conv, \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1450 icon_data, icon_size, \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1451 user_data, accept_cb, cancel_cb) \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1452 purple_request_action_with_icon((handle), (title), (primary), (secondary), \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1453 (default_action), account, who, conv, icon_data, icon_size, \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1454 (user_data), 2, \ |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1455 _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb)) |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1456 |
d0588e403877
Show thumbnail in ft request dialog
Marcus Lundblad <ml@update.uu.se>
parents:
25412
diff
changeset
|
1457 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1458 * Displays a file selector request dialog. Returns the selected filename to |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1459 * the callback. Can be used for either opening a file or saving a file. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1460 * |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1461 * @param handle The plugin or connection handle. For some things this |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1462 * is <em>extremely</em> important. See the comments on |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1463 * purple_request_input(). |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1464 * @param title The title of the message, or @c NULL if it should have |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1465 * no title. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1466 * @param filename The default filename (may be @c NULL) |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1467 * @param savedialog True if this dialog is being used to save a file. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1468 * False if it is being used to open a file. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1469 * @param ok_cb The callback for the @c OK button. |
21874
c2af0701d9cc
cancel_cb can be NULL here too.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21873
diff
changeset
|
1470 * @param cancel_cb The callback for the @c Cancel button, which may be @c NULL. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1471 * @param account The #PurpleAccount associated with this request, or @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1472 * NULL if none is |
21873
5e23a3d7efef
I'm happy to report that my spelling is coming along in leanps and nbounds.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21872
diff
changeset
|
1473 * @param who The username of the buddy associated with this request, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1474 * or @c NULL if none is |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1475 * @param conv The #PurpleConversation associated with this request, or |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1476 * @c NULL if none is |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1477 * @param user_data The data to pass to the callback. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1478 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1479 * @return A UI-specific handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1480 */ |
15823 | 1481 void *purple_request_file(void *handle, const char *title, const char *filename, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1482 gboolean savedialog, GCallback ok_cb, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1483 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1484 void *user_data); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1485 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1486 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1487 * Displays a folder select dialog. Returns the selected filename to |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1488 * the callback. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1489 * |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1490 * @param handle The plugin or connection handle. For some things this |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1491 * is <em>extremely</em> important. See the comments on |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1492 * purple_request_input(). |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1493 * @param title The title of the message, or @c NULL if it should have |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1494 * no title. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1495 * @param dirname The default directory name (may be @c NULL) |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1496 * @param ok_cb The callback for the @c OK button. |
21874
c2af0701d9cc
cancel_cb can be NULL here too.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21873
diff
changeset
|
1497 * @param cancel_cb The callback for the @c Cancel button, which may be @c NULL. |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1498 * @param account The #PurpleAccount associated with this request, or @c |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1499 * NULL if none is |
21873
5e23a3d7efef
I'm happy to report that my spelling is coming along in leanps and nbounds.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21872
diff
changeset
|
1500 * @param who The username of the buddy associated with this request, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1501 * or @c NULL if none is |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1502 * @param conv The #PurpleConversation associated with this request, or |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1503 * @c NULL if none is |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1504 * @param user_data The data to pass to the callback. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1505 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1506 * @return A UI-specific handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1507 */ |
15823 | 1508 void *purple_request_folder(void *handle, const char *title, const char *dirname, |
21869
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1509 GCallback ok_cb, GCallback cancel_cb, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1510 PurpleAccount *account, const char *who, PurpleConversation *conv, |
a92574a57460
Documentation tweaks and more g_return_if_fail checks for NULL parameters which
Will Thompson <will.thompson@collabora.co.uk>
parents:
21567
diff
changeset
|
1511 void *user_data); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1512 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1513 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1514 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1515 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1516 /** @name UI Registration Functions */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1517 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1518 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1519 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1520 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1521 * Sets the UI operations structure to be used when displaying a |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1522 * request. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1523 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1524 * @param ops The UI operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1525 */ |
15823 | 1526 void purple_request_set_ui_ops(PurpleRequestUiOps *ops); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1527 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1528 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1529 * Returns the UI operations structure to be used when displaying a |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1530 * request. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1531 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1532 * @return The UI operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1533 */ |
15823 | 1534 PurpleRequestUiOps *purple_request_get_ui_ops(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1535 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1536 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1537 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1538 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1539 } |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1540 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1541 |
15823 | 1542 #endif /* _PURPLE_REQUEST_H_ */ |