[gtksourceview] Doc: explain when to hide a CompletionInfo window



commit d08c2c6fab2d0534297689d5b23c0dcb059ea740
Author: SÃbastien Wilmet <swilmet gnome org>
Date:   Sun Jan 27 15:48:32 2013 +0100

    Doc: explain when to hide a CompletionInfo window

 gtksourceview/gtksourcecompletioninfo.c |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)
---
diff --git a/gtksourceview/gtksourcecompletioninfo.c b/gtksourceview/gtksourcecompletioninfo.c
index 5ab3baa..de6e2ed 100644
--- a/gtksourceview/gtksourcecompletioninfo.c
+++ b/gtksourceview/gtksourcecompletioninfo.c
@@ -46,6 +46,13 @@
  * gtk_container_add (GTK_CONTAINER (info), scrolled_window);
  *   </programlisting>
  * </example>
+ *
+ * If the calltip is displayed on top of a certain widget, say a #GtkTextView,
+ * you should hide it when the #GtkWidget::focus-out-event signal is emitted by
+ * the #GtkTextView. You may also be interested by the
+ * #GtkTextBuffer:cursor-position property (when its value is modified). If you
+ * use the #GtkSourceCompletionInfo through the #GtkSourceCompletion machinery,
+ * you don't need to worry about this.
  */
 
 #include <gtksourceview/gtksourcecompletioninfo.h>



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