summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Hergert <chergert@redhat.com>2022-10-31 12:42:06 -0700
committerChristian Hergert <chergert@redhat.com>2022-10-31 12:43:01 -0700
commit195edaa0ec38c6041037247a3115c7313e9f396f (patch)
treeb365b4cc8722e2fc82ef1c3e3f32358c410f5fd3
parent2840e67e03b290df76fac6349f19898d62057e13 (diff)
downloadgtksourceview-195edaa0ec38c6041037247a3115c7313e9f396f.tar.gz
completion: add note about what when is_trigger can activate
Fixes #301
-rw-r--r--gtksourceview/gtksourcecompletionprovider.c8
1 files changed, 6 insertions, 2 deletions
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index a9ce67da..d2343608 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -181,6 +181,10 @@ gtk_source_completion_provider_get_priority (GtkSourceCompletionProvider *self,
*
* An example would be period '.' which might indicate that the user wants
* to complete method or field names of an object.
+ *
+ * This method will only trigger when text is inserted into the #GtkTextBuffer
+ * while the completion list is visible and a proposal is selected. Incremental
+ * key-presses (like shift, control, or alt) are not triggerable.
*/
gboolean
gtk_source_completion_provider_is_trigger (GtkSourceCompletionProvider *self,
@@ -313,7 +317,7 @@ gtk_source_completion_provider_refilter (GtkSourceCompletionProvider *self,
*
* This function requests that the #GtkSourceCompletionProvider prepares
* @cell to display the contents of @proposal.
- *
+ *
* Based on @cells column type, you may want to display different information.
*
* This allows for columns of information among completion proposals
@@ -371,7 +375,7 @@ gtk_source_completion_provider_activate (GtkSourceCompletionProvider *self,
*
* Providers should return a list of alternates to @proposal or %NULL if
* there are no alternates available.
- *
+ *
* This can be used by the completion view to allow the user to move laterally
* through similar proposals, such as overrides of methods by the same name.
*