aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-selection-model.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-selection-model.h
parentb61331ed03ac1c7a9b8614e25510040b9c60ae02 (diff)
downloadgsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.gz
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-selection-model.h')
-rw-r--r--e-util/e-selection-model.h209
1 files changed, 209 insertions, 0 deletions
diff --git a/e-util/e-selection-model.h b/e-util/e-selection-model.h
new file mode 100644
index 0000000000..1d59e28fe1
--- /dev/null
+++ b/e-util/e-selection-model.h
@@ -0,0 +1,209 @@
+/*
+ *
+ * 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_SELECTION_MODEL_H
+#define E_SELECTION_MODEL_H
+
+#include <gtk/gtk.h>
+#include <e-util/e-sorter.h>
+
+/* Standard GObject macros */
+#define E_TYPE_SELECTION_MODEL \
+ (e_selection_model_get_type ())
+#define E_SELECTION_MODEL(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_SELECTION_MODEL, ESelectionModel))
+#define E_SELECTION_MODEL_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_CAST \
+ ((cls), E_TYPE_SELECTION_MODEL, ESelectionModelClass))
+#define E_IS_SELECTION_MODEL(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_SELECTION_MODEL))
+#define E_IS_SELECTION_MODEL_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_TYPE \
+ ((cls), E_TYPE_SELECTION_MODEL))
+#define E_SELECTION_MODEL_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS \
+ ((obj), E_TYPE_SELECTION_MODEL, ESelectionModelClass))
+
+G_BEGIN_DECLS
+
+#ifndef _E_FOREACH_FUNC_H_
+#define _E_FOREACH_FUNC_H_
+typedef void (*EForeachFunc) (gint model_row,
+ gpointer closure);
+#endif
+
+typedef struct _ESelectionModel ESelectionModel;
+typedef struct _ESelectionModelClass ESelectionModelClass;
+
+/* list selection modes */
+typedef enum {
+ E_CURSOR_LINE,
+ E_CURSOR_SIMPLE,
+ E_CURSOR_SPREADSHEET
+} ECursorMode;
+
+struct _ESelectionModel {
+ GObject parent;
+
+ ESorter *sorter;
+
+ GtkSelectionMode mode;
+ ECursorMode cursor_mode;
+
+ gint old_selection;
+};
+
+struct _ESelectionModelClass {
+ GObjectClass parent_class;
+
+ /* Virtual methods */
+ gboolean (*is_row_selected) (ESelectionModel *esm,
+ gint row);
+ void (*foreach) (ESelectionModel *esm,
+ EForeachFunc callback,
+ gpointer closure);
+ void (*clear) (ESelectionModel *esm);
+ gint (*selected_count) (ESelectionModel *esm);
+ void (*select_all) (ESelectionModel *esm);
+ void (*invert_selection) (ESelectionModel *esm);
+ gint (*row_count) (ESelectionModel *esm);
+
+ /* Protected virtual methods. */
+ void (*change_one_row) (ESelectionModel *esm,
+ gint row,
+ gboolean on);
+ void (*change_cursor) (ESelectionModel *esm,
+ gint row,
+ gint col);
+ gint (*cursor_row) (ESelectionModel *esm);
+ gint (*cursor_col) (ESelectionModel *esm);
+
+ void (*select_single_row) (ESelectionModel *selection,
+ gint row);
+ void (*toggle_single_row) (ESelectionModel *selection,
+ gint row);
+ void (*move_selection_end) (ESelectionModel *selection,
+ gint row);
+ void (*set_selection_end) (ESelectionModel *selection,
+ gint row);
+
+ /* Signals */
+ void (*cursor_changed) (ESelectionModel *esm,
+ gint row,
+ gint col);
+ void (*cursor_activated) (ESelectionModel *esm,
+ gint row,
+ gint col);
+ void (*selection_row_changed)(ESelectionModel *esm,
+ gint row);
+ void (*selection_changed) (ESelectionModel *esm);
+};
+
+GType e_selection_model_get_type (void);
+void e_selection_model_do_something (ESelectionModel *esm,
+ guint row,
+ guint col,
+ GdkModifierType state);
+gboolean e_selection_model_maybe_do_something
+ (ESelectionModel *esm,
+ guint row,
+ guint col,
+ GdkModifierType state);
+void e_selection_model_right_click_down
+ (ESelectionModel *selection,
+ guint row,
+ guint col,
+ GdkModifierType state);
+void e_selection_model_right_click_up
+ (ESelectionModel *selection);
+gboolean e_selection_model_key_press (ESelectionModel *esm,
+ GdkEventKey *key);
+void e_selection_model_select_as_key_press
+ (ESelectionModel *esm,
+ guint row,
+ guint col,
+ GdkModifierType state);
+
+/* Virtual functions */
+gboolean e_selection_model_is_row_selected
+ (ESelectionModel *esm,
+ gint n);
+void e_selection_model_foreach (ESelectionModel *esm,
+ EForeachFunc callback,
+ gpointer closure);
+void e_selection_model_clear (ESelectionModel *esm);
+gint e_selection_model_selected_count
+ (ESelectionModel *esm);
+void e_selection_model_select_all (ESelectionModel *esm);
+void e_selection_model_invert_selection
+ (ESelectionModel *esm);
+gint e_selection_model_row_count (ESelectionModel *esm);
+
+/* Private virtual Functions */
+void e_selection_model_change_one_row
+ (ESelectionModel *esm,
+ gint row,
+ gboolean on);
+void e_selection_model_change_cursor (ESelectionModel *esm,
+ gint row,
+ gint col);
+gint e_selection_model_cursor_row (ESelectionModel *esm);
+gint e_selection_model_cursor_col (ESelectionModel *esm);
+void e_selection_model_select_single_row
+ (ESelectionModel *selection,
+ gint row);
+void e_selection_model_toggle_single_row
+ (ESelectionModel *selection,
+ gint row);
+void e_selection_model_move_selection_end
+ (ESelectionModel *selection,
+ gint row);
+void e_selection_model_set_selection_end
+ (ESelectionModel *selection,
+ gint row);
+
+/* Signals */
+void e_selection_model_cursor_changed
+ (ESelectionModel *selection,
+ gint row,
+ gint col);
+void e_selection_model_cursor_activated
+ (ESelectionModel *selection,
+ gint row,
+ gint col);
+void e_selection_model_selection_row_changed
+ (ESelectionModel *selection,
+ gint row);
+void e_selection_model_selection_changed
+ (ESelectionModel *selection);
+
+G_END_DECLS
+
+#endif /* E_SELECTION_MODEL_H */
+