summaryrefslogtreecommitdiff
path: root/gdk/gdkscreen.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2014-09-24 20:34:16 -0400
committerMatthias Clasen <mclasen@redhat.com>2014-09-24 20:34:16 -0400
commit4f76f18b9f74bbeb997d49d2ae2396b7762e9bf1 (patch)
tree5d37519f642b8fd63b49159d16ed96427f0ae205 /gdk/gdkscreen.c
parent46ff5ef6ce71322b85f05655617280c0b25ec7f6 (diff)
downloadgtk+-4f76f18b9f74bbeb997d49d2ae2396b7762e9bf1.tar.gz
Improve workarea documentation
Worth mentioning that workarea may not exist, and that we return the full monitor geometry in that case.
Diffstat (limited to 'gdk/gdkscreen.c')
-rw-r--r--gdk/gdkscreen.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c
index cc170c5b4b..146e5af192 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().
*