[gtksourceview/gnome-2-30] Added documentation for the ::move-lines signal



commit 391a4a05bd07df82b0eea491568faf9123b47296
Author: Jesse van den Kieboom <jesse vandenkieboom epfl ch>
Date:   Mon May 17 09:31:01 2010 +0200

    Added documentation for the ::move-lines signal

 gtksourceview/gtksourceview.c |   16 ++++++++++++++++
 1 files changed, 16 insertions(+), 0 deletions(-)
---
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index dab5868..d9ba1c1 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -542,6 +542,22 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
 			      GTK_TYPE_TEXT_ITER,
 			      GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
 
+	/**
+	 * GtkSourceView::move-lines:
+	 * @view: the #GtkSourceView which received the signal
+	 * @copy: %TRUE if the line should be copied,
+	 *        %FALSE if it should be moved
+	 * @count: the number of lines to move over.
+	 *
+	 * The ::move-lines signal is a keybinding which gets emitted
+	 * when the user initiates moving a line. The default binding key
+	 * is Alt+Up/Down arrow. And moves the currently selected lines,
+	 * or the current line by @count. For the moment, only
+	 * @count of -1 or 1 is valid.
+	 *
+	 * Since: 2.10
+	 *
+	 */
 	signals [MOVE_LINES] =
 		g_signal_new ("move-lines",
 			      G_TYPE_FROM_CLASS (klass),



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