[gtk+] gtktextview: document how to get line space



commit 5759e2a334993ffb4ad0f7204d8ff74a2ddb8d05
Author: Bastian Ilsø <bastianilso src gnome org>
Date:   Wed Apr 1 22:46:46 2015 +0200

    gtktextview: document how to get line space
    
    adds a paragraph to gtk_text_view_get_pixels_below_lines(),
    describing how it can be used together with
    gtk_text_view_get_pixels_above_lines() to get the total
    amount of line spacing between two paragraphs.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=747206

 gtk/gtktextview.c |    7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)
---
diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c
index cc09169..22b3a59 100644
--- a/gtk/gtktextview.c
+++ b/gtk/gtktextview.c
@@ -3009,6 +3009,8 @@ gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
  * @text_view: a #GtkTextView
  * 
  * Gets the default number of pixels to put above paragraphs.
+ * Adding this function with gtk_text_view_get_pixels_below_lines()
+ * is equal to the line space between each paragraph.
  * 
  * Returns: default number of pixels above paragraphs
  **/
@@ -3058,7 +3060,10 @@ gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
  * @text_view: a #GtkTextView
  * 
  * Gets the value set by gtk_text_view_set_pixels_below_lines().
- * 
+ *
+ * The line space is the sum of the value returned by this function and the
+ * value returned by gtk_text_view_get_pixels_above_lines().
+ *
  * Returns: default number of blank pixels below paragraphs
  **/
 gint


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