#define DESKTOP_ALL (0xffffffff)
+typedef enum {
+ SCREEN_SHOW_DESKTOP_NO,
+ SCREEN_SHOW_DESKTOP_UNTIL_WINDOW,
+ SCREEN_SHOW_DESKTOP_UNTIL_TOGGLE
+} ObScreenShowDestopMode;
+
/*! The number of available desktops */
extern guint screen_num_desktops;
/*! The number of virtual "xinerama" screens/heads */
/*! The desktop which was last visible */
extern guint screen_last_desktop;
/*! Are we in showing-desktop mode? */
-extern gboolean screen_showing_desktop;
+extern ObScreenShowDestopMode screen_show_desktop_mode;
/*! The support window also used for focus and stacking */
extern Window screen_support_win;
/*! The last time at which the user changed desktops */
guint screen_find_desktop(guint from, ObDirection dir,
gboolean wrap, gboolean linear);
-/*! Show the desktop popup/notification */
-void screen_show_desktop_popup(guint d);
+/*! Show the desktop popup/notification
+ @permanent If TRUE, the popup will stay on the screen until you call
+ screen_hide_desktop_popup(). Otherwise it will hide after a
+ delay.
+ */
+void screen_show_desktop_popup(guint d, gboolean permanent);
/*! Hide it */
void screen_hide_desktop_popup(void);
show is FALSE (restoring from show-desktop mode), and the rest are
iconified.
*/
-void screen_show_desktop(gboolean show, struct _ObClient *show_only);
+void screen_show_desktop(ObScreenShowDestopMode show_mode,
+ struct _ObClient *show_only);
+
+/*! Returns true if showing desktop mode is enabled. */
+gboolean screen_showing_desktop();
/*! Updates the desktop layout from the root property if available */
void screen_update_layout(void);
void screen_update_areas(void);
-Rect *screen_physical_area_all_monitors(void);
+const Rect* screen_physical_area_all_monitors(void);
+
+/*! Returns a Rect which is owned by the screen code and should not be freed */
+const Rect* screen_physical_area_monitor(guint head);
+
+/*! Returns the monitor which contains the active window, or the one
+ containing the pointer otherwise. */
+guint screen_monitor_active(void);
+
+/*! Returns a Rect which is owned by the screen code and should not be freed */
+const Rect* screen_physical_area_active(void);
-Rect *screen_physical_area_monitor(guint head);
+/*! Returns the primary monitor, as specified by the config.
+ @fixed If TRUE, then this will always return a fixed monitor, otherwise
+ it may change based on where focus is, or other heuristics.
+ */
+guint screen_monitor_primary(gboolean fixed);
-Rect *screen_physical_area_active(void);
+/*! Returns physical area for the primary monitor, as specified by the config.
+ @fixed If TRUE, then this will always use a fixed monitor as primary,
+ otherwise it may change based on where focus is, or other heuristics.
+ See screen_monitor_primary().
+ @return A Rect which is owned by the screen code and should not be freed
+*/
+const Rect* screen_physical_area_primary(gboolean fixed);
/* doesn't include struts which the search area is already outside of when
'search' is not NULL */
/*! @param head is the number of the head or one of SCREEN_AREA_ALL_MONITORS,
SCREEN_AREA_ONE_MONITOR
@param search NULL or the whole monitor(s)
+ @return A Rect allocated with g_slice_new()
*/
Rect* screen_area(guint desktop, guint head, Rect *search);
area of the part of the rectable on each monitor. The number of the
monitor containing the greatest area of the rectangle is returned.
*/
-guint screen_find_monitor(Rect *search);
+guint screen_find_monitor(const Rect *search);
+
+/*! Finds the monitor which contains the point @x, @y */
+guint screen_find_monitor_point(guint x, guint y);
/*! Sets the root cursor. This function decides which cursor to use, but you
gotta call it to let it know it should change. */
is on this screen and FALSE if it is on another screen. */
gboolean screen_pointer_pos(gint *x, gint *y);
+/*! Returns the monitor which contains the pointer device */
+guint screen_monitor_pointer(void);
+
+/*! Compare the desktop for two windows to see if they are considered on the
+ same desktop.
+ Windows that are on "all desktops" are treated like they are only on the
+ current desktop, so they are only in one place at a time.
+ @return TRUE if they are on the same desktop, FALSE otherwise.
+*/
+gboolean screen_compare_desktops(guint a, guint b);
+
+/*! Resolve a gravity point into absolute coordinates.
+ * width and height are the size of the object being placed, used for
+ * aligning to right/bottom edges of the area. */
+void screen_apply_gravity_point(gint *x, gint *y, gint width, gint height,
+ GravityPoint *position, const Rect *area);
#endif