annotate libpurple/whiteboard.h @ 32768:50cd80d3554e

Add a purple_connection_update_last_received() function to update the PurpleConnection->last_received value.
author andrew.victor@mxit.com
date Tue, 18 Oct 2011 20:25:41 +0000
parents 5aa171c8776b
children 46177ee4af40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
1 /**
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
2 * @file whiteboard.h The PurpleWhiteboard core object
20074
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19680
diff changeset
3 */
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19680
diff changeset
4
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19680
diff changeset
5 /* purple
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
6 *
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
7 * Purple is the legal property of its developers, whose names are too numerous
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
8 * to list here. Please refer to the COPYRIGHT file distributed with this
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
9 * source distribution.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
10 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
11 * This program is free software; you can redistribute it and/or modify
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
12 * it under the terms of the GNU General Public License as published by
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
13 * the Free Software Foundation; either version 2 of the License, or
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
14 * (at your option) any later version.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
15 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
16 * This program is distributed in the hope that it will be useful,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
19 * GNU General Public License for more details.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
20 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
21 * You should have received a copy of the GNU General Public License
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
22 * along with this program; if not, write to the Free Software
19680
44b4e8bd759b The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 16672
diff changeset
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
24 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
25
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
26 #ifndef _PURPLE_WHITEBOARD_H_
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
27 #define _PURPLE_WHITEBOARD_H_
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
28
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
29 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
30 * Whiteboard PRPL Operations
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
31 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
32 typedef struct _PurpleWhiteboardPrplOps PurpleWhiteboardPrplOps;
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
33
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
34 #include "account.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
35
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
36 /**
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
37 * A PurpleWhiteboard
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
38 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
39 typedef struct _PurpleWhiteboard
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
40 {
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
41 int state; /**< State of whiteboard session */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
42
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
43 PurpleAccount *account; /**< Account associated with this session */
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
44 char *who; /**< Name of the remote user */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
45
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
46 void *ui_data; /**< Graphical user-interface data */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
47 void *proto_data; /**< Protocol specific data */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
48 PurpleWhiteboardPrplOps *prpl_ops; /**< Protocol-plugin operations */
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
49
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
50 GList *draw_list; /**< List of drawing elements/deltas to send */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
51 } PurpleWhiteboard;
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
52
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
53 /**
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
54 * The PurpleWhiteboard UI Operations
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
55 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
56 typedef struct _PurpleWhiteboardUiOps
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
57 {
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
58 void (*create)(PurpleWhiteboard *wb); /**< create function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
59 void (*destroy)(PurpleWhiteboard *wb); /**< destory function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
60 void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height); /**< set_dimensions function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
61 void (*set_brush) (PurpleWhiteboard *wb, int size, int color); /**< set the size and color of the brush */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
62 void (*draw_point)(PurpleWhiteboard *wb, int x, int y,
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
63 int color, int size); /**< draw_point function */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
64 void (*draw_line)(PurpleWhiteboard *wb, int x1, int y1,
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
65 int x2, int y2,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
66 int color, int size); /**< draw_line function */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
67 void (*clear)(PurpleWhiteboard *wb); /**< clear function */
16672
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
68
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
69 void (*_purple_reserved1)(void);
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
70 void (*_purple_reserved2)(void);
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
71 void (*_purple_reserved3)(void);
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
72 void (*_purple_reserved4)(void);
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
73 } PurpleWhiteboardUiOps;
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
74
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
75 /**
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
76 * PurpleWhiteboard PRPL Operations
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
77 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
78 struct _PurpleWhiteboardPrplOps
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
79 {
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
80 void (*start)(PurpleWhiteboard *wb); /**< start function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
81 void (*end)(PurpleWhiteboard *wb); /**< end function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
82 void (*get_dimensions)(const PurpleWhiteboard *wb, int *width, int *height); /**< get_dimensions function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
83 void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height); /**< set_dimensions function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
84 void (*get_brush) (const PurpleWhiteboard *wb, int *size, int *color); /**< get the brush size and color */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
85 void (*set_brush) (PurpleWhiteboard *wb, int size, int color); /**< set the brush size and color */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
86 void (*send_draw_list)(PurpleWhiteboard *wb, GList *draw_list); /**< send_draw_list function */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
87 void (*clear)(PurpleWhiteboard *wb); /**< clear function */
16672
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
88
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
89 void (*_purple_reserved1)(void);
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
90 void (*_purple_reserved2)(void);
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
91 void (*_purple_reserved3)(void);
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 15823
diff changeset
92 void (*_purple_reserved4)(void);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
93 };
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
94
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
95 #ifdef __cplusplus
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
96 extern "C" {
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
97 #endif /* __cplusplus */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
98
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
99 /******************************************************************************/
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
100 /** @name PurpleWhiteboard API */
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
101 /******************************************************************************/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
102 /*@{*/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
103
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
104 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
105 * Sets the UI operations
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
106 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
107 * @param ops The UI operations to set
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
108 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
109 void purple_whiteboard_set_ui_ops(PurpleWhiteboardUiOps *ops);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
110
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
111 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
112 * Sets the prpl operations for a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
113 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
114 * @param wb The whiteboard for which to set the prpl operations
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
115 * @param ops The prpl operations to set
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
116 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
117 void purple_whiteboard_set_prpl_ops(PurpleWhiteboard *wb, PurpleWhiteboardPrplOps *ops);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
118
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
119 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
120 * Creates a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
121 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
122 * @param account The account.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
123 * @param who Who you're drawing with.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
124 * @param state The state.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
125 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
126 * @return The new whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
127 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
128 PurpleWhiteboard *purple_whiteboard_create(PurpleAccount *account, const char *who, int state);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
129
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
130 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
131 * Destroys a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
132 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
133 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
134 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
135 void purple_whiteboard_destroy(PurpleWhiteboard *wb);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
136
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
137 /**
32464
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
138 * Returns the whiteboard's account.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
139 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
140 * @param wb The whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
141 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
142 * @return The whiteboard's account.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
143 */
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
144 PurpleAccount *purple_whiteboard_get_account(const PurpleWhiteboard *wb);
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
145
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
146 /**
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
147 * Return who you're drawing with.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
148 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
149 * @param wb The whiteboard
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
150 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
151 * @return Who you're drawing with.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
152 */
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
153 const char *purple_whiteboard_get_who(const PurpleWhiteboard *wb);
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
154
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
155 /**
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
156 * Set the state of the whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
157 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
158 * @param wb The whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
159 * @param state The state
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
160 */
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
161 void purple_whiteboard_set_state(PurpleWhiteboard *wb, int state);
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
162
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
163 /**
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
164 * Return the state of the whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
165 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
166 * @param wb The whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
167 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
168 * @return The state of the whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
169 */
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
170 int purple_whiteboard_get_state(const PurpleWhiteboard *wb);
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
171
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
172 /**
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
173 * Starts a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
174 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
175 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
176 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
177 void purple_whiteboard_start(PurpleWhiteboard *wb);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
178
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
179 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
180 * Finds a whiteboard from an account and user.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
181 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
182 * @param account The account.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
183 * @param who The user.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
184 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
185 * @return The whiteboard if found, otherwise @c NULL.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
186 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
187 PurpleWhiteboard *purple_whiteboard_get_session(const PurpleAccount *account, const char *who);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
188
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
189 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
190 * Destorys a drawing list for a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
191 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
192 * @param draw_list The drawing list.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
193 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
194 void purple_whiteboard_draw_list_destroy(GList *draw_list);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
195
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
196 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
197 * Gets the dimension of a whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
198 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
199 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
200 * @param width The width to be set.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
201 * @param height The height to be set.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
202 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
203 * @return TRUE if the values of width and height were set.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
204 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
205 gboolean purple_whiteboard_get_dimensions(const PurpleWhiteboard *wb, int *width, int *height);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
206
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
207 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
208 * Sets the dimensions for a whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
209 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
210 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
211 * @param width The width.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
212 * @param height The height.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
213 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
214 void purple_whiteboard_set_dimensions(PurpleWhiteboard *wb, int width, int height);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
215
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
216 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
217 * Draws a point on a whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
218 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
219 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
220 * @param x The x coordinate.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
221 * @param y The y coordinate.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
222 * @param color The color to use.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
223 * @param size The brush size.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
224 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
225 void purple_whiteboard_draw_point(PurpleWhiteboard *wb, int x, int y, int color, int size);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
226
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
227 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
228 * Send a list of points to draw to the buddy.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
229 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
230 * @param wb The whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
231 * @param list A GList of points
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
232 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
233 void purple_whiteboard_send_draw_list(PurpleWhiteboard *wb, GList *list);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
234
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
235 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
236 * Draws a line on a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
237 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
238 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
239 * @param x1 The top-left x coordinate.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
240 * @param y1 The top-left y coordinate.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
241 * @param x2 The bottom-right x coordinate.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
242 * @param y2 The bottom-right y coordinate.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
243 * @param color The color to use.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
244 * @param size The brush size.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
245 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
246 void purple_whiteboard_draw_line(PurpleWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
247
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
248 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
249 * Clears a whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
250 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
251 * @param wb The whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
252 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
253 void purple_whiteboard_clear(PurpleWhiteboard *wb);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
254
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
255 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
256 * Sends a request to the buddy to clear the whiteboard.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
257 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
258 * @param wb The whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
259 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
260 void purple_whiteboard_send_clear(PurpleWhiteboard *wb);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
261
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
262 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
263 * Sends a request to change the size and color of the brush.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
264 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
265 * @param wb The whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
266 * @param size The size of the brush
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
267 * @param color The color of the brush
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
268 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
269 void purple_whiteboard_send_brush(PurpleWhiteboard *wb, int size, int color);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
270
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
271 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
272 * Gets the size and color of the brush.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
273 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
274 * @param wb The whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
275 * @param size The size of the brush
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
276 * @param color The color of the brush
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
277 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
278 * @return TRUE if the size and color were set.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
279 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
280 gboolean purple_whiteboard_get_brush(const PurpleWhiteboard *wb, int *size, int *color);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
281
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
282 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
283 * Sets the size and color of the brush.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
284 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
285 * @param wb The whiteboard
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
286 * @param size The size of the brush
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
287 * @param color The color of the brush
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
288 */
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
289 void purple_whiteboard_set_brush(PurpleWhiteboard *wb, int size, int color);
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
290
32461
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
291 /**
32464
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
292 * Return the drawing list.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
293 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
294 * @param wb The whiteboard.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
295 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
296 * @return The drawing list
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
297 */
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
298 GList *purple_whiteboard_get_draw_list(const PurpleWhiteboard *wb);
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
299
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
300 /**
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
301 * Set the drawing list.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
302 *
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
303 * @param wb The whiteboard
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
304 * @param draw_list The drawing list.
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
305 */
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
306 void purple_whiteboard_set_draw_list(PurpleWhiteboard *wb, GList* draw_list);
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
307
2bf260b86086 Add additional accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 32461
diff changeset
308 /**
32461
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
309 * Sets the protocol data for a whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
310 *
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
311 * @param wb The whiteboard.
32637
5aa171c8776b Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <mark@kingant.net>
parents: 32464
diff changeset
312 * @param proto_data The protocol data to set for the whiteboard.
32461
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
313 */
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
314 void purple_whiteboard_set_protocol_data(PurpleWhiteboard *wb, gpointer proto_data);
32637
5aa171c8776b Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <mark@kingant.net>
parents: 32464
diff changeset
315
32461
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
316 /**
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
317 * Gets the protocol data for a whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
318 *
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
319 * @param wb The whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
320 *
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
321 * @return The protocol data for the whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
322 */
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
323 gpointer purple_whiteboard_get_protocol_data(const PurpleWhiteboard *wb);
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
324
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
325 /**
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
326 * Set the UI data associated with this whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
327 *
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
328 * @param wb The whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
329 * @param ui_data A pointer to associate with this whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
330 */
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
331 void purple_whiteboard_set_ui_data(PurpleWhiteboard *wb, gpointer ui_data);
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
332
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
333 /**
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
334 * Get the UI data associated with this whiteboard.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
335 *
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
336 * @param wb The whiteboard..
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
337 *
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
338 * @return The UI data associated with this whiteboard. This is a
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
339 * convenience field provided to the UIs--it is not
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
340 * used by the libpurple core.
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
341 */
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
342 gpointer purple_whiteboard_get_ui_data(const PurpleWhiteboard *wb);
cea77667da7d Added protocol_data and ui_data accessor functions for Whiteboard.
andrew.victor@mxit.com
parents: 20074
diff changeset
343
15374
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
344 /*@}*/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
345
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
346 #ifdef __cplusplus
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
347 }
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
348 #endif /* __cplusplus */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
349
15823
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15548
diff changeset
350 #endif /* _PURPLE_WHITEBOARD_H_ */