1 // -*- mode: C++; indent-tabs-mode: nil; -*-
6 @brief The main class for the Openbox window manager
10 cuz girls look soooo goood.. on the end of my DICK
22 #include "otk/screeninfo.hh"
23 #include "otk/timerqueuemanager.hh"
24 #include "otk/property.hh"
25 #include "otk/configuration.hh"
26 #include "xeventhandler.hh"
33 //! The main class for the Openbox window manager.
35 Only a single instance of the Openbox class may be used in the application. A
36 pointer to this instance is held in the Openbox::instance static member
38 Instantiation of this class begins the window manager. After instantiation,
39 the Openbox::eventLoop function should be called. The eventLoop method does
40 not exit until the window manager is ready to be destroyed. Destruction of
41 the Openbox class instance will shutdown the window manager.
46 //! The single instance of the Openbox class for the application.
48 Since this variable is globally available in the application, the Openbox
49 class does not need to be passed around to any of the other classes.
51 static Openbox
*instance
;
53 //! The posible running states of the window manager
55 State_Starting
, //!< The window manager is starting up (being created)
56 State_Normal
, //!< The window manager is running in its normal state
57 State_Exiting
//!< The window manager is exiting (being destroyed)
60 //! Mouse cursors used throughout Openbox
62 Cursor session
; //!< The default mouse cursor
63 Cursor move
; //!< For moving a window
64 Cursor ll_angle
; //!< For resizing the bottom left corner of a window
65 Cursor lr_angle
; //!< For resizing the bottom right corner of a window
66 Cursor ul_angle
; //!< For resizing the top left corner of a window
67 Cursor ur_angle
; //!< For resizing the right corner of a window
70 //! A map for looking up a specific client class from the window id
71 typedef std::map
<Window
, OBClient
*> ClientMap
;
73 //! A list of OBScreen classes
74 typedef std::vector
<OBScreen
*> ScreenList
;
77 // stuff that can be passed on the command line
78 //! Path to the config file to use/in use
80 Defaults to $(HOME)/.openbox/rc3
82 std::string _rcfilepath
;
83 //! Path to the menu file to use/in use
85 Defaults to $(HOME)/.openbox/menu3
87 std::string _menufilepath
;
88 //! The display requested by the user, or null to use the DISPLAY env var
90 //! The value of argv[0], i.e. how this application was executed
93 //! A list of all managed clients
96 //! A list of all the managed screens
99 //! Manages all timers for the application
101 Use of the otk::OBTimerQueueManager::fire funtion in this object ensures
102 that all timers fire when their times elapse.
104 otk::OBTimerQueueManager _timermanager
;
106 //! The class which will handle raw XEvents
107 OBXEventHandler _xeventhandler
;
109 //! Cached atoms on the display
111 This is a pointer because the OBProperty class uses otk::OBDisplay::display
112 in its constructor, so, it needs to be initialized <b>after</b> the display
113 is initialized in this class' constructor.
115 otk::OBProperty
*_property
;
117 //! The running state of the window manager
120 //! Mouse cursors used throughout Openbox
123 //! When set to true, the Openbox::eventLoop function will stop and return
126 //! The configuration of the application. TEMPORARY
127 otk::Configuration _config
;
129 //! Parses the command line used when executing this application
130 void parseCommandLine(int argv
, char **argv
);
131 //! Displays the version string to stdout
133 //! Displays usage information and help to stdout
136 //! Handles signal events for the application
137 static void signalHandler(int signal
);
140 //! Openbox constructor.
142 \param argc Number of command line arguments, as received in main()
143 \param argv The command line arguments, as received in main()
145 Openbox(int argc
, char **argv
);
146 //! Openbox destructor.
149 //! Returns the state of the window manager (starting, exiting, etc)
150 inline RunState
state() const { return _state
; }
152 //! Returns the otk::OBTimerQueueManager for the application
154 All otk::OBTimer objects used in the application should be made to use this
155 otk::OBTimerQueueManager.
157 inline otk::OBTimerQueueManager
*timerManager() { return &_timermanager
; }
159 //! Returns the otk::OBProperty instance for the window manager
160 inline const otk::OBProperty
*property() const { return _property
; }
162 //! Returns a managed screen
163 inline OBScreen
*screen(int num
) {
164 assert(num
>= 0); assert(num
< (signed)_screens
.size());
165 return _screens
[num
];
168 //! Returns the mouse cursors used throughout Openbox
169 inline const Cursors
&cursors() const { return _cursors
; }
171 //! The main function of the Openbox class
173 This function should be called after instantiating the Openbox class.
174 It loops indefinately while handling all events for the application.
175 The Openbox::shutdown method will cause this function to exit.
179 //! Adds an OBClient to the client list for lookups
180 void addClient(Window window
, OBClient
*client
);
182 //! Removes an OBClient from the client list for lookups
183 void removeClient(Window window
);
185 //! Finds an OBClient based on its window id
186 OBClient
*findClient(Window window
);
188 //! Requests that the window manager exit
190 Causes the Openbox::eventLoop function to stop looping, so that the window
191 manager can be destroyed.
193 inline void shutdown() { _doshutdown
= true; }
198 #endif // __openbox_hh