[gtksourceview] Added documentation for get_interactive_delay and get_priority



commit 1f8f61dc46e79896da08f1b6f0269d815fa22b9f
Author: Jesse van den Kieboom <jesse vandenkieboom epfl ch>
Date:   Fri Jan 1 23:19:38 2010 +0100

    Added documentation for get_interactive_delay and get_priority

 docs/reference/gtksourceview-2.0-sections.txt |   10 +++++-----
 gtksourceview/gtksourcecompletionprovider.c   |   22 ++++++++++++++++++++++
 2 files changed, 27 insertions(+), 5 deletions(-)
---
diff --git a/docs/reference/gtksourceview-2.0-sections.txt b/docs/reference/gtksourceview-2.0-sections.txt
index 5adfb73..6e4df8c 100644
--- a/docs/reference/gtksourceview-2.0-sections.txt
+++ b/docs/reference/gtksourceview-2.0-sections.txt
@@ -424,13 +424,14 @@ GtkSourceCompletionProvider
 gtk_source_completion_provider_get_name
 gtk_source_completion_provider_get_icon
 gtk_source_completion_provider_populate
-gtk_source_completion_provider_get_interactive
-gtk_source_completion_provider_get_default
+gtk_source_completion_provider_get_activation
 gtk_source_completion_provider_match
 gtk_source_completion_provider_get_info_widget
 gtk_source_completion_provider_update_info
 gtk_source_completion_provider_get_start_iter
 gtk_source_completion_provider_activate_proposal
+gtk_source_completion_provider_get_interactive_delay
+gtk_source_completion_provider_get_priority
 <SUBSECTION Standard>
 GTK_IS_SOURCE_COMPLETION_PROVIDER
 GTK_SOURCE_COMPLETION_PROVIDER
@@ -442,15 +443,14 @@ GtkSourceCompletionProviderIface
 
 <SECTION>
 <FILE>completioncontext</FILE>
+GtkSourceCompletionActivation
 <TITLE>GtkSourceCompletionContext</TITLE>
 <INCLUDE>gtksourceview/gtksourcecompletioncontext.h</INCLUDE>
 GtkSourceCompletionContext
 gtk_source_completion_context_add_proposals
 gtk_source_completion_context_get_view
 gtk_source_completion_context_get_iter
-gtk_source_completion_context_get_interactive
-gtk_source_completion_context_get_default
-gtk_source_completion_context_move_window
+gtk_source_completion_context_get_activation
 <SUBSECTION Standard>
 GTK_IS_SOURCE_COMPLETION_CONTEXT
 GTK_IS_SOURCE_COMPLETION_CONTEXT_CLASS
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index f6def2a..927776a 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -361,6 +361,17 @@ gtk_source_completion_provider_activate_proposal (GtkSourceCompletionProvider *p
 	                                                                                   iter);
 }
 
+/**
+ * gtk_source_completion_provider_get_interactive_delay:
+ * @provider: A # GtkSourceCompletionProvider
+ *
+ * Get the delay in milliseconds before starting interactive completion for
+ * this provider. A value of -1 indicates to use the default value as set
+ * by #GtkSourceCompletion::auto-complete-delay.
+ *
+ * Returns: the interactive delay in milliseconds.
+ *
+ **/
 gint
 gtk_source_completion_provider_get_interactive_delay (GtkSourceCompletionProvider *provider)
 {
@@ -369,6 +380,17 @@ gtk_source_completion_provider_get_interactive_delay (GtkSourceCompletionProvide
 	return GTK_SOURCE_COMPLETION_PROVIDER_GET_INTERFACE (provider)->get_interactive_delay (provider);
 }
 
+/**
+ * gtk_source_completion_provider_get_priority:
+ * @provider: A # GtkSourceCompletionProvider
+ *
+ * Get the provider priority. The priority determines the order in which
+ * proposals appear in the completion popup. Higher priorities are sorted
+ * before lower priorities. The default priority is 0.
+ *
+ * Returns: the provider priority.
+ *
+ **/
 gint
 gtk_source_completion_provider_get_priority (GtkSourceCompletionProvider *provider)
 {



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