[gtk+] Document that gtk_widget_queue_draw_area is in widget coordinates



commit 96af68529bfdd0eeecaa8bc3caa7bb03576b1e5f
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Jan 26 18:19:35 2011 -0500

    Document that gtk_widget_queue_draw_area is in widget coordinates

 gtk/gtkwidget.c |    8 +++++++-
 1 files changed, 7 insertions(+), 1 deletions(-)
---
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 9ce1c8c..00343bf 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -4503,7 +4503,13 @@ gtk_widget_queue_draw_region (GtkWidget      *widget,
  *
  * Convenience function that calls gtk_widget_queue_draw_region() on
  * the region created from the given coordinates.
- **/
+ *
+ * The region here is specified in widget coordinates.
+ * Widget coordinates are a bit odd; for historical reasons, they are
+ * defined as @widget->window coordinates for widgets that are not
+ * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
+ * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
+ */
 void
 gtk_widget_queue_draw_area (GtkWidget *widget,
 			    gint       x,



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