diff src/gtkwhiteboard.h @ 11802:2e3a6dcebaf3

[gaim-migrate @ 14093] This should be it for the // -> /* */ for the doodle/whiteboard stuff. This could use a bit of cleaning yet.... committer: Tailor Script <[e-mail]>

--- a/src/gtkwhiteboard.h	Mon Oct 24 21:48:21 2005 +0000
+++ b/src/gtkwhiteboard.h	Mon Oct 24 22:45:24 2005 +0000
@@ -25,13 +25,10 @@
 #ifndef _GAIM_GTKWHITEBOARD_H_
 #define _GAIM_GTKWHITEBOARD_H_
 
-// INCLUDES ============================================================================================
 #include "gtkgaim.h"
 
 #include "whiteboard.h"
 
-// DEFINES =============================================================================================
-
 #define FULL_CIRCLE_DEGREES		23040
 
 #define BRUSH_STATE_UP			0
@@ -40,50 +37,42 @@
 
 #define PALETTE_NUM_COLORS		7
 
-// DATATYPES ===========================================================================================
+/**
+ * A GaimGtkWhiteboard
+ */
 typedef struct _GaimGtkWhiteboard
 {
-	GaimWhiteboard	*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
+	GaimWhiteboard	*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 */
 } GaimGtkWhiteboard;
 
-// PROTOTYPES ==========================================================================================
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
 
+/*****************************************************************************/
+/** @name GaimGtkWhiteboard API                                              */
+/*****************************************************************************/
+/*@{*/
+
+/**
+ * Gets the GtkWhiteboard UI Operations.
+ *
+ * @return The GtkWhiteboard UI Operations.
+ */
 GaimWhiteboardUiOps	*gaim_gtk_whiteboard_get_ui_ops( void );
 
-void			gaim_gtk_whiteboard_create( GaimWhiteboard *wb );
-void			gaim_gtk_whiteboard_destroy( GaimWhiteboard *wb );
-void			gaim_gtk_whiteboard_exit( GtkWidget *widget, gpointer data );
-
-//void			gaim_gtkwhiteboard_button_start_press( GtkButton *button, gpointer data );
-
-gboolean		gaim_gtk_whiteboard_configure_event( GtkWidget *widget, GdkEventConfigure *event, gpointer data );
-gboolean		gaim_gtk_whiteboard_expose_event( GtkWidget *widget, GdkEventExpose *event, gpointer data );
-
-gboolean		gaim_gtk_whiteboard_brush_down( GtkWidget *widget, GdkEventButton *event, gpointer data );
-gboolean		gaim_gtk_whiteboard_brush_motion( GtkWidget *widget, GdkEventMotion *event, gpointer data );
-gboolean		gaim_gtk_whiteboard_brush_up( GtkWidget *widget, GdkEventButton *event, gpointer data );
+/*@}*/
 
-void			gaim_gtk_whiteboard_draw_brush_point( GaimWhiteboard *wb,
-							      int x, int y, int color, int size );
-void			gaim_gtk_whiteboard_draw_brush_line( GaimWhiteboard *wb,
-							     int x0, int y0, int x1, int y1, int color, int size );
-
-void			gaim_gtk_whiteboard_set_dimensions( GaimWhiteboard *wb, int width, int height );
-void			gaim_gtk_whiteboard_clear( GaimWhiteboard *wb );
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
-void			gaim_gtk_whiteboard_button_clear_press( GtkWidget *widget, gpointer data );
-void			gaim_gtk_whiteboard_button_save_press( GtkWidget *widget, gpointer data );
-
-void			gaim_gtk_whiteboard_set_canvas_as_icon( GaimGtkWhiteboard *gtkwb );
-
-void			gaim_gtk_whiteboard_rgb24_to_rgb48( int color_rgb, GdkColor *color );
-
-#endif // _GAIM_GTKWHITEBOARD_H_
+#endif /* _GAIM_GTKWHITEBOARD_H_ */