[gtksourceview/wip/minimap] add description
- From: Ignacio Casal Quinteiro <icq src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview/wip/minimap] add description
- Date: Thu, 7 May 2015 13:17:34 +0000 (UTC)
commit 595ce5622eef7ebe4a1be5545a0e8b464350f0de
Author: Ignacio Casal Quinteiro <icq gnome org>
Date: Thu May 7 15:07:55 2015 +0200
add description
gtksourceview/gtksourcemap.c | 21 +++++++++++++++++++++
1 files changed, 21 insertions(+), 0 deletions(-)
---
diff --git a/gtksourceview/gtksourcemap.c b/gtksourceview/gtksourcemap.c
index 912c0c4..935efaf 100644
--- a/gtksourceview/gtksourcemap.c
+++ b/gtksourceview/gtksourcemap.c
@@ -24,6 +24,27 @@
#include <glib/gi18n.h>
+/**
+ * SECTION:map
+ * @Short_description: Widget that displays a map for a specific #GtkSourceView
+ * @Title: GtkSourceMap
+ * @See_also: #GtkSourceView
+ *
+ * #GtkSourceMap is a widget that maps the content of a #GtkSourceView into
+ * a smaller view so the user can have a quick overview of the whole document.
+ *
+ * Call gtk_source_map_set_view() or set the #GtkSourceMap:view property
+ * to set the view that the #GtkSourceMap should do the mapping from.
+ *
+ * In order to extend the internal #GtkSourceView, gtk_source_map_get_child_view()
+ * is provided. For example, one could extend it by adding a gutter that shows
+ * the changes done while editing the document.
+ *
+ * GtkSourceMap derives from #GtkBin only as an implementation detail. Applications
+ * should not use any API specific to #GtkBin to operate on this object. It should
+ * be threated a normal #GtkWidget.
+ */
+
#define DEFAULT_WIDTH 100
#define CONCEAL_TIMEOUT 2000
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]