X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fscreen.h;h=a6a3995b30a2aa3fcbbaf33ca61e73092386144c;hb=HEAD;hp=ccaa4f5726edb486efd68994465e9c2654f1c6e6;hpb=740c8af41e77a0cf5a748a7530d19405ad6739c0;p=chaz%2Fopenbox

diff --git a/openbox/screen.h b/openbox/screen.h
index ccaa4f57..a6a3995b 100644
--- a/openbox/screen.h
+++ b/openbox/screen.h
@@ -41,19 +41,19 @@ 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;
 
 /*! Take over the screen, set the basic hints on it claming it as ours */
-gboolean screen_annex(const gchar *program_name);
+gboolean screen_annex(void);
 
 /*! Once the screen is ours, set up its initial state */
 void screen_startup(gboolean reconfig);
@@ -61,52 +61,115 @@ void screen_startup(gboolean reconfig);
 void screen_shutdown(gboolean reconfig);
 
 /*! Figure out the new size of the screen and adjust stuff for it */
-void screen_resize();
+void screen_resize(void);
 
 /*! Change the number of available desktops */
 void screen_set_num_desktops(guint num);
 /*! Change the current desktop */
 void screen_set_desktop(guint num, gboolean dofocus);
-/*! Interactively change desktops */
-guint screen_cycle_desktop(ObDirection dir, gboolean wrap, gboolean linear,
-                           gboolean dialog, gboolean done, gboolean cancel);
-
-/*! Show/hide the desktop popup (pager) for the given desktop */
-void screen_desktop_popup(guint d, gboolean show);
+/*! 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);
+
+guint screen_find_desktop(guint from, ObDirection dir,
+                          gboolean wrap, gboolean linear);
+
+/*! 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);
 
 /*! 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, gboolean restore_focus);
+  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();
+void screen_update_layout(void);
 
 /*! Get desktop names from the root window property */
-void screen_update_desktop_names();
+void screen_update_desktop_names(void);
 
 /*! Installs or uninstalls a colormap for a client. If client is NULL, then
   it handles the root colormap. */
 void screen_install_colormap(struct _ObClient *client, gboolean install);
 
-void screen_update_areas();
+void screen_update_areas(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);
 
-Rect *screen_physical_area();
+/*! Returns the monitor which contains the active window, or the one
+  containing the pointer otherwise. */
+guint screen_monitor_active(void);
 
-Rect *screen_physical_area_monitor(guint head);
+/*! Returns a Rect which is owned by the screen code and should not be freed */
+const Rect* screen_physical_area_active(void);
+
+/*! 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);
+
+/*! 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);
 
-Rect *screen_area(guint desktop);
+/* 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)
 
-Rect *screen_area_monitor(guint desktop, guint head);
+/*! @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);
+
+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.*/
-guint screen_find_monitor(Rect *search);
+    monitor containing the greatest area of the rectangle is returned.
+*/
+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. */
-void screen_set_root_cursor();
+void screen_set_root_cursor(void);
 
+/*! 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);
+
+/*! 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);
+
 #endif