]>
Dogcows Code - chaz/openbox/blob - src/openbox.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
6 @brief The main class for the Openbox window manager
17 #include "otk/display.hh"
18 #include "otk/screeninfo.hh"
19 #include "otk/eventdispatcher.hh"
20 #include "otk/eventhandler.hh"
29 //! Mouse cursors used throughout Openbox
31 Cursor session
; //!< The default mouse cursor
32 Cursor move
; //!< For moving a window
33 Cursor ll_angle
; //!< For resizing the bottom left corner of a window
34 Cursor lr_angle
; //!< For resizing the bottom right corner of a window
35 Cursor ul_angle
; //!< For resizing the top left corner of a window
36 Cursor ur_angle
; //!< For resizing the right corner of a window
41 //! The single instance of the Openbox class for the application
43 Since this variable is globally available in the application, the Openbox
44 class does not need to be passed around to any of the other classes.
46 extern Openbox
*openbox
;
48 //! The main class for the Openbox window manager
50 Only a single instance of the Openbox class may be used in the application. A
51 pointer to this instance is held in the Openbox::instance static member
53 Instantiation of this class begins the window manager. After instantiation,
54 the Openbox::eventLoop function should be called. The eventLoop method does
55 not exit until the window manager is ready to be destroyed. Destruction of
56 the Openbox class instance will shutdown the window manager.
58 class Openbox
: public otk::EventDispatcher
, public otk::EventHandler
61 //! The posible running states of the window manager
63 State_Starting
, //!< The window manager is starting up (being created)
64 State_Normal
, //!< The window manager is running in its normal state
65 State_Exiting
//!< The window manager is exiting (being destroyed)
68 //! A map for looking up a specific client class from the window id
69 typedef std::map
<Window
, Client
*> ClientMap
;
71 //! A list of Screen classes
72 typedef std::vector
<Screen
*> ScreenList
;
75 // stuff that can be passed on the command line
76 //! Path to the config file to use/in use
78 Defaults to $(HOME)/.openbox/rc3
80 std::string _rcfilepath
;
81 //! Path to the menu file to use/in use
83 Defaults to $(HOME)/.openbox/menu3
85 std::string _menufilepath
;
86 //! Path to the script file to execute on startup
88 Defaults to $(HOME)/.openbox/user.py
90 std::string _scriptfilepath
;
91 //! The value of argv, i.e. how this application was executed
93 //! Run the application in synchronous mode? (for debugging)
95 //! Should Openbox run on a single screen or on all available screens?
98 //! A list of all managed clients
101 //! A list of all the managed screens
104 //! The action interface through which all user-available actions occur
107 //! The interface through which keys/buttons are grabbed and handled
110 //! The running state of the window manager
113 //! Mouse cursors used throughout Openbox
116 //! When set to true, the Openbox::eventLoop function will stop and return
119 //! When set to true, and Openbox is about to exit, it will spawn a new
123 //! If this contains anything, a restart will try to execute the program in
124 //! this variable, and will fallback to reexec'ing itself if that fails
125 std::string _restart_prog
;
127 //! The client with input focus
129 Updated by the clients themselves.
131 Client
*_focused_client
;
133 //! The screen with input focus
135 Updated by the clients when they update the Openbox::focused_client
138 Screen
*_focused_screen
;
140 //! Parses the command line used when executing this application
141 void parseCommandLine(int argv
, char **argv
);
142 //! Displays the version string to stdout
144 //! Displays usage information and help to stdout
147 //! Handles signal events for the application
148 static void signalHandler(int signal
);
152 //! Openbox constructor.
154 \param argc Number of command line arguments, as received in main()
155 \param argv The command line arguments, as received in main()
157 Openbox(int argc
, char **argv
);
158 //! Openbox destructor.
162 //! Returns the state of the window manager (starting, exiting, etc)
163 inline RunState
state() const { return _state
; }
165 //! Returns the Actions instance for the window manager
166 inline Actions
*actions() const { return _actions
; }
168 //! Returns the Bindings instance for the window manager
169 inline Bindings
*bindings() const { return _bindings
; }
171 //! Returns a managed screen or a null pointer
173 ALWAYS check the return value for a non-null, as any unmanaged screens
174 will return one. This includes screen(0) if the first managed screen is 1.
176 inline Screen
*screen(int num
) {
177 assert(num
>= 0); assert(num
< (signed)ScreenCount(**otk::display
));
178 if (num
>= (signed)_screens
.size()) return 0;
179 return _screens
[num
];
182 //! Returns the mouse cursors used throughout Openbox
183 inline const Cursors
&cursors() const { return _cursors
; }
186 //! The main function of the Openbox class
188 This function should be called after instantiating the Openbox class.
189 It loops indefinately while handling all events for the application.
190 The Openbox::shutdown method will cause this function to exit.
195 //! Adds an Client to the client list for lookups
196 void addClient(Window window
, Client
*client
);
198 //! Removes an Client from the client list for lookups
199 void removeClient(Window window
);
201 //! Finds an Client based on its window id
202 Client
*findClient(Window window
);
204 //! The client with input focus
205 inline Client
*focusedClient() { return _focused_client
; }
207 //! Change the client which has focus.
209 This is called by the clients themselves when their focus state changes.
211 void setFocusedClient(Client
*c
);
213 //! The screen with input focus
214 inline Screen
*focusedScreen() { return _focused_screen
; }
216 //! Requests that the window manager exit
218 Causes the Openbox::eventLoop function to stop looping, so that the window
219 manager can be destroyed.
221 inline void shutdown() { _shutdown
= true; }
223 inline void restart(const std::string
&bin
= "") {
224 _shutdown
= true; _restart
= true; _restart_prog
= bin
;
227 //! True if Openbox should be restarted instead of exiting
228 inline bool doRestart() const { return _restart
; }
230 //! The command line requested to be executed in place of restarting
231 //! Openbox the way it was run previously.
232 inline const std::string
&restartProgram() const { return _restart_prog
; }
237 #endif // __openbox_hh
This page took 0.043366 seconds and 4 git commands to generate.