Improve workarea documentation

Worth mentioning that workarea may not exist, and that we
return the full monitor geometry in that case.
This commit is contained in:
Matthias Clasen
2014-09-24 20:34:16 -04:00
parent 46ff5ef6ce
commit 4f76f18b9f

View File

@ -845,6 +845,10 @@ gdk_screen_get_monitor_geometry (GdkScreen *screen,
* similar popups, to avoid placing them below panels, docks or other * similar popups, to avoid placing them below panels, docks or other
* desktop components. * 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 * Monitor numbers start at 0. To obtain the number of monitors of
* @screen, use gdk_screen_get_n_monitors(). * @screen, use gdk_screen_get_n_monitors().
* *