aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-cell.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-cell.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-cell.h')
-rw-r--r--e-util/e-cell.h299
1 files changed, 299 insertions, 0 deletions
diff --git a/e-util/e-cell.h b/e-util/e-cell.h
new file mode 100644
index 0000000000..4c1354259c
--- /dev/null
+++ b/e-util/e-cell.h
@@ -0,0 +1,299 @@
+/*
+ * 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:
+ * Miguel de Icaza <miguel@ximian.com>
+ * 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_CELL_H_
+#define _E_CELL_H_
+
+#include <gtk/gtk.h>
+
+#include <e-util/e-table-model.h>
+
+/* Standard GObject macros */
+#define E_TYPE_CELL \
+ (e_cell_get_type ())
+#define E_CELL(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_CELL, ECell))
+#define E_CELL_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_CAST \
+ ((cls), E_TYPE_CELL, ECellClass))
+#define E_CELL_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS \
+ ((obj), E_TYPE_CELL, ECellClass))
+#define E_IS_CELL(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_CELL))
+#define E_IS_CELL_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_TYPE \
+ ((cls), E_TYPE_CELL))
+#define E_CELL_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS \
+ ((obj), E_TYPE_CELL, ECellClass))
+
+G_BEGIN_DECLS
+
+typedef struct _ECell ECell;
+typedef struct _ECellClass ECellClass;
+typedef struct _ECellView ECellView;
+
+typedef gboolean (*ETableSearchFunc) (gconstpointer haystack,
+ const gchar *needle);
+
+typedef enum {
+ E_CELL_SELECTED = 1 << 0,
+
+ E_CELL_JUSTIFICATION = 3 << 1,
+ E_CELL_JUSTIFY_CENTER = 0 << 1,
+ E_CELL_JUSTIFY_LEFT = 1 << 1,
+ E_CELL_JUSTIFY_RIGHT = 2 << 1,
+ E_CELL_JUSTIFY_FILL = 3 << 1,
+
+ E_CELL_ALIGN_LEFT = 1 << 1,
+ E_CELL_ALIGN_RIGHT = 1 << 2,
+
+ E_CELL_FOCUSED = 1 << 3,
+
+ E_CELL_EDITING = 1 << 4,
+
+ E_CELL_CURSOR = 1 << 5,
+
+ E_CELL_PREEDIT = 1 << 6
+} ECellFlags;
+
+typedef enum {
+ E_CELL_GRAB = 1 << 0,
+ E_CELL_UNGRAB = 1 << 1
+} ECellActions;
+
+struct _ECellView {
+ ECell *ecell;
+ ETableModel *e_table_model;
+ void *e_table_item_view;
+
+ gint focus_x1, focus_y1, focus_x2, focus_y2;
+ gint focus_col, focus_row;
+
+ void (*kill_view_cb) (struct _ECellView *, gpointer);
+ GList *kill_view_cb_data;
+};
+
+#define E_CELL_IS_FOCUSED(ecell_view) (ecell_view->focus_x1 != -1)
+
+struct _ECell {
+ GObject parent;
+};
+
+struct _ECellClass {
+ GObjectClass parent_class;
+
+ ECellView * (*new_view) (ECell *ecell,
+ ETableModel *table_model,
+ gpointer e_table_item_view);
+ void (*kill_view) (ECellView *ecell_view);
+
+ void (*realize) (ECellView *ecell_view);
+ void (*unrealize) (ECellView *ecell_view);
+
+ void (*draw) (ECellView *ecell_view,
+ cairo_t *cr,
+ gint model_col,
+ gint view_col, gint row,
+ ECellFlags flags,
+ gint x1,
+ gint y1,
+ gint x2,
+ gint y2);
+ gint (*event) (ECellView *ecell_view,
+ GdkEvent *event,
+ gint model_col,
+ gint view_col,
+ gint row,
+ ECellFlags flags,
+ ECellActions *actions);
+ void (*focus) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gint x1,
+ gint y1,
+ gint x2,
+ gint y2);
+ void (*unfocus) (ECellView *ecell_view);
+ gint (*height) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row);
+
+ gpointer (*enter_edit) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row);
+ void (*leave_edit) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer context);
+ gpointer (*save_state) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer context);
+ void (*load_state) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer context,
+ gpointer save_state);
+ void (*free_state) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer save_state);
+ void (*print) (ECellView *ecell_view,
+ GtkPrintContext *context,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gdouble width,
+ gdouble height);
+ gdouble (*print_height) (ECellView *ecell_view,
+ GtkPrintContext *context,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gdouble width);
+ gint (*max_width) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col);
+ gint (*max_width_by_row) (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row);
+ gchar * (*get_bg_color) (ECellView *ecell_view,
+ gint row);
+
+ void (*style_set) (ECellView *ecell_view,
+ GtkStyle *previous_style);
+};
+
+GType e_cell_get_type (void) G_GNUC_CONST;
+
+/* View creation methods. */
+ECellView * e_cell_new_view (ECell *ecell,
+ ETableModel *table_model,
+ gpointer e_table_item_view);
+void e_cell_kill_view (ECellView *ecell_view);
+
+/* Cell View methods. */
+gint e_cell_event (ECellView *ecell_view,
+ GdkEvent *event,
+ gint model_col,
+ gint view_col,
+ gint row,
+ ECellFlags flags,
+ ECellActions *actions);
+void e_cell_realize (ECellView *ecell_view);
+void e_cell_unrealize (ECellView *ecell_view);
+void e_cell_draw (ECellView *ecell_view,
+ cairo_t *cr,
+ gint model_col,
+ gint view_col,
+ gint row,
+ ECellFlags flags,
+ gint x1,
+ gint y1,
+ gint x2,
+ gint y2);
+void e_cell_print (ECellView *ecell_view,
+ GtkPrintContext *context,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gdouble width,
+ gdouble height);
+gdouble e_cell_print_height (ECellView *ecell_view,
+ GtkPrintContext *context,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gdouble width);
+gint e_cell_max_width (ECellView *ecell_view,
+ gint model_col,
+ gint view_col);
+gint e_cell_max_width_by_row (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row);
+gboolean e_cell_max_width_by_row_implemented
+ (ECellView *ecell_view);
+gchar * e_cell_get_bg_color (ECellView *ecell_view,
+ gint row);
+void e_cell_style_set (ECellView *ecell_view,
+ GtkStyle *previous_style);
+
+void e_cell_focus (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gint x1,
+ gint y1,
+ gint x2,
+ gint y2);
+void e_cell_unfocus (ECellView *ecell_view);
+gint e_cell_height (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row);
+gpointer e_cell_enter_edit (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row);
+void e_cell_leave_edit (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer edit_context);
+gpointer e_cell_save_state (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer edit_context);
+void e_cell_load_state (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer edit_context,
+ gpointer state);
+void e_cell_free_state (ECellView *ecell_view,
+ gint model_col,
+ gint view_col,
+ gint row,
+ gpointer state);
+
+G_END_DECLS
+
+#endif /* _E_CELL_H_ */