aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-cell-text.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-text.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-text.h')
-rw-r--r--e-util/e-cell-text.h195
1 files changed, 195 insertions, 0 deletions
diff --git a/e-util/e-cell-text.h b/e-util/e-cell-text.h
new file mode 100644
index 0000000000..740b87fec7
--- /dev/null
+++ b/e-util/e-cell-text.h
@@ -0,0 +1,195 @@
+/*
+ * Text cell renderer.
+ *
+ * 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)
+ *
+ * A lot of code taken from:
+ *
+ * Text item type for GnomeCanvas widget
+ *
+ * GnomeCanvas is basically a port of the Tk toolkit's most excellent
+ * canvas widget. Tk is copyrighted by the Regents of the University
+ * of California, Sun Microsystems, and other parties.
+ *
+ * Copyright (C) 1998 The Free Software Foundation
+ *
+ * Author: Federico Mena <federico@nuclecu.unam.mx>
+ *
+ */
+
+#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
+#error "Only <e-util/e-util.h> should be included directly."
+#endif
+
+#ifndef E_CELL_TEXT_H
+#define E_CELL_TEXT_H
+
+#include <gtk/gtk.h>
+#include <libgnomecanvas/libgnomecanvas.h>
+
+#include <e-util/e-cell.h>
+
+/* Standard GObject macros */
+#define E_TYPE_CELL_TEXT \
+ (e_cell_text_get_type ())
+#define E_CELL_TEXT(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_CELL_TEXT, ECellText))
+#define E_CELL_TEXT_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_CAST \
+ ((cls), E_TYPE_CELL_TEXT, ECellTextClass))
+#define E_IS_CELL_TEXT(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_CELL_TEXT))
+#define E_IS_CELL_TEXT_CLASS(cls) \
+ (G_TYPE_CHECK_CLASS_TYPE \
+ ((cls), E_TYPE_CELL_TEXT))
+#define E_CELL_TEXT_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS \
+ ((obj), E_TYPE_CELL_TEXT, ECellTextClass))
+
+G_BEGIN_DECLS
+
+typedef struct _ECellText ECellText;
+typedef struct _ECellTextClass ECellTextClass;
+
+struct _ECellText {
+ ECell parent;
+
+ GtkJustification justify;
+ gchar *font_name;
+
+ gdouble x, y; /* Position at anchor */
+
+ gulong pixel; /* Fill color */
+
+ /* Clip handling */
+ gchar *ellipsis; /* The ellipsis characters. NULL = "...". */
+
+ guint use_ellipsis : 1; /* Whether to use the ellipsis. */
+ guint editable : 1; /* Whether the text can be edited. */
+
+ gint strikeout_column;
+ gint underline_column;
+ gint bold_column;
+
+ /* This column in the ETable should return a string specifying a color,
+ * either a color name like "red" or a color spec like "rgb:F/0/0".
+ * See the XParseColor man page for the formats available. */
+ gint color_column;
+ gint bg_color_column;
+};
+
+struct _ECellTextClass {
+ ECellClass parent_class;
+
+ /* Methods */
+ gchar * (*get_text) (ECellText *cell,
+ ETableModel *model,
+ gint col,
+ gint row);
+ void (*free_text) (ECellText *cell,
+ gchar *text);
+ void (*set_value) (ECellText *cell,
+ ETableModel *model,
+ gint col,
+ gint row,
+ const gchar *text);
+
+ /* Signals */
+ void (*text_inserted) (ECellText *cell,
+ ECellView *cell_view,
+ gint pos,
+ gint len,
+ gint row,
+ gint model_col);
+ void (*text_deleted) (ECellText *cell,
+ ECellView *cell_view,
+ gint pos,
+ gint len,
+ gint row,
+ gint model_col);
+};
+
+GType e_cell_text_get_type (void) G_GNUC_CONST;
+ECell * e_cell_text_new (const gchar *fontname,
+ GtkJustification justify);
+ECell * e_cell_text_construct (ECellText *cell,
+ const gchar *fontname,
+ GtkJustification justify);
+
+/* Gets the value from the model and converts it into a string. In ECellText
+ * itself, the value is assumed to be a gchar * and so needs no conversion.
+ * In subclasses the ETableModel value may be a more complicated datatype. */
+gchar * e_cell_text_get_text (ECellText *cell,
+ ETableModel *model,
+ gint col,
+ gint row);
+
+/* Frees the value returned by e_cell_text_get_text(). */
+void e_cell_text_free_text (ECellText *cell,
+ gchar *text);
+
+/* Sets the ETableModel value, based on the given string. */
+void e_cell_text_set_value (ECellText *cell,
+ ETableModel *model,
+ gint col,
+ gint row,
+ const gchar *text);
+
+/* Sets the selection of given text cell */
+gboolean e_cell_text_set_selection (ECellView *cell_view,
+ gint col,
+ gint row,
+ gint start,
+ gint end);
+
+/* Gets the selection of given text cell */
+gboolean e_cell_text_get_selection (ECellView *cell_view,
+ gint col,
+ gint row,
+ gint *start,
+ gint *end);
+
+/* Copys the selected text to the clipboard */
+void e_cell_text_copy_clipboard (ECellView *cell_view,
+ gint col,
+ gint row);
+
+/* Pastes the text from the clipboard */
+void e_cell_text_paste_clipboard (ECellView *cell_view,
+ gint col,
+ gint row);
+
+/* Deletes selected text */
+void e_cell_text_delete_selection (ECellView *cell_view,
+ gint col,
+ gint row);
+
+/* get text directly from view, both col and row are model format */
+gchar * e_cell_text_get_text_by_view (ECellView *cell_view,
+ gint col,
+ gint row);
+
+G_END_DECLS
+
+#endif /* E_CELL_TEXT_H */
+