Mercurial > pidgin.yaz
view pidgin/gtkwhiteboard.h @ 32635:63e7d226b760
Re-arrange these doxygen comments. For comments longer than a few words,
putting the comment before the variable like this seems cleaner than trying
to cram it on the same line as the variable and using lots of crazy
indentation. Anyone have a strong opinion either way?
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sun, 18 Sep 2011 20:18:33 +0000 |
parents | 6bf32c9e15a7 |
children |
line wrap: on
line source
/** * @file gtkwhiteboard.h The PidginWhiteboard frontend object */ /* pidgin * * Pidgin 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef _PIDGINWHITEBOARD_H_ #define _PIDGINWHITEBOARD_H_ #include "pidgin.h" #include "whiteboard.h" #define FULL_CIRCLE_DEGREES 23040 /* TODO: Make into an enum. */ #define BRUSH_STATE_UP 0 #define BRUSH_STATE_DOWN 1 #define BRUSH_STATE_MOTION 2 /* XXX: This seems duplicated with the Yahoo! Doodle prpl code. * XXX: How should they work together? */ #define PALETTE_NUM_COLORS 7 /** * A PidginWhiteboard */ typedef struct _PidginWhiteboard { PurpleWhiteboard *wb; /**< backend data for this whiteboard */ GtkWidget *window; /**< Window for the Doodle session */ GtkWidget *drawing_area; /**< Drawing area */ GdkPixmap *pixmap; /**< Memory for drawing area */ int width; /**< Canvas width */ int height; /**< Canvas height */ int brush_color; /**< Foreground color */ int brush_size; /**< Brush size */ } PidginWhiteboard; #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /*****************************************************************************/ /** @name PidginWhiteboard API */ /*****************************************************************************/ /*@{*/ /** * Gets the GtkWhiteboard UI Operations. * * @return The GtkWhiteboard UI Operations. */ PurpleWhiteboardUiOps *pidgin_whiteboard_get_ui_ops( void ); /*@}*/ #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* _PIDGINWHITEBOARD_H_ */