libpurple/whiteboard.h

   1 /* purple
   2  *
   3  * Purple is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef PURPLE_WHITEBOARD_H
  23 #define PURPLE_WHITEBOARD_H
  24 /**
  25  * SECTION:whiteboard
  26  * @section_id: libpurple-whiteboard
  27  * @short_description: <filename>whiteboard.h</filename>
  28  * @title: Whiteboard Object
  29  */
  30
  31 #define PURPLE_TYPE_WHITEBOARD (purple_whiteboard_get_type())
  32 typedef struct _PurpleWhiteboard PurpleWhiteboard;
  33
  34 #define PURPLE_TYPE_WHITEBOARD_UI_OPS      (purple_whiteboard_ui_ops_get_type())
  35
  36 typedef struct _PurpleWhiteboardUiOps PurpleWhiteboardUiOps;
  37 typedef struct _PurpleWhiteboardOps PurpleWhiteboardOps;
  38
  39 #include "account.h"
  40
  41 /**
  42  * PurpleWhiteboardUiOps:
  43  * @create:         create whiteboard
  44  * @destroy:        destory whiteboard
  45  * @set_dimensions: set whiteboard dimensions
  46  * @set_brush:      set the size and color of the brush
  47  * @draw_point:     draw a point
  48  * @draw_line:      draw a line
  49  * @clear:          clear whiteboard
  50  *
  51  * The PurpleWhiteboard UI Operations
  52  */
  53 struct _PurpleWhiteboardUiOps
  54 {
  55         void (*create)(PurpleWhiteboard *wb);
  56         void (*destroy)(PurpleWhiteboard *wb);
  57         void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height);
  58         void (*set_brush) (PurpleWhiteboard *wb, int size, int color);
  59         void (*draw_point)(PurpleWhiteboard *wb, int x, int y,
  60                            int color, int size);
  61         void (*draw_line)(PurpleWhiteboard *wb, int x1, int y1,
  62                           int x2, int y2,
  63                           int color, int size);
  64         void (*clear)(PurpleWhiteboard *wb);
  65
  66         /*< private >*/
  67         void (*_purple_reserved1)(void);
  68         void (*_purple_reserved2)(void);
  69         void (*_purple_reserved3)(void);
  70         void (*_purple_reserved4)(void);
  71 };
  72
  73 /**
  74  * PurpleWhiteboardOps:
  75  * @start:          start function
  76  * @end:            end function
  77  * @get_dimensions: get whiteboard dimensions
  78  * @set_dimensions: set whiteboard dimensions
  79  * @get_brush:      get the brush size and color
  80  * @set_brush:      set the brush size and color
  81  * @send_draw_list: send_draw_list function
  82  * @clear:          clear whiteboard
  83  *
  84  * Whiteboard protocol operations
  85  */
  86 struct _PurpleWhiteboardOps
  87 {
  88         void (*start)(PurpleWhiteboard *wb);
  89         void (*end)(PurpleWhiteboard *wb);
  90         void (*get_dimensions)(const PurpleWhiteboard *wb, int *width, int *height);
  91         void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height);
  92         void (*get_brush) (const PurpleWhiteboard *wb, int *size, int *color);
  93         void (*set_brush) (PurpleWhiteboard *wb, int size, int color);
  94         void (*send_draw_list)(PurpleWhiteboard *wb, GList *draw_list);
  95         void (*clear)(PurpleWhiteboard *wb);
  96
  97         /*< private >*/
  98         void (*_purple_reserved1)(void);
  99         void (*_purple_reserved2)(void);
 100         void (*_purple_reserved3)(void);
 101         void (*_purple_reserved4)(void);
 102 };
 103
 104 /**
 105  * PurpleWhiteboard:
 106  * @ui_data: The UI data associated with this whiteboard. This is a convenience
 107  *           field provided to the UIs -- it is not used by the libpurple core.
 108  *
 109  * A Whiteboard
 110  */
 111 struct _PurpleWhiteboard
 112 {
 113         GObject gparent;
 114
 115         /*< public >*/
 116         gpointer ui_data;
 117 };
 118
 119 G_BEGIN_DECLS
 120
 121 /******************************************************************************/
 122 /* PurpleWhiteboard API                                                       */
 123 /******************************************************************************/
 124
 125 /**
 126  * purple_whiteboard_get_type:
 127  *
 128  * Returns: The #GType for the #PurpleWhiteboard object.
 129  */
 130 G_DECLARE_FINAL_TYPE(PurpleWhiteboard, purple_whiteboard, PURPLE, WHITEBOARD,
 131                      GObject)
 132
 133 /**
 134  * purple_whiteboard_ui_ops_get_type:
 135  *
 136  * Returns: The #GType for the #PurpleWhiteboardUiOps boxed structure.
 137  */
 138 GType purple_whiteboard_ui_ops_get_type(void);
 139
 140 /**
 141  * purple_whiteboard_set_ui_ops:
 142  * @ops: The UI operations to set
 143  *
 144  * Sets the UI operations
 145  */
 146 void purple_whiteboard_set_ui_ops(PurpleWhiteboardUiOps *ops);
 147
 148 /**
 149  * purple_whiteboard_set_protocol_ops:
 150  * @wb:  The whiteboard for which to set the protocol operations
 151  * @ops: The protocol operations to set
 152  *
 153  * Sets the protocol operations for a whiteboard
 154  */
 155 void purple_whiteboard_set_protocol_ops(PurpleWhiteboard *wb, PurpleWhiteboardOps *ops);
 156
 157 /**
 158  * purple_whiteboard_new:
 159  * @account: The account.
 160  * @who:     Who you're drawing with.
 161  * @state:   The state.
 162  *
 163  * Creates a new whiteboard
 164  *
 165  * Returns: The new whiteboard
 166  */
 167 PurpleWhiteboard *purple_whiteboard_new(PurpleAccount *account, const char *who, int state);
 168
 169 /**
 170  * purple_whiteboard_get_account:
 171  * @wb: The whiteboard.
 172  *
 173  * Returns the whiteboard's account.
 174  *
 175  * Returns: (transfer none): The whiteboard's account.
 176  */
 177 PurpleAccount *purple_whiteboard_get_account(PurpleWhiteboard *wb);
 178
 179 /**
 180  * purple_whiteboard_get_who:
 181  * @wb: The whiteboard
 182  *
 183  * Return who you're drawing with.
 184  *
 185  * Returns: Who you're drawing with.
 186  */
 187 const char *purple_whiteboard_get_who(PurpleWhiteboard *wb);
 188
 189 /**
 190  * purple_whiteboard_set_state:
 191  * @wb:    The whiteboard.
 192  * @state: The state
 193  *
 194  * Set the state of the whiteboard.
 195  */
 196 void purple_whiteboard_set_state(PurpleWhiteboard *wb, int state);
 197
 198 /**
 199  * purple_whiteboard_get_state:
 200  * @wb: The whiteboard.
 201  *
 202  * Return the state of the whiteboard.
 203  *
 204  * Returns: The state of the whiteboard.
 205  */
 206 int purple_whiteboard_get_state(PurpleWhiteboard *wb);
 207
 208 /**
 209  * purple_whiteboard_start:
 210  * @wb: The whiteboard.
 211  *
 212  * Starts a whiteboard
 213  */
 214 void purple_whiteboard_start(PurpleWhiteboard *wb);
 215
 216 /**
 217  * purple_whiteboard_get_session:
 218  * @account: The account.
 219  * @who:     The user.
 220  *
 221  * Finds a whiteboard from an account and user.
 222  *
 223  * Returns: (transfer none): The whiteboard if found, otherwise %NULL.
 224  */
 225 PurpleWhiteboard *purple_whiteboard_get_session(const PurpleAccount *account, const char *who);
 226
 227 /**
 228  * purple_whiteboard_draw_list_destroy:
 229  * @draw_list: (element-type gint): The drawing list.
 230  *
 231  * Destorys a drawing list for a whiteboard
 232  */
 233 void purple_whiteboard_draw_list_destroy(GList *draw_list);
 234
 235 /**
 236  * purple_whiteboard_get_dimensions:
 237  * @wb:     The whiteboard.
 238  * @width:  The width to be set.
 239  * @height: The height to be set.
 240  *
 241  * Gets the dimension of a whiteboard.
 242  *
 243  * Returns: TRUE if the values of width and height were set.
 244  */
 245 gboolean purple_whiteboard_get_dimensions(PurpleWhiteboard *wb, int *width, int *height);
 246
 247 /**
 248  * purple_whiteboard_set_dimensions:
 249  * @wb:     The whiteboard.
 250  * @width:  The width.
 251  * @height: The height.
 252  *
 253  * Sets the dimensions for a whiteboard.
 254  */
 255 void purple_whiteboard_set_dimensions(PurpleWhiteboard *wb, int width, int height);
 256
 257 /**
 258  * purple_whiteboard_draw_point:
 259  * @wb:    The whiteboard.
 260  * @x:     The x coordinate.
 261  * @y:     The y coordinate.
 262  * @color: The color to use.
 263  * @size:  The brush size.
 264  *
 265  * Draws a point on a whiteboard.
 266  */
 267 void purple_whiteboard_draw_point(PurpleWhiteboard *wb, int x, int y, int color, int size);
 268
 269 /**
 270  * purple_whiteboard_send_draw_list:
 271  * @wb:                        The whiteboard
 272  * @list: (element-type gint): A GList of points
 273  *
 274  * Send a list of points to draw to the buddy.
 275  */
 276 void purple_whiteboard_send_draw_list(PurpleWhiteboard *wb, GList *list);
 277
 278 /**
 279  * purple_whiteboard_draw_line:
 280  * @wb:    The whiteboard.
 281  * @x1:    The top-left x coordinate.
 282  * @y1:    The top-left y coordinate.
 283  * @x2:    The bottom-right x coordinate.
 284  * @y2:    The bottom-right y coordinate.
 285  * @color: The color to use.
 286  * @size:  The brush size.
 287  *
 288  * Draws a line on a whiteboard
 289  */
 290 void purple_whiteboard_draw_line(PurpleWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size);
 291
 292 /**
 293  * purple_whiteboard_clear:
 294  * @wb: The whiteboard.
 295  *
 296  * Clears a whiteboard
 297  */
 298 void purple_whiteboard_clear(PurpleWhiteboard *wb);
 299
 300 /**
 301  * purple_whiteboard_send_clear:
 302  * @wb: The whiteboard
 303  *
 304  * Sends a request to the buddy to clear the whiteboard.
 305  */
 306 void purple_whiteboard_send_clear(PurpleWhiteboard *wb);
 307
 308 /**
 309  * purple_whiteboard_send_brush:
 310  * @wb:    The whiteboard
 311  * @size:  The size of the brush
 312  * @color: The color of the brush
 313  *
 314  * Sends a request to change the size and color of the brush.
 315  */
 316 void purple_whiteboard_send_brush(PurpleWhiteboard *wb, int size, int color);
 317
 318 /**
 319  * purple_whiteboard_get_brush:
 320  * @wb:    The whiteboard
 321  * @size:  The size of the brush
 322  * @color: The color of the brush
 323  *
 324  * Gets the size and color of the brush.
 325  *
 326  * Returns:     TRUE if the size and color were set.
 327  */
 328 gboolean purple_whiteboard_get_brush(PurpleWhiteboard *wb, int *size, int *color);
 329
 330 /**
 331  * purple_whiteboard_set_brush:
 332  * @wb:    The whiteboard
 333  * @size:  The size of the brush
 334  * @color: The color of the brush
 335  *
 336  * Sets the size and color of the brush.
 337  */
 338 void purple_whiteboard_set_brush(PurpleWhiteboard *wb, int size, int color);
 339
 340 /**
 341  * purple_whiteboard_get_draw_list:
 342  * @wb: The whiteboard.
 343  *
 344  * Return the drawing list.
 345  *
 346  * Returns: (transfer none) (element-type gint): The drawing list
 347  */
 348 GList *purple_whiteboard_get_draw_list(PurpleWhiteboard *wb);
 349
 350 /**
 351  * purple_whiteboard_set_draw_list:
 352  * @wb:                             The whiteboard
 353  * @draw_list: (element-type gint): The drawing list.
 354  *
 355  * Set the drawing list.
 356  */
 357 void purple_whiteboard_set_draw_list(PurpleWhiteboard *wb, GList* draw_list);
 358
 359 /**
 360  * purple_whiteboard_set_protocol_data:
 361  * @wb:         The whiteboard.
 362  * @proto_data: The protocol data to set for the whiteboard.
 363  *
 364  * Sets the protocol data for a whiteboard.
 365  */
 366 void purple_whiteboard_set_protocol_data(PurpleWhiteboard *wb, gpointer proto_data);
 367
 368 /**
 369  * purple_whiteboard_get_protocol_data:
 370  * @wb: The whiteboard.
 371  *
 372  * Gets the protocol data for a whiteboard.
 373  *
 374  * Returns: The protocol data for the whiteboard.
 375  */
 376 gpointer purple_whiteboard_get_protocol_data(PurpleWhiteboard *wb);
 377
 378 /**
 379  * purple_whiteboard_set_ui_data:
 380  * @wb:      The whiteboard.
 381  * @ui_data: A pointer to associate with this whiteboard.
 382  *
 383  * Set the UI data associated with this whiteboard.
 384  */
 385 void purple_whiteboard_set_ui_data(PurpleWhiteboard *wb, gpointer ui_data);
 386
 387 /**
 388  * purple_whiteboard_get_ui_data:
 389  * @wb: The whiteboard..
 390  *
 391  * Get the UI data associated with this whiteboard.
 392  *
 393  * Returns: The UI data associated with this whiteboard.  This is a
 394  *         convenience field provided to the UIs--it is not
 395  *         used by the libpurple core.
 396  */
 397 gpointer purple_whiteboard_get_ui_data(PurpleWhiteboard *wb);
 398
 399 G_END_DECLS
 400
 401 #endif /* PURPLE_WHITEBOARD_H */