[vte] widget: Document how to scroll a VteTerminal



commit 4822e237e1072e1f44825f578a8b8711dfc34e91
Author: Christian Persch <chpe gnome org>
Date:   Sat Jan 16 19:15:29 2016 +0100

    widget: Document how to scroll a VteTerminal
    
    A GtkScrolledWindow cannot be used since it is incompatible
    with VteTerminal. Document that.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=760718

 src/vtegtk.cc |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/src/vtegtk.cc b/src/vtegtk.cc
index 326e880..fd8214e 100644
--- a/src/vtegtk.cc
+++ b/src/vtegtk.cc
@@ -21,6 +21,12 @@
  * @short_description: A terminal widget implementation
  *
  * A VteTerminal is a terminal emulator implemented as a GTK3 widget.
+ *
+ * Note that altough #VteTerminal implements the #GtkScrollable interface,
+ * you should not place a #VteTerminal inside a #GtkScrolledWindow
+ * container, since they are incompatible. Instead, pack the terminal in
+ * a horizontal #GtkBox together with a #GtkScrollbar which uses the
+ * #GtkAdjustment returned from gtk_scrollable_get_vadjustment().
  */
 
 #include "config.h"


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