[gtk+] Improve workarea documentation



commit 4f76f18b9f74bbeb997d49d2ae2396b7762e9bf1
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Sep 24 20:34:16 2014 -0400

    Improve workarea documentation
    
    Worth mentioning that workarea may not exist, and that we
    return the full monitor geometry in that case.

 gdk/gdkscreen.c |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c
index cc170c5..146e5af 100644
--- a/gdk/gdkscreen.c
+++ b/gdk/gdkscreen.c
@@ -845,6 +845,10 @@ gdk_screen_get_monitor_geometry (GdkScreen    *screen,
  * similar popups, to avoid placing them below panels, docks or other
  * desktop components.
  *
+ * Note that not all backends may have a concept of workarea. This
+ * function will return the monitor geometry if a workarea is not
+ * available, or does not apply.
+ *
  * Monitor numbers start at 0. To obtain the number of monitors of
  * @screen, use gdk_screen_get_n_monitors().
  *


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