src/openbox.hh (raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
// -*- mode: C++; indent-tabs-mode: nil; -*- #ifndef __openbox_hh #define __openbox_hh /*! @file openbox.hh @brief The main class for the Openbox window manager */ extern "C" { #include <X11/Xlib.h> } #include <string> #include <vector> #include <map> #include "otk/screeninfo.hh" #include "otk/timerqueuemanager.hh" #include "otk/property.hh" #include "otk/configuration.hh" #include "xeventhandler.hh" #include "client.hh" namespace ob { class OBScreen; //! The main class for the Openbox window manager. /*! Only a single instance of the Openbox class may be used in the application. A pointer to this instance is held in the Openbox::instance static member variable. Instantiation of this class begins the window manager. After instantiation, the Openbox::eventLoop function should be called. The eventLoop method does not exit until the window manager is ready to be destroyed. Destruction of the Openbox class instance will shutdown the window manager. */ class Openbox { public: //! The single instance of the Openbox class for the application. /*! Since this variable is globally available in the application, the Openbox class does not need to be passed around to any of the other classes. */ static Openbox *instance; //! The posible running states of the window manager enum RunState { State_Starting, //!< The window manager is starting up (being created) State_Normal, //!< The window manager is running in its normal state State_Exiting //!< The window manager is exiting (being destroyed) }; //! Mouse cursors used throughout Openbox struct Cursors { Cursor session; //!< The default mouse cursor Cursor move; //!< For moving a window Cursor ll_angle; //!< For resizing the bottom left corner of a window Cursor lr_angle; //!< For resizing the bottom right corner of a window Cursor ul_angle; //!< For resizing the top left corner of a window Cursor ur_angle; //!< For resizing the right corner of a window }; //! A map for looking up a specific client class from the window id typedef std::map<Window, OBClient *> ClientMap; //! A list of OBScreen classes typedef std::vector<OBScreen *> ScreenList; private: // stuff that can be passed on the command line //! Path to the config file to use/in use /*! Defaults to $(HOME)/.openbox/rc3 */ std::string _rcfilepath; //! Path to the menu file to use/in use /*! Defaults to $(HOME)/.openbox/menu3 */ std::string _menufilepath; //! The display requested by the user, or null to use the DISPLAY env var char *_displayreq; //! The value of argv[0], i.e. how this application was executed char *_argv0; //! A list of all managed clients ClientMap _clients; //! A list of all the managed screens ScreenList _screens; //! Manages all timers for the application /*! Use of the otk::OBTimerQueueManager::fire funtion in this object ensures that all timers fire when their times elapse. */ otk::OBTimerQueueManager _timermanager; //! The class which will handle raw XEvents OBXEventHandler _xeventhandler; //! Cached atoms on the display /*! This is a pointer because the OBProperty class uses otk::OBDisplay::display in its constructor, so, it needs to be initialized <b>after</b> the display is initialized in this class' constructor. */ otk::OBProperty *_property; //! The running state of the window manager RunState _state; //! Mouse cursors used throughout Openbox Cursors _cursors; //! When set to true, the Openbox::eventLoop function will stop and return bool _doshutdown; //! The configuration of the application. TEMPORARY otk::Configuration _config; //! Parses the command line used when executing this application void parseCommandLine(int argv, char **argv); //! Displays the version string to stdout void showVersion(); //! Displays usage information and help to stdout void showHelp(); //! Handles signal events for the application static void signalHandler(int signal); public: //! Openbox constructor. /*! \param argc Number of command line arguments, as received in main() \param argv The command line arguments, as received in main() */ Openbox(int argc, char **argv); //! Openbox destructor. virtual ~Openbox(); //! Returns the state of the window manager (starting, exiting, etc) inline RunState state() const { return _state; } //! Returns the otk::OBTimerQueueManager for the application /*! All otk::OBTimer objects used in the application should be made to use this otk::OBTimerQueueManager. */ inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; } //! Returns the otk::OBProperty instance for the window manager inline const otk::OBProperty *property() const { return _property; } //! Returns a managed screen inline const OBScreen *screen(int num) const { assert(num >= 0); assert(num < (signed)_screens.size()); return _screens[num]; } //! Returns the mouse cursors used throughout Openbox inline const Cursors &cursors() const { return _cursors; } //! The main function of the Openbox class /*! This function should be called after instantiating the Openbox class. It loops indefinately while handling all events for the application. The Openbox::shutdown method will cause this function to exit. */ void eventLoop(); //! Adds an OBClient to the client list for lookups void addClient(Window window, OBClient *client); //! Removes an OBClient from the client list for lookups void removeClient(Window window); //! Finds an OBClient based on its window id OBClient *findClient(Window window); //! Requests that the window manager exit /*! Causes the Openbox::eventLoop function to stop looping, so that the window manager can be destroyed. */ inline void shutdown() { _doshutdown = true; } }; } #endif // __openbox_hh |