aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-table-group.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-table-group.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-table-group.h')
-rw-r--r--e-util/e-table-group.h242
1 files changed, 242 insertions, 0 deletions
diff --git a/e-util/e-table-group.h b/e-util/e-table-group.h
new file mode 100644
index 0000000000..7e9e905753
--- /dev/null
+++ b/e-util/e-table-group.h
@@ -0,0 +1,242 @@
+/*
+ *
+ * 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_TABLE_GROUP_H_
+#define _E_TABLE_GROUP_H_
+
+#include <libgnomecanvas/libgnomecanvas.h>
+
+#include <e-util/e-misc-utils.h>
+#include <e-util/e-printable.h>
+#include <e-util/e-table-defines.h>
+#include <e-util/e-table-header.h>
+#include <e-util/e-table-model.h>
+#include <e-util/e-table-sort-info.h>
+
+/* Standard GObject macros */
+#define E_TYPE_TABLE_GROUP \
+ (e_table_group_get_type ())
+#define E_TABLE_GROUP(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_TABLE_GROUP, ETableGroup))
+#define E_TABLE_GROUP_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_CAST \
+ ((cls), E_TYPE_TABLE_GROUP, ETableGroupClass))
+#define E_IS_TABLE_GROUP(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_TABLE_GROUP))
+#define E_IS_TABLE_GROUP_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_TYPE \
+ ((cls), E_TYPE_TABLE_GROUP))
+#define E_TABLE_GROUP_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS \
+ ((obj), E_TYPE_TABLE_GROUP, ETableGroupClass))
+
+G_BEGIN_DECLS
+
+typedef struct _ETableGroup ETableGroup;
+typedef struct _ETableGroupClass ETableGroupClass;
+
+struct _ETableGroup {
+ GnomeCanvasGroup group;
+
+ /*
+ * The full header.
+ */
+ ETableHeader *full_header;
+ ETableHeader *header;
+
+ /*
+ * The model we pull data from.
+ */
+ ETableModel *model;
+
+ /*
+ * Whether we should add indentation and open/close markers,
+ * or if we just act as containers of subtables.
+ */
+ guint transparent : 1;
+
+ guint has_focus : 1;
+
+ guint frozen : 1;
+};
+
+struct _ETableGroupClass {
+ GnomeCanvasGroupClass parent_class;
+
+ /* Signals */
+ void (*cursor_change) (ETableGroup *etg,
+ gint row);
+ void (*cursor_activated) (ETableGroup *etg,
+ gint row);
+ void (*double_click) (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+ gboolean (*right_click) (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+ gboolean (*click) (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+ gboolean (*key_press) (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+ gint (*start_drag) (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+
+ /* Virtual functions. */
+ void (*add) (ETableGroup *etg,
+ gint row);
+ void (*add_array) (ETableGroup *etg,
+ const gint *array,
+ gint count);
+ void (*add_all) (ETableGroup *etg);
+ gboolean (*remove) (ETableGroup *etg,
+ gint row);
+ gint (*row_count) (ETableGroup *etg);
+ void (*increment) (ETableGroup *etg,
+ gint position,
+ gint amount);
+ void (*decrement) (ETableGroup *etg,
+ gint position,
+ gint amount);
+ void (*set_focus) (ETableGroup *etg,
+ EFocus direction,
+ gint view_col);
+ gboolean (*get_focus) (ETableGroup *etg);
+ gint (*get_focus_column) (ETableGroup *etg);
+ EPrintable * (*get_printable) (ETableGroup *etg);
+ void (*compute_location) (ETableGroup *etg,
+ gint *x,
+ gint *y,
+ gint *row,
+ gint *col);
+ void (*get_mouse_over) (ETableGroup *etg,
+ gint *row,
+ gint *col);
+ void (*get_cell_geometry) (ETableGroup *etg,
+ gint *row,
+ gint *col,
+ gint *x,
+ gint *y,
+ gint *width,
+ gint *height);
+};
+
+GType e_table_group_get_type (void) G_GNUC_CONST;
+ETableGroup * e_table_group_new (GnomeCanvasGroup *parent,
+ ETableHeader *full_header,
+ ETableHeader *header,
+ ETableModel *model,
+ ETableSortInfo *sort_info,
+ gint n);
+void e_table_group_construct (GnomeCanvasGroup *parent,
+ ETableGroup *etg,
+ ETableHeader *full_header,
+ ETableHeader *header,
+ ETableModel *model);
+
+/* Virtual functions */
+void e_table_group_add (ETableGroup *etg,
+ gint row);
+void e_table_group_add_array (ETableGroup *etg,
+ const gint *array,
+ gint count);
+void e_table_group_add_all (ETableGroup *etg);
+gboolean e_table_group_remove (ETableGroup *etg,
+ gint row);
+void e_table_group_increment (ETableGroup *etg,
+ gint position,
+ gint amount);
+void e_table_group_decrement (ETableGroup *etg,
+ gint position,
+ gint amount);
+gint e_table_group_row_count (ETableGroup *etg);
+void e_table_group_set_focus (ETableGroup *etg,
+ EFocus direction,
+ gint view_col);
+gboolean e_table_group_get_focus (ETableGroup *etg);
+gint e_table_group_get_focus_column (ETableGroup *etg);
+ETableHeader * e_table_group_get_header (ETableGroup *etg);
+EPrintable * e_table_group_get_printable (ETableGroup *etg);
+void e_table_group_compute_location (ETableGroup *etg,
+ gint *x,
+ gint *y,
+ gint *row,
+ gint *col);
+void e_table_group_get_mouse_over (ETableGroup *etg,
+ gint *row,
+ gint *col);
+void e_table_group_get_cell_geometry (ETableGroup *etg,
+ gint *row,
+ gint *col,
+ gint *x,
+ gint *y,
+ gint *width,
+ gint *height);
+
+/* For emitting the signals */
+void e_table_group_cursor_change (ETableGroup *etg,
+ gint row);
+void e_table_group_cursor_activated (ETableGroup *etg,
+ gint row);
+void e_table_group_double_click (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+gboolean e_table_group_right_click (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+gboolean e_table_group_click (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+gboolean e_table_group_key_press (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+gint e_table_group_start_drag (ETableGroup *etg,
+ gint row,
+ gint col,
+ GdkEvent *event);
+
+typedef void (*ETableGroupLeafFn) (gpointer e_table_item, gpointer closure);
+void e_table_group_apply_to_leafs (ETableGroup *etg,
+ ETableGroupLeafFn fn,
+ gpointer closure);
+
+G_END_DECLS
+
+#endif /* _E_TABLE_GROUP_H_ */