Add a primaryMonitor config option, where the focus-cycle and keychain popups will...

[chaz/openbox] / openbox / screen.h

diff --git a/openbox/screen.h b/openbox/screen.h
index 07a2cae02dda036716a621feb724094d4d52f6d8..7df47f396fca396f3094ad595d1c52e4e236416f 100644 (file)
--- a/openbox/screen.h
+++ b/openbox/screen.h
@@ -1,7 +1,7 @@
 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
 
    screen.h for the Openbox window manager
-   Copyright (c) 2003        Ben Jansens
+   Copyright (c) 2003-2007   Dana Jansens
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -38,14 +38,16 @@ extern guint screen_last_desktop;
 extern gboolean screen_showing_desktop;
 /*! The support window also used for focus and stacking */
 extern Window screen_support_win;
+/*! The last time at which the user changed desktops */
+extern Time screen_desktop_user_time;
 
-typedef struct DesktopLayout {
+typedef struct ObDesktopLayout {
     ObOrientation orientation;
     ObCorner start_corner;
     guint rows;
     guint columns;
-} DesktopLayout;
-extern DesktopLayout screen_desktop_layout;
+} ObDesktopLayout;
+extern ObDesktopLayout screen_desktop_layout;
 
 /*! An array of gchar*'s which are desktop names in UTF-8 format */
 extern gchar **screen_desktop_names;
@@ -64,17 +66,27 @@ void screen_resize();
 /*! Change the number of available desktops */
 void screen_set_num_desktops(guint num);
 /*! Change the current desktop */
-void screen_set_desktop(guint num);
-/*! Interactively change desktops */
-guint screen_cycle_desktop(ObDirection dir, gboolean wrap, gboolean linear,
-                           gboolean dialog, gboolean done, gboolean cancel);
+void screen_set_desktop(guint num, gboolean dofocus);
+/*! Add a new desktop either at the end or inserted at the current desktop */
+void screen_add_desktop(gboolean current);
+/*! Remove a desktop, either at the end or the current desktop */
+void screen_remove_desktop(gboolean current);
 
-/*! Show/hide the desktop popup (pager) for the given desktop */
-void screen_desktop_popup(guint d, gboolean show);
+guint screen_find_desktop(guint from, ObDirection dir,
+                          gboolean wrap, gboolean linear);
+
+/*! Show the desktop popup/notification */
+void screen_show_desktop_popup(guint d);
+/*! Hide it */
+void screen_hide_desktop_popup();
 
 /*! Shows and focuses the desktop and hides all the client windows, or
-  returns to the normal state, showing client windows. */
-void screen_show_desktop(gboolean show);
+  returns to the normal state, showing client windows.
+  @param If show_only is non-NULL, then only that client is shown (assuming
+         show is FALSE (restoring from show-desktop mode), and the rest are
+         iconified.
+*/
+void screen_show_desktop(gboolean show, struct _ObClient *show_only);
 
 /*! Updates the desktop layout from the root property if available */
 void screen_update_layout();
@@ -88,23 +100,49 @@ void screen_install_colormap(struct _ObClient *client, gboolean install);
 
 void screen_update_areas();
 
-Rect *screen_physical_area();
+Rect *screen_physical_area_all_monitors();
 
 Rect *screen_physical_area_monitor(guint head);
 
-Rect *screen_area(guint desktop);
+/*! Returns the monitor which contains the active window, or the one
+  containing the pointer otherwise. */
+guint screen_monitor_active(void);
+
+Rect *screen_physical_area_active(void);
+
+/*! Returns the primary monitor, as specified by the config */
+guint screen_monitor_primary(void);
+
+Rect *screen_physical_area_primary(void);
 
-Rect *screen_area_monitor(guint desktop, guint head);
+/* doesn't include struts which the search area is already outside of when
+   'search' is not NULL */
+#define SCREEN_AREA_ALL_MONITORS ((unsigned)-1)
+#define SCREEN_AREA_ONE_MONITOR  ((unsigned)-2)
+
+/*! @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)
+ */
+Rect* screen_area(guint desktop, guint head, Rect *search);
+
+gboolean screen_physical_area_monitor_contains(guint head, Rect *search);
 
 /*! Determines which physical monitor a rectangle is on by calculating the
     area of the part of the rectable on each monitor.  The number of the
-    monitor containing the greatest area of the rectangle is returned.*/
+    monitor containing the greatest area of the rectangle is returned.
+*/
 guint screen_find_monitor(Rect *search);
 
 /*! Sets the root cursor. This function decides which cursor to use, but you
   gotta call it to let it know it should change. */
 void screen_set_root_cursor();
 
+/*! Gives back the pointer's position in x and y. Returns TRUE if the pointer
+  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);
+
 #endif