aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-canvas.h
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2012-12-10 21:09:59 +0800
committerMatthew Barnes <mbarnes@redhat.com>2012-12-13 03:33:43 +0800
commitd09d8de870b6697c8a8b262e7e077b871a69b315 (patch)
tree3b718882e7a0bb0a996daf2967a033d91714c9b5 /e-util/e-canvas.h
parentb61331ed03ac1c7a9b8614e25510040b9c60ae02 (diff)
downloadgsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.gz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.bz2
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.lz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.xz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.zst
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.zip
Consolidate base utility libraries into libeutil.
Evolution consists of entirely too many small utility libraries, which increases linking and loading time, places a burden on higher layers of the application (e.g. modules) which has to remember to link to all the small in-tree utility libraries, and makes it difficult to generate API documentation for these utility libraries in one Gtk-Doc module. Merge the following utility libraries under the umbrella of libeutil, and enforce a single-include policy on libeutil so we can reorganize the files as desired without disrupting its pseudo-public API. libemail-utils/libemail-utils.la libevolution-utils/libevolution-utils.la filter/libfilter.la widgets/e-timezone-dialog/libetimezonedialog.la widgets/menus/libmenus.la widgets/misc/libemiscwidgets.la widgets/table/libetable.la widgets/text/libetext.la This also merges libedataserverui from the Evolution-Data-Server module, since Evolution is its only consumer nowadays, and I'd like to make some improvements to those APIs without concern for backward-compatibility. And finally, start a Gtk-Doc module for libeutil. It's going to be a project just getting all the symbols _listed_ much less _documented_. But the skeletal structure is in place and I'm off to a good start.
Diffstat (limited to 'e-util/e-canvas.h')
-rw-r--r--e-util/e-canvas.h141
1 files changed, 141 insertions, 0 deletions
diff --git a/e-util/e-canvas.h b/e-util/e-canvas.h
new file mode 100644
index 0000000000..8d704b963c
--- /dev/null
+++ b/e-util/e-canvas.h
@@ -0,0 +1,141 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) version 3.
+ *
+ * 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with the program; if not, see <http://www.gnu.org/licenses/>
+ *
+ *
+ * Authors:
+ * Chris Lahey <clahey@ximian.com>
+ *
+ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
+ *
+ */
+
+#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
+#error "Only <e-util/e-util.h> should be included directly."
+#endif
+
+#ifndef E_CANVAS_H
+#define E_CANVAS_H
+
+#include <gtk/gtk.h>
+#include <libgnomecanvas/gnome-canvas.h>
+
+/* ECanvas - A class derived from canvas for the purpose of adding
+ * evolution specific canvas hacks. */
+
+/* Standard GObject macros */
+#define E_TYPE_CANVAS \
+ (e_canvas_get_type ())
+#define E_CANVAS(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_CANVAS, ECanvas))
+#define E_CANVAS_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_CAST \
+ ((cls), E_TYPE_CANVAS, ECanvasClass))
+#define E_IS_CANVAS(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_CANVAS))
+#define E_IS_CANVAS_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_TYPE \
+ ((cls), E_TYPE_CANVAS))
+#define E_CANVAS_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS \
+ ((obj), E_TYPE_CANVAS, ECanvasClass))
+
+G_BEGIN_DECLS
+
+typedef void (*ECanvasItemReflowFunc) (GnomeCanvasItem *item,
+ gint flags);
+
+typedef void (*ECanvasItemSelectionFunc) (GnomeCanvasItem *item,
+ gint flags,
+ gpointer user_data);
+/* Returns the same as strcmp does. */
+typedef gint (*ECanvasItemSelectionCompareFunc)
+ (GnomeCanvasItem *item,
+ gpointer data1,
+ gpointer data2,
+ gint flags);
+
+typedef struct _ECanvas ECanvas;
+typedef struct _ECanvasClass ECanvasClass;
+
+/* Object flags for items */
+enum {
+ E_CANVAS_ITEM_NEEDS_REFLOW = 1 << 13,
+ E_CANVAS_ITEM_DESCENDENT_NEEDS_REFLOW = 1 << 14
+};
+
+typedef struct {
+ GnomeCanvasItem *item;
+ gpointer id;
+} ECanvasSelectionInfo;
+
+typedef void (*ECanvasItemGrabCancelled) (ECanvas *canvas,
+ GnomeCanvasItem *item,
+ gpointer data);
+
+struct _ECanvas {
+ GnomeCanvas parent;
+
+ gint idle_id;
+ GList *selection;
+ ECanvasSelectionInfo *cursor;
+
+ GtkWidget *tooltip_window;
+ gint visibility_notify_id;
+ GtkWidget *toplevel;
+
+ /* Input context for dead key support */
+ GtkIMContext *im_context;
+
+ ECanvasItemGrabCancelled grab_cancelled_cb;
+ guint grab_cancelled_check_id;
+ guint32 grab_cancelled_time;
+ gpointer grab_cancelled_data;
+};
+
+struct _ECanvasClass {
+ GnomeCanvasClass parent_class;
+
+ void (*reflow) (ECanvas *canvas);
+};
+
+GType e_canvas_get_type (void);
+GtkWidget * e_canvas_new (void);
+
+/* Used to send all of the keystroke events to a specific item as well as
+ * GDK_FOCUS_CHANGE events. */
+void e_canvas_item_grab_focus (GnomeCanvasItem *item,
+ gboolean widget_too);
+void e_canvas_item_request_reflow (GnomeCanvasItem *item);
+void e_canvas_item_request_parent_reflow
+ (GnomeCanvasItem *item);
+void e_canvas_item_set_reflow_callback
+ (GnomeCanvasItem *item,
+ ECanvasItemReflowFunc func);
+gint e_canvas_item_grab (ECanvas *canvas,
+ GnomeCanvasItem *item,
+ guint event_mask,
+ GdkCursor *cursor,
+ GdkDevice *device,
+ guint32 etime,
+ ECanvasItemGrabCancelled cancelled,
+ gpointer cancelled_data);
+void e_canvas_item_ungrab (ECanvas *canvas,
+ GnomeCanvasItem *item,
+ guint32 etime);
+
+G_END_DECLS
+
+#endif /* E_CANVAS_H */