[gtksourceview] Document GtkSourceCompletionProvider vfuncs



commit 0f39795b8b224c98dc6c6de19ca45983f15d8fde
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Mar 16 23:49:48 2013 +0100

    Document GtkSourceCompletionProvider vfuncs

 docs/reference/gtksourceview-3.0-sections.txt |    2 +-
 gtksourceview/gtksourcecompletionprovider.h   |   28 +++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/gtksourceview-3.0-sections.txt b/docs/reference/gtksourceview-3.0-sections.txt
index 4cb9933..1e82636 100644
--- a/docs/reference/gtksourceview-3.0-sections.txt
+++ b/docs/reference/gtksourceview-3.0-sections.txt
@@ -541,6 +541,7 @@ GtkSourceCompletionItemPrivate
 <FILE>completionprovider</FILE>
 <TITLE>GtkSourceCompletionProvider</TITLE>
 GtkSourceCompletionProvider
+GtkSourceCompletionProviderIface
 gtk_source_completion_provider_get_name
 gtk_source_completion_provider_get_icon
 gtk_source_completion_provider_populate
@@ -558,7 +559,6 @@ GTK_SOURCE_COMPLETION_PROVIDER
 GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE
 GTK_SOURCE_TYPE_COMPLETION_PROVIDER
 gtk_source_completion_provider_get_type
-GtkSourceCompletionProviderIface
 </SECTION>
 
 <SECTION>
diff --git a/gtksourceview/gtksourcecompletionprovider.h b/gtksourceview/gtksourcecompletionprovider.h
index 70887f5..e6a1e70 100644
--- a/gtksourceview/gtksourcecompletionprovider.h
+++ b/gtksourceview/gtksourcecompletionprovider.h
@@ -36,6 +36,34 @@ G_BEGIN_DECLS
 
 typedef struct _GtkSourceCompletionProviderIface GtkSourceCompletionProviderIface;
 
+/**
+ * GtkSourceCompletionProviderIface:
+ * @g_iface: The parent interface.
+ * @get_name: The virtual function pointer for gtk_source_completion_provider_get_name().
+ * Must be implemented.
+ * @get_icon: The virtual function pointer for gtk_source_completion_provider_get_icon().
+ * By default, %NULL is returned.
+ * @populate: The virtual function pointer for gtk_source_completion_provider_populate().
+ * Add no proposals by default.
+ * @match: The virtual function pointer for gtk_source_completion_provider_match().
+ * By default, %TRUE is returned.
+ * @get_activation: The virtual function pointer for gtk_source_completion_provider_get_activation().
+ * The combination of all #GtkSourceCompletionActivation is returned by default.
+ * @get_info_widget: The virtual function pointer for gtk_source_completion_provider_get_info_widget().
+ * By default, %NULL is returned.
+ * @update_info: The virtual function pointer for gtk_source_completion_provider_update_info().
+ * Does nothing by default.
+ * @get_start_iter: The virtual function pointer for gtk_source_completion_provider_get_start_iter().
+ * By default, %FALSE is returned.
+ * @activate_proposal: The virtual function pointer for gtk_source_completion_provider_activate_proposal().
+ * By default, %FALSE is returned.
+ * @get_interactive_delay: The virtual function pointer for 
gtk_source_completion_provider_get_interactive_delay().
+ * By default, -1 is returned.
+ * @get_priority: The virtual function pointer for gtk_source_completion_provider_get_priority().
+ * By default, 0 is returned.
+ *
+ * The virtual function table for #GtkSourceCompletionProvider.
+ */
 struct _GtkSourceCompletionProviderIface
 {
        GTypeInterface g_iface;


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