add misc.h with some standard enumerations with proper prefixing and capitalizations.
[mikachu/openbox.git] / openbox / screen.h
1 #ifndef __screen_h
2 #define __screen_h
3
4 #include "misc.h"
5 #include "geom.h"
6 #include "client.h"
7
8 struct Client;
9
10 #define DESKTOP_ALL (0xffffffff)
11
12 /*! The number of available desktops */
13 extern guint screen_num_desktops;
14 /*! The number of virtual "xinerama" screens/heads */
15 extern guint screen_num_monitors;
16 /*! The current desktop */
17 extern guint screen_desktop;
18 /*! Are we in showing-desktop mode? */
19 extern gboolean screen_showing_desktop;
20
21 typedef struct DesktopLayout {
22     ObOrientation orientation;
23     ObCorner start_corner;
24     guint rows;
25     guint columns;
26 } DesktopLayout;
27 extern DesktopLayout screen_desktop_layout;
28
29 /*! An array of gchar*'s which are desktop names in UTF-8 format */
30 extern char **screen_desktop_names;
31
32 /*! Take over the screen, set the basic hints on it claming it as ours */
33 gboolean screen_annex();
34
35 /*! Once the screen is ours, set up its initial state */
36 void screen_startup();
37 /*! Free resources */
38 void screen_shutdown();
39
40 /*! Figure out the new size of the screen and adjust stuff for it */
41 void screen_resize();
42
43 /*! Change the number of available desktops */
44 void screen_set_num_desktops(guint num);
45 /*! Change the current desktop */
46 void screen_set_desktop(guint num);
47
48 /*! Shows and focuses the desktop and hides all the client windows, or
49   returns to the normal state, showing client windows. */
50 void screen_show_desktop(gboolean show);
51
52 /*! Updates the desktop layout from the root property if available */
53 void screen_update_layout();
54
55 /*! Get desktop names from the root window property */
56 void screen_update_desktop_names();
57
58 /*! Installs or uninstalls a colormap for a client. If client is NULL, then
59   it handles the root colormap. */
60 void screen_install_colormap(struct Client *client, gboolean install);
61
62 void screen_update_areas();
63
64 Rect *screen_physical_area();
65
66 Rect *screen_physical_area_monitor(guint head);
67
68 Rect *screen_area(guint desktop);
69
70 Rect *screen_area_monitor(guint desktop, guint head);
71
72 #endif