[gtksourceview] Documentation section for CompletionContext



commit a3e4889ea84b7f57b1f221f3a970f18f4cf6ffa3
Author: SÃbastien Wilmet <swilmet src gnome org>
Date:   Thu Jul 5 02:09:32 2012 +0200

    Documentation section for CompletionContext
    
    https://bugzilla.gnome.org/show_bug.cgi?id=679426

 gtksourceview/gtksourcecompletioncontext.c |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/gtksourceview/gtksourcecompletioncontext.c b/gtksourceview/gtksourcecompletioncontext.c
index 167dc4f..32d89cf 100644
--- a/gtksourceview/gtksourcecompletioncontext.c
+++ b/gtksourceview/gtksourcecompletioncontext.c
@@ -19,6 +19,28 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+/**
+ * SECTION:completioncontext
+ * @title: GtkSourceCompletionContext
+ * @short_description: The context of a completion
+ *
+ * A completion context is created when a completion occurs. The completion can
+ * be activated by several means, listed in #GtkSourceCompletionActivation.
+ *
+ * The completion can be activated by user request, i.e. when the user presses
+ * <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo>, by default.
+ *
+ * The completion can also be activated interactively, on each insertion or
+ * deletion in the #GtkTextBuffer.
+ *
+ * A #GtkTextIter is associated with the context, this is where the completion
+ * takes place. With this #GtkTextIter, you can get the associated
+ * #GtkTextBuffer with gtk_text_iter_get_buffer().
+ *
+ * Once the context is created, the eligible providers are asked to add
+ * proposals with gtk_source_completion_context_add_proposals().
+ */
+
 #include "gtksourcecompletioncontext.h"
 #include "gtksourceview-typebuiltins.h"
 #include "gtksourcecompletionprovider.h"



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]