comparison src/whiteboard.h @ 12022:9d562dde0a3a

[gaim-migrate @ 14315] Whiteboard cleanup from sadrul. This also adds the ability to set the brush to the core. I noticed that none of the whiteboard stuff is in Changelog.API yet but I'm about to go to bed and am too lazy to do it right now. committer: Tailor Script <tailor@pidgin.im>
author Daniel Atallah <daniel.atallah@gmail.com>
date Wed, 09 Nov 2005 04:42:42 +0000
parents 2219f4bf4a57
children eaf7c8558914
comparison
equal deleted inserted replaced
12021:1a86417abfc8 12022:9d562dde0a3a
55 typedef struct _GaimWhiteboardUiOps 55 typedef struct _GaimWhiteboardUiOps
56 { 56 {
57 void (*create)(GaimWhiteboard *wb); /**< create function */ 57 void (*create)(GaimWhiteboard *wb); /**< create function */
58 void (*destroy)(GaimWhiteboard *wb); /**< destory function */ 58 void (*destroy)(GaimWhiteboard *wb); /**< destory function */
59 void (*set_dimensions)(GaimWhiteboard *wb, int width, int height); /**< set_dimensions function */ 59 void (*set_dimensions)(GaimWhiteboard *wb, int width, int height); /**< set_dimensions function */
60 void (*set_brush) (GaimWhiteboard *wb, int size, int color); /**< set the size and color of the brush */
60 void (*draw_point)(GaimWhiteboard *wb, int x, int y, 61 void (*draw_point)(GaimWhiteboard *wb, int x, int y,
61 int color, int size); /**< draw_point function */ 62 int color, int size); /**< draw_point function */
62 void (*draw_line)(GaimWhiteboard *wb, int x1, int y1, 63 void (*draw_line)(GaimWhiteboard *wb, int x1, int y1,
63 int x2, int y2, 64 int x2, int y2,
64 int color, int size); /**< draw_line function */ 65 int color, int size); /**< draw_line function */
137 * @param draw_list The drawing list. 138 * @param draw_list The drawing list.
138 */ 139 */
139 void gaim_whiteboard_draw_list_destroy(GList *draw_list); 140 void gaim_whiteboard_draw_list_destroy(GList *draw_list);
140 141
141 /** 142 /**
143 * Gets the dimension of a whiteboard.
144 *
145 * @param wb The whiteboard.
146 * @param width The width to be set.
147 * @param height The height to be set.
148 *
149 * @return TRUE if the values of width and height were set.
150 */
151 gboolean gaim_whiteboard_get_dimensions(GaimWhiteboard *wb, int *width, int *height);
152
153 /**
142 * Sets the dimensions for a whiteboard. 154 * Sets the dimensions for a whiteboard.
143 * 155 *
144 * @param wb The whiteboard. 156 * @param wb The whiteboard.
145 * @param width The width. 157 * @param width The width.
146 * @param height The height. 158 * @param height The height.
155 * @param y The y coordinate. 167 * @param y The y coordinate.
156 * @param color The color to use. 168 * @param color The color to use.
157 * @param size The brush size. 169 * @param size The brush size.
158 */ 170 */
159 void gaim_whiteboard_draw_point(GaimWhiteboard *wb, int x, int y, int color, int size); 171 void gaim_whiteboard_draw_point(GaimWhiteboard *wb, int x, int y, int color, int size);
172
173 /**
174 * Send a list of points to draw to the buddy.
175 *
176 * @param wb The whiteboard
177 * @param list A GList of points
178 */
179 void gaim_whiteboard_send_draw_list(GaimWhiteboard *wb, GList *list);
160 180
161 /** 181 /**
162 * Draws a line on a whiteboard 182 * Draws a line on a whiteboard
163 * 183 *
164 * @param wb The whiteboard. 184 * @param wb The whiteboard.
176 * 196 *
177 * @param wb The whiteboard. 197 * @param wb The whiteboard.
178 */ 198 */
179 void gaim_whiteboard_clear(GaimWhiteboard *wb); 199 void gaim_whiteboard_clear(GaimWhiteboard *wb);
180 200
201 /**
202 * Sends a request to the buddy to clear the whiteboard.
203 *
204 * @param wb The whiteboard
205 */
206 void gaim_whiteboard_send_clear(GaimWhiteboard *wb);
207
208 /**
209 * Sends a request to change the size and color of the brush.
210 *
211 * @param wb The whiteboard
212 * @param size The size of the brush
213 * @param color The color of the brush
214 */
215 void gaim_whiteboard_send_brush(GaimWhiteboard *wb, int size, int color);
216
217 /**
218 * Gets the size and color of the brush.
219 *
220 * @param wb The whiteboard
221 * @param size The size of the brush
222 * @param color The color of the brush
223 *
224 * @return TRUE if the size and color were set.
225 */
226 gboolean gaim_whiteboard_get_brush(GaimWhiteboard *wb, int *size, int *color);
227
228 /**
229 * Sets the size and color of the brush.
230 *
231 * @param wb The whiteboard
232 * @param size The size of the brush
233 * @param color The color of the brush
234 */
235 void gaim_whiteboard_set_brush(GaimWhiteboard *wb, int size, int color);
236
181 /*@}*/ 237 /*@}*/
182 238
183 #ifdef __cplusplus 239 #ifdef __cplusplus
184 } 240 }
185 #endif /* __cplusplus */ 241 #endif /* __cplusplus */