libpurple/notify.h

Fri, 31 Jan 2014 18:46:39 +0530

author
Ankit Vani <a@nevitus.org>
date
Fri, 31 Jan 2014 18:46:39 +0530
branch
soc.2013.gobjectification.plugins
changeset 37037
c391f5d677e4
parent 37035
e85ed7f4d6e3
parent 35394
38facb8226d4
child 37040
91119588bc3a
permissions
-rw-r--r--

Merge gtkdoc-conversion

5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /**
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2 * @file notify.h Notification API
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 * @ingroup core
20889
3d0ef192f98c All the links to libpurple signal pages were in the comment containing the
Will Thompson <resiak@pidgin.im>
parents: 20355
diff changeset
4 * @see @ref notify-signals
20147
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19868
diff changeset
5 */
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19868
diff changeset
6
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19868
diff changeset
7 /* purple
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
9 * Purple is the legal property of its developers, whose names are too numerous
8046
c581b20a47d6 [gaim-migrate @ 8730]
Sean Egan <seanegan@pidgin.im>
parents: 7035
diff changeset
10 * to list here. Please refer to the COPYRIGHT file distributed with this
c581b20a47d6 [gaim-migrate @ 8730]
Sean Egan <seanegan@pidgin.im>
parents: 7035
diff changeset
11 * source distribution.
6465
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
12 *
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 * This program is free software; you can redistribute it and/or modify
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 * it under the terms of the GNU General Public License as published by
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 * the Free Software Foundation; either version 2 of the License, or
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 * (at your option) any later version.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 *
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 * This program is distributed in the hope that it will be useful,
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 * GNU General Public License for more details.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 *
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 * You should have received a copy of the GNU General Public License
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 * along with this program; if not, write to the Free Software
19859
71d37b57eff2 The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 18412
diff changeset
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
27 #ifndef _PURPLE_NOTIFY_H_
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
28 #define _PURPLE_NOTIFY_H_
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 #include <stdlib.h>
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 #include <glib-object.h>
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 #include <glib.h>
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
34 typedef struct _PurpleNotifyUserInfoEntry PurpleNotifyUserInfoEntry;
34793
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
35
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
36 #define PURPLE_TYPE_NOTIFY_USER_INFO (purple_notify_user_info_get_type())
32691
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
37 typedef struct _PurpleNotifyUserInfo PurpleNotifyUserInfo;
34793
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
38
32691
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
39 /** @copydoc _PurpleNotifySearchColumn */
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
40 typedef struct _PurpleNotifySearchColumn PurpleNotifySearchColumn;
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
41
9797
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
42 #include "connection.h"
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
43 #include "request.h"
9797
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
44
32691
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
45
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 /**
12242
e7fc1748eb56 [gaim-migrate @ 14544]
Richard Laager <rlaager@pidgin.im>
parents: 12220
diff changeset
47 * Notification close callbacks.
e7fc1748eb56 [gaim-migrate @ 14544]
Richard Laager <rlaager@pidgin.im>
parents: 12220
diff changeset
48 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
49 typedef void (*PurpleNotifyCloseCallback) (gpointer user_data);
12242
e7fc1748eb56 [gaim-migrate @ 14544]
Richard Laager <rlaager@pidgin.im>
parents: 12220
diff changeset
50
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
51
12242
e7fc1748eb56 [gaim-migrate @ 14544]
Richard Laager <rlaager@pidgin.im>
parents: 12220
diff changeset
52 /**
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
53 * Notification types.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 */
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55 typedef enum
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
57 PURPLE_NOTIFY_MESSAGE = 0, /**< Message notification. */
36433
Ankit Vani <a@nevitus.org>
parents: 34795
diff changeset
58 PURPLE_NOTIFY_EMAIL, /**< Single email notification. */
Ankit Vani <a@nevitus.org>
parents: 34795
diff changeset
59 PURPLE_NOTIFY_EMAILS, /**< Multiple email notification. */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
60 PURPLE_NOTIFY_FORMATTED, /**< Formatted text. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
61 PURPLE_NOTIFY_SEARCHRESULTS, /**< Buddy search results. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
62 PURPLE_NOTIFY_USERINFO, /**< Formatted userinfo text. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
63 PURPLE_NOTIFY_URI /**< URI notification or display. */
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
65 } PurpleNotifyType;
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
66
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
67
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68 /**
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
69 * Notification message types.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
70 */
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
71 typedef enum
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
72 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
73 PURPLE_NOTIFY_MSG_ERROR = 0, /**< Error notification. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
74 PURPLE_NOTIFY_MSG_WARNING, /**< Warning notification. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
75 PURPLE_NOTIFY_MSG_INFO /**< Information notification. */
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
76
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
77 } PurpleNotifyMsgType;
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
79
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80 /**
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
81 * The types of buttons
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
82 */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
83 typedef enum
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
84 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
85 PURPLE_NOTIFY_BUTTON_LABELED = 0, /**< special use, see _button_add_labeled */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
86 PURPLE_NOTIFY_BUTTON_CONTINUE = 1,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
87 PURPLE_NOTIFY_BUTTON_ADD,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
88 PURPLE_NOTIFY_BUTTON_INFO,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
89 PURPLE_NOTIFY_BUTTON_IM,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
90 PURPLE_NOTIFY_BUTTON_JOIN,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
91 PURPLE_NOTIFY_BUTTON_INVITE
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
92 } PurpleNotifySearchButtonType;
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
93
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
94
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
95 /**
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
96 * Search results object.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
97 */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
98 typedef struct
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
99 {
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
100 GList *columns; /**< List of the search column objects. */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
101 GList *rows; /**< List of rows in the result. */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
102 GList *buttons; /**< List of buttons to display. */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
103
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
104 } PurpleNotifySearchResults;
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
105
15211
bb75b7bc10a8 [gaim-migrate @ 17935]
Evan Schoenberg <evands@pidgin.im>
parents: 15205
diff changeset
106 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
107 * Types of PurpleNotifyUserInfoEntry objects
15211
bb75b7bc10a8 [gaim-migrate @ 17935]
Evan Schoenberg <evands@pidgin.im>
parents: 15205
diff changeset
108 */
bb75b7bc10a8 [gaim-migrate @ 17935]
Evan Schoenberg <evands@pidgin.im>
parents: 15205
diff changeset
109 typedef enum
bb75b7bc10a8 [gaim-migrate @ 17935]
Evan Schoenberg <evands@pidgin.im>
parents: 15205
diff changeset
110 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
111 PURPLE_NOTIFY_USER_INFO_ENTRY_PAIR = 0,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
112 PURPLE_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
113 PURPLE_NOTIFY_USER_INFO_ENTRY_SECTION_HEADER
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
114 } PurpleNotifyUserInfoEntryType;
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
115
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
116
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
117
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
118 /**
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
119 * Callback for a button in a search result.
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
120 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
121 * @c: the PurpleConnection passed to purple_notify_searchresults
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
122 * @row: the contents of the selected row
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
123 * @user_data: User defined data.
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
124 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
125 typedef void (*PurpleNotifySearchResultsCallback)(PurpleConnection *c, GList *row,
13641
1173f8ca3fbf [gaim-migrate @ 16038]
Bartosz Oler <bartosz@pidgin.im>
parents: 12647
diff changeset
126 gpointer user_data);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
127
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
128
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
129 /**
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
130 * Definition of a button.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
131 */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
132 typedef struct
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
133 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
134 PurpleNotifySearchButtonType type;
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
135 PurpleNotifySearchResultsCallback callback; /**< Function to be called when clicked. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
136 char *label; /**< only for PURPLE_NOTIFY_BUTTON_LABELED */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
137 } PurpleNotifySearchButton;
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
138
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
139
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
140 /**
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
141 * Notification UI operations.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
142 */
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
143 typedef struct
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
144 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
145 void *(*notify_message)(PurpleNotifyMsgType type, const char *title,
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
146 const char *primary, const char *secondary,
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
147 PurpleRequestCommonParameters *cpar);
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
148
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
149 void *(*notify_email)(PurpleConnection *gc,
12647
b00d9913117e [gaim-migrate @ 14985]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12625
diff changeset
150 const char *subject, const char *from,
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
151 const char *to, const char *url);
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
152
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
153 void *(*notify_emails)(PurpleConnection *gc,
12647
b00d9913117e [gaim-migrate @ 14985]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12625
diff changeset
154 size_t count, gboolean detailed,
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
155 const char **subjects, const char **froms,
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
156 const char **tos, const char **urls);
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
157
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
158 void *(*notify_formatted)(const char *title, const char *primary,
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
159 const char *secondary, const char *text);
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
160
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
161 void *(*notify_searchresults)(PurpleConnection *gc, const char *title,
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
162 const char *primary, const char *secondary,
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
163 PurpleNotifySearchResults *results, gpointer user_data);
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
164
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
165 void (*notify_searchresults_new_rows)(PurpleConnection *gc,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
166 PurpleNotifySearchResults *results,
13641
1173f8ca3fbf [gaim-migrate @ 16038]
Bartosz Oler <bartosz@pidgin.im>
parents: 12647
diff changeset
167 void *data);
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
168
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
169 void *(*notify_userinfo)(PurpleConnection *gc, const char *who,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
170 PurpleNotifyUserInfo *user_info);
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
171
10240
09342bc554d9 [gaim-migrate @ 11377]
Herman Bloggs <herman@bluedigits.com>
parents: 10209
diff changeset
172 void *(*notify_uri)(const char *uri);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
173
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
174 void (*close_notify)(PurpleNotifyType type, void *ui_handle);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
175
35024
eb3afb7643ce Added /*< private >*/ for padding members, clean them up and add missing ones
Ankit Vani <a@nevitus.org>
parents: 34956
diff changeset
176 /*< private >*/
16743
1ce5ffe12e2a Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15997
diff changeset
177 void (*_purple_reserved1)(void);
1ce5ffe12e2a Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15997
diff changeset
178 void (*_purple_reserved2)(void);
1ce5ffe12e2a Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15997
diff changeset
179 void (*_purple_reserved3)(void);
1ce5ffe12e2a Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15997
diff changeset
180 void (*_purple_reserved4)(void);
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
181 } PurpleNotifyUiOps;
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
182
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
183
32787
7072f190d6ad Use G_BEGIN/END_DECLS in public libpurple files. This was
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32691
diff changeset
184 G_BEGIN_DECLS
5944
f19df037ac58 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5522
diff changeset
185
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
186
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
187 /**************************************************************************/
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
188 /** Search results notification API */
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
189 /**************************************************************************/
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
190 /*@{*/
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
191
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
192 /**
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
193 * Displays results from a buddy search. This can be, for example,
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
194 * a window with a list of all found buddies, where you are given the
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
195 * option of adding buddies to your buddy list.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
196 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
197 * @gc: The PurpleConnection handle associated with the information.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
198 * @title: The title of the message. If this is NULL, the title
12259
23c20f8ffbef [gaim-migrate @ 14561]
Richard Laager <rlaager@pidgin.im>
parents: 12257
diff changeset
199 * will be "Search Results."
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
200 * @primary: The main point of the message.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
201 * @secondary: The secondary information.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
202 * @results: The PurpleNotifySearchResults instance.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
203 * @cb: The callback to call when the user closes
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
204 * the notification.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
205 * @user_data: The data to pass to the close callback and any other
13641
1173f8ca3fbf [gaim-migrate @ 16038]
Bartosz Oler <bartosz@pidgin.im>
parents: 12647
diff changeset
206 * callback associated with a button.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
207 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
208 * Returns: A UI-specific handle.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
209 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
210 void *purple_notify_searchresults(PurpleConnection *gc, const char *title,
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
211 const char *primary, const char *secondary,
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
212 PurpleNotifySearchResults *results, PurpleNotifyCloseCallback cb,
12220
2eecc6f28334 [gaim-migrate @ 14522]
Bartosz Oler <bartosz@pidgin.im>
parents: 12129
diff changeset
213 gpointer user_data);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
214
19868
af326d8f70b1 This function wasn't documented in the Doxygen stuff. If I've documented
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 19859
diff changeset
215 /**
af326d8f70b1 This function wasn't documented in the Doxygen stuff. If I've documented
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 19859
diff changeset
216 * Frees a PurpleNotifySearchResults object.
af326d8f70b1 This function wasn't documented in the Doxygen stuff. If I've documented
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 19859
diff changeset
217 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
218 * @results: The PurpleNotifySearchResults to free.
19868
af326d8f70b1 This function wasn't documented in the Doxygen stuff. If I've documented
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 19859
diff changeset
219 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
220 void purple_notify_searchresults_free(PurpleNotifySearchResults *results);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
221
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
222 /**
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
223 * Replace old rows with the new. Reuse an existing window.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
224 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
225 * @gc: The PurpleConnection structure.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
226 * @results: The PurpleNotifySearchResults structure.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
227 * @data: Data returned by the purple_notify_searchresults().
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
228 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
229 void purple_notify_searchresults_new_rows(PurpleConnection *gc,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
230 PurpleNotifySearchResults *results,
13641
1173f8ca3fbf [gaim-migrate @ 16038]
Bartosz Oler <bartosz@pidgin.im>
parents: 12647
diff changeset
231 void *data);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
232
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
233
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
234 /**
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
235 * Adds a stock button that will be displayed in the search results dialog.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
236 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
237 * @results: The search results object.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
238 * @type: Type of the button. (TODO: Only one button of a given type
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
239 * can be displayed.)
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
240 * @cb: Function that will be called on the click event.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
241 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
242 void purple_notify_searchresults_button_add(PurpleNotifySearchResults *results,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
243 PurpleNotifySearchButtonType type,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
244 PurpleNotifySearchResultsCallback cb);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
245
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
246
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
247 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
248 * Adds a plain labelled button that will be displayed in the search results
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
249 * dialog.
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
250 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
251 * @results: The search results object
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
252 * @label: The label to display
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
253 * @cb: Function that will be called on the click event
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
254 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
255 void purple_notify_searchresults_button_add_labeled(PurpleNotifySearchResults *results,
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
256 const char *label,
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
257 PurpleNotifySearchResultsCallback cb);
12624
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
258
c1c92f08976b [gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents: 12323
diff changeset
259
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
260 /**
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
261 * Returns a newly created search results object.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
262 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
263 * Returns: The new search results object.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
264 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
265 PurpleNotifySearchResults *purple_notify_searchresults_new(void);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
266
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
267 /**
31698
12d88a8ea37d Document the default explicitly
Paul Aurich <darkrain42@pidgin.im>
parents: 31696
diff changeset
268 * Returns a newly created search result column object. The column defaults
12d88a8ea37d Document the default explicitly
Paul Aurich <darkrain42@pidgin.im>
parents: 31696
diff changeset
269 * to being visible.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
270 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
271 * @title: Title of the column. NOTE: Title will get g_strdup()ed.
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
272 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
273 * Returns: The new search column object.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
274 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
275 PurpleNotifySearchColumn *purple_notify_searchresults_column_new(const char *title);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
276
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
277 /**
32691
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
278 * Returns the title of the column
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
279 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
280 * @column: The search column object.
32691
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
281 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
282 * Returns: The title of the column
32691
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
283 */
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
284 const char *purple_notify_searchresult_column_get_title(const PurpleNotifySearchColumn *column);
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
285
d6eb58903f8b Hide struct PurpleNotifySearchColumn.
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
286 /**
31696
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
287 * Sets whether or not a search result column is visible.
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
288 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
289 * @column: The search column object.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
290 * @visible: TRUE if visible, or FALSE if not.
31696
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
291 */
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
292 void purple_notify_searchresult_column_set_visible(PurpleNotifySearchColumn *column, gboolean visible);
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
293
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
294 /**
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
295 * Returns whether or not a search result column is visible.
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
296 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
297 * @column: The search column object.
31696
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
298 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
299 * Returns: TRUE if the search result column is visible. FALSE otherwise.
31696
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
300 */
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
301 gboolean purple_notify_searchresult_column_is_visible(const PurpleNotifySearchColumn *column);
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
302
67d180e0f68d Add API:
Andrew Victor <andrew.victor@mxit.com>
parents: 30537
diff changeset
303 /**
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
304 * Adds a new column to the search result object.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
305 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
306 * @results: The result object to which the column will be added.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
307 * @column: The column that will be added to the result object.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
308 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
309 void purple_notify_searchresults_column_add(PurpleNotifySearchResults *results,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
310 PurpleNotifySearchColumn *column);
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
311
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
312 /**
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
313 * Adds a new row of the results to the search results object.
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
314 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
315 * @results: The search results object.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
316 * @row: The row of the results.
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
317 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
318 void purple_notify_searchresults_row_add(PurpleNotifySearchResults *results,
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
319 GList *row);
25893
77f655480a0f Slap some PURPLE_DISABLE_DEPRECATED checks around the functions Mark just
Richard Laager <rlaager@pidgin.im>
parents: 25890
diff changeset
320
11359
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
321 /*@}*/
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
322
9630f62029f2 [gaim-migrate @ 13581]
Bartosz Oler <bartosz@pidgin.im>
parents: 10566
diff changeset
323 /**************************************************************************/
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
324 /** @name Notification API */
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
325 /**************************************************************************/
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
326 /*@{*/
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
327
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
328 /**
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
329 * Displays a notification message to the user.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
330 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
331 * @handle: The plugin or connection handle.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
332 * @type: The notification type.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
333 * @title: The title of the message.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
334 * @primary: The main point of the message.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
335 * @secondary: The secondary information.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
336 * @cpar: The #PurpleRequestCommonParameters associated with this
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
337 * request, or %NULL if none is.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
338 * @cb: The callback to call when the user closes
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
339 * the notification.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
340 * @user_data: The data to pass to the callback.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
341 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
342 * Returns: A UI-specific handle.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
343 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
344 void *purple_notify_message(void *handle, PurpleNotifyMsgType type,
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
345 const char *title, const char *primary, const char *secondary,
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
346 PurpleRequestCommonParameters *cpar, PurpleNotifyCloseCallback cb,
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
347 gpointer user_data);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
348
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
349 /**
23325
a374a26fe217 Use "email" and "Email" consistently. This is potentially controversial,
Richard Laager <rlaager@pidgin.im>
parents: 22762
diff changeset
350 * Displays a single email notification to the user.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
351 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
352 * @handle: The plugin or connection handle.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
353 * @subject: The subject of the email.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
354 * @from: The from address.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
355 * @to: The destination address.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
356 * @url: The URL where the message can be read.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
357 * @cb: The callback to call when the user closes
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
358 * the notification.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
359 * @user_data: The data to pass to the callback.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
360 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
361 * Returns: A UI-specific handle.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
362 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
363 void *purple_notify_email(void *handle, const char *subject,
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
364 const char *from, const char *to,
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
365 const char *url, PurpleNotifyCloseCallback cb,
12220
2eecc6f28334 [gaim-migrate @ 14522]
Bartosz Oler <bartosz@pidgin.im>
parents: 12129
diff changeset
366 gpointer user_data);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
367
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
368 /**
23325
a374a26fe217 Use "email" and "Email" consistently. This is potentially controversial,
Richard Laager <rlaager@pidgin.im>
parents: 22762
diff changeset
369 * Displays a notification for multiple emails to the user.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
370 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
371 * @handle: The plugin or connection handle.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
372 * @count: The number of emails. '0' can be used to signify that
27346
6779a6dbb742 Clarify this. This count gets passed around a lot of places... I'm
Mark Doliner <markdoliner@pidgin.im>
parents: 25893
diff changeset
373 * the user has no unread emails and the UI should remove
6779a6dbb742 Clarify this. This count gets passed around a lot of places... I'm
Mark Doliner <markdoliner@pidgin.im>
parents: 25893
diff changeset
374 * the mail notification.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
375 * @detailed: %TRUE if there is information for each email in the
5522
faa69c8f503d [gaim-migrate @ 5922]
Christian Hammond <chipx86@chipx86.com>
parents: 5497
diff changeset
376 * arrays.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
377 * @subjects: The array of subjects.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
378 * @froms: The array of from addresses.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
379 * @tos: The array of destination addresses.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
380 * @urls: The URLs where the messages can be read.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
381 * @cb: The callback to call when the user closes
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
382 * the notification.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
383 * @user_data: The data to pass to the callback.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
384 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
385 * Returns: A UI-specific handle.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
386 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
387 void *purple_notify_emails(void *handle, size_t count, gboolean detailed,
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
388 const char **subjects, const char **froms,
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
389 const char **tos, const char **urls,
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
390 PurpleNotifyCloseCallback cb, gpointer user_data);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
391
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
392 /**
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
393 * Displays a notification with formatted text.
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
394 *
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
395 * The text is essentially a stripped-down format of HTML, the same that
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
396 * IMs may send.
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
397 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
398 * @handle: The plugin or connection handle.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
399 * @title: The title of the message.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
400 * @primary: The main point of the message.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
401 * @secondary: The secondary information.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
402 * @text: The formatted text.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
403 * @cb: The callback to call when the user closes
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
404 * the notification.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
405 * @user_data: The data to pass to the callback.
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
406 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
407 * Returns: A UI-specific handle.
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
408 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
409 void *purple_notify_formatted(void *handle, const char *title,
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
410 const char *primary, const char *secondary,
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
411 const char *text, PurpleNotifyCloseCallback cb, gpointer user_data);
6381
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
412
53203c44c731 [gaim-migrate @ 6886]
Christian Hammond <chipx86@chipx86.com>
parents: 6356
diff changeset
413 /**
9800
1115830011b8 [gaim-migrate @ 10668]
Mark Doliner <markdoliner@pidgin.im>
parents: 9797
diff changeset
414 * Displays user information with formatted text, passing information giving
1115830011b8 [gaim-migrate @ 10668]
Mark Doliner <markdoliner@pidgin.im>
parents: 9797
diff changeset
415 * the connection and username from which the user information came.
9797
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
416 *
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
417 * The text is essentially a stripped-down format of HTML, the same that
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
418 * IMs may send.
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
419 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
420 * @gc: The PurpleConnection handle associated with the information.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
421 * @who: The username associated with the information.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
422 * @user_info: The PurpleNotifyUserInfo which contains the information
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
423 * @cb: The callback to call when the user closes the notification.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
424 * @user_data: The data to pass to the callback.
9797
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
425 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
426 * Returns: A UI-specific handle.
9797
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
427 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
428 void *purple_notify_userinfo(PurpleConnection *gc, const char *who,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
429 PurpleNotifyUserInfo *user_info, PurpleNotifyCloseCallback cb,
12220
2eecc6f28334 [gaim-migrate @ 14522]
Bartosz Oler <bartosz@pidgin.im>
parents: 12129
diff changeset
430 gpointer user_data);
9797
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
431
b69f82378b7b [gaim-migrate @ 10665]
Evan Schoenberg <evands@pidgin.im>
parents: 8046
diff changeset
432 /**
34793
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
433 * Returns the GType for the PurpleNotifyUserInfo boxed structure.
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
434 */
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
435 GType purple_notify_user_info_get_type(void);
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
436
07f8ceb4e690 Added GBoxed for PurpleNotifyUserInfo
Ankit Vani <a@nevitus.org>
parents: 32787
diff changeset
437 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
438 * Create a new PurpleNotifyUserInfo which is suitable for passing to
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
439 * purple_notify_userinfo()
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
440 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
441 * Returns: A new PurpleNotifyUserInfo, which the caller must destroy when done
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
442 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
443 PurpleNotifyUserInfo *purple_notify_user_info_new(void);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
444
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
445 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
446 * Destroy a PurpleNotifyUserInfo
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
447 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
448 * @user_info: The PurpleNotifyUserInfo
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
449 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
450 void purple_notify_user_info_destroy(PurpleNotifyUserInfo *user_info);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
451
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
452 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
453 * Retrieve the array of PurpleNotifyUserInfoEntry objects from a
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
454 * PurpleNotifyUserInfo
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
455 *
32193
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
456 * This GQueue may be manipulated directly with normal GQueue functions such
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
457 * as g_queue_push_tail(). Only PurpleNotifyUserInfoEntry are allowed in the
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
458 * queue. If a PurpleNotifyUserInfoEntry item is added to the queue, it
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
459 * should not be freed by the caller; PurpleNotifyUserInfo will free it when
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
460 * destroyed.
15328
113b0b520010 [gaim-migrate @ 18056]
Evan Schoenberg <evands@pidgin.im>
parents: 15325
diff changeset
461 *
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
462 * To remove a PurpleNotifyUserInfoEntry, use
32193
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
463 * purple_notify_user_info_remove_entry(). Do not use the GQueue directly.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
464 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
465 * @user_info: The PurpleNotifyUserInfo
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
466 *
35394
38facb8226d4 Use 'transfer none' for TODO const
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
467 * Returns: (transfer none): A GQueue of PurpleNotifyUserInfoEntry objects.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
468 */
32193
42173d1c1317 Change PurpleNotifyUserInfo->user_info_entries from a GList to a GQueue.
Mark Doliner <markdoliner@pidgin.im>
parents: 32191
diff changeset
469 GQueue *purple_notify_user_info_get_entries(PurpleNotifyUserInfo *user_info);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
470
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
471 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
472 * Create a textual representation of a PurpleNotifyUserInfo, separating
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
473 * entries with newline
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
474 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
475 * @user_info: The PurpleNotifyUserInfo
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
476 * @newline: The separation character
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
477 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
478 char *purple_notify_user_info_get_text_with_newline(PurpleNotifyUserInfo *user_info, const char *newline);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
479
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
480 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
481 * Add a label/value pair to a PurpleNotifyUserInfo object.
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
482 * PurpleNotifyUserInfo keeps track of the order in which pairs are added.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
483 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
484 * @user_info: The PurpleNotifyUserInfo
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
485 * @label: A label, which for example might be displayed by a
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
486 * UI with a colon after it ("Status:"). Do not include
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
487 * a colon. If NULL, value will be displayed without a
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
488 * label.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
489 * @value: The value, which might be displayed by a UI after
30537
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
490 * the label. This should be valid HTML. If you want
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
491 * to insert plaintext then use
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
492 * purple_notify_user_info_add_pair_plaintext(), instead.
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
493 * If this is NULL the label will still be displayed;
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
494 * the UI should treat label as independent and not
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
495 * include a colon if it would otherwise.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
496 */
32191
a4668d9dc8d1 Rename purple_notify_user_info_add_pair to
Mark Doliner <markdoliner@pidgin.im>
parents: 32143
diff changeset
497 void purple_notify_user_info_add_pair_html(PurpleNotifyUserInfo *user_info, const char *label, const char *value);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
498
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
499 /**
32191
a4668d9dc8d1 Rename purple_notify_user_info_add_pair to
Mark Doliner <markdoliner@pidgin.im>
parents: 32143
diff changeset
500 * Like purple_notify_user_info_add_pair_html, but value should be plaintext
30537
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
501 * and will be escaped using g_markup_escape_text().
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
502 */
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
503 void purple_notify_user_info_add_pair_plaintext(PurpleNotifyUserInfo *user_info, const char *label, const char *value);
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
504
9f833935ecd7 Add a purple_notify_user_info_add_pair_plaintext function that accepts a
Mark Doliner <markdoliner@pidgin.im>
parents: 27346
diff changeset
505 /**
32204
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
506 * Like purple_notify_user_info_add_pair_html, but the pair is inserted
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
507 * at the beginning of the list.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
508 */
32204
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
509 void purple_notify_user_info_prepend_pair_html(PurpleNotifyUserInfo *user_info, const char *label, const char *value);
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
510
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
511 /**
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
512 * Like purple_notify_user_info_prepend_pair_html, but value should be plaintext
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
513 * and will be escaped using g_markup_escape_text().
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
514 */
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
515 void purple_notify_user_info_prepend_pair_plaintext(PurpleNotifyUserInfo *user_info, const char *label, const char *value);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
516
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
517 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
518 * Remove a PurpleNotifyUserInfoEntry from a PurpleNotifyUserInfo object
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
519 * without freeing the entry.
15328
113b0b520010 [gaim-migrate @ 18056]
Evan Schoenberg <evands@pidgin.im>
parents: 15325
diff changeset
520 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
521 * @user_info: The PurpleNotifyUserInfo
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
522 * @user_info_entry: The PurpleNotifyUserInfoEntry
15328
113b0b520010 [gaim-migrate @ 18056]
Evan Schoenberg <evands@pidgin.im>
parents: 15325
diff changeset
523 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
524 void purple_notify_user_info_remove_entry(PurpleNotifyUserInfo *user_info, PurpleNotifyUserInfoEntry *user_info_entry);
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
525
15328
113b0b520010 [gaim-migrate @ 18056]
Evan Schoenberg <evands@pidgin.im>
parents: 15325
diff changeset
526 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
527 * Create a new PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
528 *
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
529 * If added to a PurpleNotifyUserInfo object, this should not be free()'d,
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
530 * as PurpleNotifyUserInfo will do so when destroyed.
32191
a4668d9dc8d1 Rename purple_notify_user_info_add_pair to
Mark Doliner <markdoliner@pidgin.im>
parents: 32143
diff changeset
531 * purple_notify_user_info_add_pair_html(),
32204
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
532 * purple_notify_user_info_add_pair_plaintext(),
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
533 * purple_notify_user_info_prepend_pair_html() and
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
534 * purple_notify_user_info_prepend_pair_plaintext() are convenience
2a09624616c3 Actually commit the purple_notify_user_info_prepend_pair_plaintext
Mark Doliner <markdoliner@pidgin.im>
parents: 32193
diff changeset
535 * methods for creating entries and adding them to a PurpleNotifyUserInfo.
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
536 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
537 * @label: A label, which for example might be displayed by a UI
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
538 * with a colon after it ("Status:"). Do not include a
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
539 * colon. If NULL, value will be displayed without a label.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
540 * @value: The value, which might be displayed by a UI after the
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
541 * label. If NULL, label will still be displayed; the UI
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
542 * should then treat label as independent and not include a
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
543 * colon if it would otherwise.
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
544 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
545 * @result A new PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
546 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
547 PurpleNotifyUserInfoEntry *purple_notify_user_info_entry_new(const char *label, const char *value);
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
548
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
549 /**
34795
979a2d8fb770 Made purple_notify_user_info_entry_destroy() public, so entries can be free'd after calling remove_entry
Ankit Vani <a@nevitus.org>
parents: 34793
diff changeset
550 * Destroy a PurpleNotifyUserInfoEntry
979a2d8fb770 Made purple_notify_user_info_entry_destroy() public, so entries can be free'd after calling remove_entry
Ankit Vani <a@nevitus.org>
parents: 34793
diff changeset
551 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
552 * @user_info_entry: The PurpleNotifyUserInfoEntry
34795
979a2d8fb770 Made purple_notify_user_info_entry_destroy() public, so entries can be free'd after calling remove_entry
Ankit Vani <a@nevitus.org>
parents: 34793
diff changeset
553 */
979a2d8fb770 Made purple_notify_user_info_entry_destroy() public, so entries can be free'd after calling remove_entry
Ankit Vani <a@nevitus.org>
parents: 34793
diff changeset
554 void purple_notify_user_info_entry_destroy(PurpleNotifyUserInfoEntry *user_info_entry);
979a2d8fb770 Made purple_notify_user_info_entry_destroy() public, so entries can be free'd after calling remove_entry
Ankit Vani <a@nevitus.org>
parents: 34793
diff changeset
555
979a2d8fb770 Made purple_notify_user_info_entry_destroy() public, so entries can be free'd after calling remove_entry
Ankit Vani <a@nevitus.org>
parents: 34793
diff changeset
556 /**
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
557 * Add a section break. A UI might display this as a horizontal line.
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
558 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
559 * @user_info: The PurpleNotifyUserInfo
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
560 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
561 void purple_notify_user_info_add_section_break(PurpleNotifyUserInfo *user_info);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
562
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
563 /**
23346
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
564 * Prepend a section break. A UI might display this as a horizontal line.
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
565 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
566 * @user_info: The PurpleNotifyUserInfo
23346
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
567 */
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
568 void purple_notify_user_info_prepend_section_break(PurpleNotifyUserInfo *user_info);
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
569
23346
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
570 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
571 * Add a section header. A UI might display this in a different font
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
572 * from other text.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
573 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
574 * @user_info: The PurpleNotifyUserInfo
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
575 * @label: The name of the section
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
576 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
577 void purple_notify_user_info_add_section_header(PurpleNotifyUserInfo *user_info, const char *label);
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
578
23346
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
579 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
580 * Prepend a section header. A UI might display this in a different font
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
581 * from other text.
23346
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
582 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
583 * @user_info: The PurpleNotifyUserInfo
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
584 * @label: The name of the section
23346
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
585 */
fceca7f4710f Added prepend functions for notify_user_info section headers and breaks
Evan Schoenberg <evands@pidgin.im>
parents: 23325
diff changeset
586 void purple_notify_user_info_prepend_section_header(PurpleNotifyUserInfo *user_info, const char *label);
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
587
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
588 /**
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
589 * Remove the last item which was added to a PurpleNotifyUserInfo. This
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
590 * could be used to remove a section header which is not needed.
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
591 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
592 void purple_notify_user_info_remove_last_item(PurpleNotifyUserInfo *user_info);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
593
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
594 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
595 * Get the label for a PurpleNotifyUserInfoEntry
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
596 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
597 * @user_info_entry: The PurpleNotifyUserInfoEntry
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
598 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
599 * Returns: The label
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
600 */
22762
7f13bec07bad constify the return value from purple_notify_user_info_entry_get_label
Mark Doliner <markdoliner@pidgin.im>
parents: 21453
diff changeset
601 const gchar *purple_notify_user_info_entry_get_label(PurpleNotifyUserInfoEntry *user_info_entry);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
602
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
603 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
604 * Set the label for a PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
605 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
606 * @user_info_entry: The PurpleNotifyUserInfoEntry
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
607 * @label: The label
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
608 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
609 void purple_notify_user_info_entry_set_label(PurpleNotifyUserInfoEntry *user_info_entry, const char *label);
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
610
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
611 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
612 * Get the value for a PurpleNotifyUserInfoEntry
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
613 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
614 * @user_info_entry: The PurpleNotifyUserInfoEntry
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
615 *
24702
55805ee6a45b Remove stray whitespace and wrap the function comments at less than 80
Mark Doliner <markdoliner@pidgin.im>
parents: 24569
diff changeset
616 * @result The value
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
617 */
22762
7f13bec07bad constify the return value from purple_notify_user_info_entry_get_label
Mark Doliner <markdoliner@pidgin.im>
parents: 21453
diff changeset
618 const gchar *purple_notify_user_info_entry_get_value(PurpleNotifyUserInfoEntry *user_info_entry);
15205
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
619
f642029b2f97 [gaim-migrate @ 17929]
Evan Schoenberg <evands@pidgin.im>
parents: 14254
diff changeset
620 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
621 * Set the value for a PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
622 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
623 * @user_info_entry: The PurpleNotifyUserInfoEntry
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
624 * @value: The value
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
625 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
626 void purple_notify_user_info_entry_set_value(PurpleNotifyUserInfoEntry *user_info_entry, const char *value);
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
627
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
628
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
629 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
630 * Get the type of a PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
631 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
632 * @user_info_entry: The PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
633 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
634 * Returns: The PurpleNotifyUserInfoEntryType
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
635 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
636 PurpleNotifyUserInfoEntryType purple_notify_user_info_entry_get_type(PurpleNotifyUserInfoEntry *user_info_entry);
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
637
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
638 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
639 * Set the type of a PurpleNotifyUserInfoEntry
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
640 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
641 * @user_info_entry: The PurpleNotifyUserInfoEntry
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
642 * @type: The PurpleNotifyUserInfoEntryType
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
643 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
644 void purple_notify_user_info_entry_set_type(PurpleNotifyUserInfoEntry *user_info_entry,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
645 PurpleNotifyUserInfoEntryType type);
15325
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
646
d1dcb41d845b [gaim-migrate @ 18053]
Evan Schoenberg <evands@pidgin.im>
parents: 15215
diff changeset
647 /**
6465
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
648 * Opens a URI or somehow presents it to the user.
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
649 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
650 * @handle: The plugin or connection handle.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
651 * @uri: The URI to display or go to.
6465
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
652 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
653 * Returns: A UI-specific handle, if any. This may only be presented if
6465
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
654 * the UI code displays a dialog instead of a webpage, or something
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
655 * similar.
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
656 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
657 void *purple_notify_uri(void *handle, const char *uri);
6465
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
658
bd201d637ff4 [gaim-migrate @ 6974]
Christian Hammond <chipx86@chipx86.com>
parents: 6381
diff changeset
659 /**
34451
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
660 * Checks, if passed UI handle is valid.
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
661 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
662 * @ui_handle: The UI handle.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
663 * @type: The pointer to variable, where request type may be stored
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
664 * (may be %NULL).
34451
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
665 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
666 * Returns: TRUE, if handle is valid, FALSE otherwise.
34451
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
667 */
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
668 gboolean
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
669 purple_notify_is_valid_ui_handle(void *ui_handle, PurpleNotifyType *type);
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
670
b7165d4e1d73 Implement purple_*_is_valid_ui_handle, purple_request_cpar_*et_parent_from, pidgin_request_get_dialog_window
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34449
diff changeset
671 /**
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
672 * Closes a notification.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
673 *
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
674 * This should be used only by the UI operation functions and part of the
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
675 * core.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
676 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
677 * @type: The notification type.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
678 * @ui_handle: The notification UI handle.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
679 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
680 void purple_notify_close(PurpleNotifyType type, void *ui_handle);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
681
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
682 /**
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
683 * Closes all notifications registered with the specified handle.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
684 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
685 * @handle: The handle.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
686 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
687 void purple_notify_close_with_handle(void *handle);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
688
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
689 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
690 * A wrapper for purple_notify_message that displays an information message.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
691 */
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
692 #define purple_notify_info(handle, title, primary, secondary, cpar) \
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
693 purple_notify_message((handle), PURPLE_NOTIFY_MSG_INFO, (title), \
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
694 (primary), (secondary), (cpar), NULL, NULL)
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
695
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
696 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
697 * A wrapper for purple_notify_message that displays a warning message.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
698 */
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
699 #define purple_notify_warning(handle, title, primary, secondary, cpar) \
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
700 purple_notify_message((handle), PURPLE_NOTIFY_MSG_WARNING, (title), \
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
701 (primary), (secondary), (cpar), NULL, NULL)
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
702
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
703 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
704 * A wrapper for purple_notify_message that displays an error message.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
705 */
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
706 #define purple_notify_error(handle, title, primary, secondary, cpar) \
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
707 purple_notify_message((handle), PURPLE_NOTIFY_MSG_ERROR, (title), \
34449
bbcb198650b7 Notify API: extend purple_notify_message with PurpleRequestCommonParameters
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 32787
diff changeset
708 (primary), (secondary), (cpar), NULL, NULL)
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
709
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
710 /*@}*/
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
711
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
712 /**************************************************************************/
10566
b681d2b3dec5 [gaim-migrate @ 11949]
Etan Reisner <deryni@pidgin.im>
parents: 10443
diff changeset
713 /** @name UI Registration Functions */
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
714 /**************************************************************************/
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
715 /*@{*/
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
716
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
717 /**
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
718 * Sets the UI operations structure to be used when displaying a
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
719 * notification.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
720 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
721 * @ops: The UI operations structure.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
722 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
723 void purple_notify_set_ui_ops(PurpleNotifyUiOps *ops);
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
724
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
725 /**
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
726 * Returns the UI operations structure to be used when displaying a
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
727 * notification.
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
728 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
729 * Returns: The UI operations structure.
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
730 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
731 PurpleNotifyUiOps *purple_notify_get_ui_ops(void);
5944
f19df037ac58 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5522
diff changeset
732
5497
da3c08f3af25 [gaim-migrate @ 5893]
Mark Doliner <markdoliner@pidgin.im>
parents: 5476
diff changeset
733 /*@}*/
5437
4bd5c5d271e6 [gaim-migrate @ 5819]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
734
12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
735 /**************************************************************************/
36433
Ankit Vani <a@nevitus.org>
parents: 34795
diff changeset
736 /** @name Notify Subsystem */
12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
737 /**************************************************************************/
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
738 /*@{*/
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
739
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
740 /**
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
741 * Returns the notify subsystem handle.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
742 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
743 * Returns: The notify subsystem handle.
12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
744 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
745 void *purple_notify_get_handle(void);
12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
746
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
747 /**
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
748 * Initializes the notify subsystem.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
749 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
750 void purple_notify_init(void);
12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
751
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
752 /**
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
753 * Uninitializes the notify subsystem.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
754 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
755 void purple_notify_uninit(void);
12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
756
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
757 /*@}*/
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
758
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents: 11533
diff changeset
759
32787
7072f190d6ad Use G_BEGIN/END_DECLS in public libpurple files. This was
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32691
diff changeset
760 G_END_DECLS
5944
f19df037ac58 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5522
diff changeset
761
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
762 #endif /* _PURPLE_NOTIFY_H_ */

mercurial