view src/whiteboard.h @ 14121:8af7f3a7015f

[gaim-migrate @ 16755] Whoops, few more warning fixes committer: Tailor Script <[e-mail]>

+
鐃緒申/**
+
鐃緒申 * @file whiteboard.h The GaimWhiteboard core object
+
鐃緒申 *
+
鐃緒申 * gaim
+
鐃緒申 *
+
鐃緒申 * Gaim is the legal property of its developers, whose names are too numerous
+
鐃緒申 * to list here.  Please refer to the COPYRIGHT file distributed with this
+
鐃緒申 * source distribution.
+
鐃緒申 *
+
鐃緒申 * This program is free software; you can redistribute it and/or modify
+
鐃緒申 * it under the terms of the GNU General Public License as published by
+
鐃緒申 * the Free Software Foundation; either version 2 of the License, or
+
鐃緒申 * (at your option) any later version.
+
鐃緒申 *
+
鐃緒申 * This program is distributed in the hope that it will be useful,
+
鐃緒申 * but WITHOUT ANY WARRANTY; without even the implied warranty of
+
鐃緒申 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+
鐃緒申 * GNU General Public License for more details.
+
鐃緒申 *
+
鐃緒申 * You should have received a copy of the GNU General Public License
+
鐃緒申 * along with this program; if not, write to the Free Software
+
鐃緒申 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
鐃緒申 */
+
鐃緒申
+
鐃緒申#ifndef _GAIM_WHITEBOARD_H_
+
鐃緒申#define _GAIM_WHITEBOARD_H_
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Whiteboard PRPL Operations
+
鐃緒申 */
+
鐃緒申typedef struct _GaimWhiteboardPrplOps GaimWhiteboardPrplOps;
+
鐃緒申
+
鐃緒申#include "account.h"
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * A GaimWhiteboard
+
鐃緒申 */
+
鐃緒申typedef struct _GaimWhiteboard
+
鐃緒申{
+
鐃緒申	int state;                       /**< State of whiteboard session */
+
鐃緒申
+
鐃緒申	GaimAccount *account;            /**< Account associated with this session */
+
鐃緒申	char *who;                       /**< Name of the remote user */
+
鐃緒申
+
鐃緒申	void *ui_data;                   /**< Graphical user-interface data */
+
鐃緒申	void *proto_data;                /**< Protocol specific data */
+
鐃緒申	GaimWhiteboardPrplOps *prpl_ops; /**< Protocol-plugin operations */
+
鐃緒申
+
鐃緒申	GList *draw_list;                /**< List of drawing elements/deltas to send */
+
鐃緒申} GaimWhiteboard;
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * The GaimWhiteboard UI Operations
+
鐃緒申 */
+
鐃緒申typedef struct _GaimWhiteboardUiOps
+
鐃緒申{
+
鐃緒申	void (*create)(GaimWhiteboard *wb);                                 /**< create function */
+
鐃緒申	void (*destroy)(GaimWhiteboard *wb);                               /**< destory function */
+
鐃緒申	void (*set_dimensions)(GaimWhiteboard *wb, int width, int height); /**< set_dimensions function */
+
鐃緒申	void (*set_brush) (GaimWhiteboard *wb, int size, int color);		/**< set the size and color of the brush */
+
鐃緒申	void (*draw_point)(GaimWhiteboard *wb, int x, int y,
+
鐃緒申					   int color, int size);                           /**< draw_point function */
+
鐃緒申	void (*draw_line)(GaimWhiteboard *wb, int x1, int y1,
+
鐃緒申					  int x2, int y2,
+
鐃緒申					  int color, int size);                            /**< draw_line function */
+
鐃緒申	void (*clear)(GaimWhiteboard *wb);                                 /**< clear function */
+
鐃緒申} GaimWhiteboardUiOps;
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * GaimWhiteboard PRPL Operations
+
鐃緒申 */
+
鐃緒申struct _GaimWhiteboardPrplOps
+
鐃緒申{
+
鐃緒申	void (*start)(GaimWhiteboard *wb);                                   /**< start function */
+
鐃緒申	void (*end)(GaimWhiteboard *wb);                                     /**< end function */
+
鐃緒申	void (*get_dimensions)(GaimWhiteboard *wb, int *width, int *height); /**< get_dimensions function */
+
鐃緒申	void (*set_dimensions)(GaimWhiteboard *wb, int width, int height);   /**< set_dimensions function */
+
鐃緒申	void (*get_brush) (GaimWhiteboard *wb, int *size, int *color);       /**< get the brush size and color */
+
鐃緒申	void (*set_brush) (GaimWhiteboard *wb, int size, int color);         /**< set the brush size and color */
+
鐃緒申	void (*send_draw_list)(GaimWhiteboard *wb, GList *draw_list);        /**< send_draw_list function */
+
鐃緒申	void (*clear)(GaimWhiteboard *wb);                                   /**< clear function */
+
鐃緒申};
+
鐃緒申
+
鐃緒申#ifdef __cplusplus
+
鐃緒申extern "C" {
+
鐃緒申#endif /* __cplusplus */
+
鐃緒申
+
鐃緒申/******************************************************************************/
+
鐃緒申/** @name GaimWhiteboard API                                                  */
+
鐃緒申/******************************************************************************/
+
鐃緒申/*@{*/
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Sets the UI operations
+
鐃緒申 *
+
鐃緒申 * @param ops The UI operations to set
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_set_ui_ops(GaimWhiteboardUiOps *ops);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Sets the prpl operations for a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param wb  The whiteboard for which to set the prpl operations
+
鐃緒申 * @param ops The prpl operations to set
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_set_prpl_ops(GaimWhiteboard *wb, GaimWhiteboardPrplOps *ops);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Creates a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param account The account.
+
鐃緒申 * @param who     Who you're drawing with.
+
鐃緒申 * @param state   The state.
+
鐃緒申 *
+
鐃緒申 * @return The new whiteboard
+
鐃緒申 */
+
鐃緒申GaimWhiteboard *gaim_whiteboard_create(GaimAccount *account, const char *who, int state);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Destroys a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param wb The whiteboard.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_destroy(GaimWhiteboard *wb);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Starts a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param wb The whiteboard.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_start(GaimWhiteboard *wb);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Finds a whiteboard from an account and user.
+
鐃緒申 *
+
鐃緒申 * @param account The account.
+
鐃緒申 * @param who     The user.
+
鐃緒申 *
+
鐃緒申 * @return The whiteboard if found, otherwise @c NULL.
+
鐃緒申 */
+
鐃緒申GaimWhiteboard *gaim_whiteboard_get_session(GaimAccount *account, const char *who);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Destorys a drawing list for a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param draw_list The drawing list.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_draw_list_destroy(GList *draw_list);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Gets the dimension of a whiteboard.
+
鐃緒申 *
+
鐃緒申 * @param wb		The whiteboard.
+
鐃緒申 * @param width		The width to be set.
+
鐃緒申 * @param height	The height to be set.
+
鐃緒申 *
+
鐃緒申 * @return TRUE if the values of width and height were set.
+
鐃緒申 */
+
鐃緒申gboolean gaim_whiteboard_get_dimensions(GaimWhiteboard *wb, int *width, int *height);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Sets the dimensions for a whiteboard.
+
鐃緒申 *
+
鐃緒申 * @param wb     The whiteboard.
+
鐃緒申 * @param width  The width.
+
鐃緒申 * @param height The height.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_set_dimensions(GaimWhiteboard *wb, int width, int height);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Draws a point on a whiteboard.
+
鐃緒申 *
+
鐃緒申 * @param wb    The whiteboard.
+
鐃緒申 * @param x     The x coordinate.
+
鐃緒申 * @param y     The y coordinate.
+
鐃緒申 * @param color The color to use.
+
鐃緒申 * @param size  The brush size.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_draw_point(GaimWhiteboard *wb, int x, int y, int color, int size);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Send a list of points to draw to the buddy.
+
鐃緒申 *
+
鐃緒申 * @param wb	The whiteboard
+
鐃緒申 * @param list	A GList of points
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_send_draw_list(GaimWhiteboard *wb, GList *list);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Draws a line on a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param wb    The whiteboard.
+
鐃緒申 * @param x1    The top-left x coordinate.
+
鐃緒申 * @param y1    The top-left y coordinate.
+
鐃緒申 * @param x2    The bottom-right x coordinate.
+
鐃緒申 * @param y2    The bottom-right y coordinate.
+
鐃緒申 * @param color The color to use.
+
鐃緒申 * @param size  The brush size.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_draw_line(GaimWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Clears a whiteboard
+
鐃緒申 *
+
鐃緒申 * @param wb The whiteboard.
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_clear(GaimWhiteboard *wb);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Sends a request to the buddy to clear the whiteboard.
+
鐃緒申 *
+
鐃緒申 * @param wb The whiteboard
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_send_clear(GaimWhiteboard *wb);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Sends a request to change the size and color of the brush.
+
鐃緒申 *
+
鐃緒申 * @param wb	The whiteboard
+
鐃緒申 * @param size	The size of the brush
+
鐃緒申 * @param color	The color of the brush
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_send_brush(GaimWhiteboard *wb, int size, int color);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Gets the size and color of the brush.
+
鐃緒申 *
+
鐃緒申 * @param wb	The whiteboard
+
鐃緒申 * @param size	The size of the brush
+
鐃緒申 * @param color	The color of the brush
+
鐃緒申 *
+
鐃緒申 * @return	TRUE if the size and color were set.
+
鐃緒申 */
+
鐃緒申gboolean gaim_whiteboard_get_brush(GaimWhiteboard *wb, int *size, int *color);
+
鐃緒申
+
鐃緒申/**
+
鐃緒申 * Sets the size and color of the brush.
+
鐃緒申 *
+
鐃緒申 * @param wb	The whiteboard
+
鐃緒申 * @param size	The size of the brush
+
鐃緒申 * @param color	The color of the brush
+
鐃緒申 */
+
鐃緒申void gaim_whiteboard_set_brush(GaimWhiteboard *wb, int size, int color);
+
鐃緒申
+
鐃緒申/*@}*/
+
鐃緒申
+
鐃緒申#ifdef __cplusplus
+
鐃緒申}
+
鐃緒申#endif /* __cplusplus */
+
鐃緒申
+
鐃緒申#endif /* _GAIM_WHITEBOARD_H_ */