X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fopenbox.hh;h=80b20a168e70eaf59e013aa63a315849f3372983;hb=a132968424c96d9dc62d144c5e863a6810c0369d;hp=baf9edebe906dc90dd290047bf1a8deab2d4326b;hpb=d3b7c84d4c640face48dfb54d70de2bff1551429;p=chaz%2Fopenbox diff --git a/src/openbox.hh b/src/openbox.hh index baf9edeb..80b20a16 100644 --- a/src/openbox.hh +++ b/src/openbox.hh @@ -1,4 +1,4 @@ -// -*- mode: C++; indent-tabs-mode: nil; -*- +// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*- #ifndef __openbox_hh #define __openbox_hh @@ -12,15 +12,34 @@ extern "C" { #include #include +#include #include "otk/screeninfo.hh" #include "otk/timerqueuemanager.hh" #include "otk/property.hh" -#include "xeventhandler.hh" +#include "otk/configuration.hh" +#include "otk/eventdispatcher.hh" +#include "otk/eventhandler.hh" namespace ob { -//! The main class for the Openbox window manager. +class OBScreen; +class OBClient; +class OBActions; +class OBBindings; + +//! 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 +}; + + +//! 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 @@ -30,10 +49,10 @@ namespace ob { not exit until the window manager is ready to be destroyed. Destruction of the Openbox class instance will shutdown the window manager. */ -class Openbox +class Openbox : public otk::OtkEventDispatcher, public otk::OtkEventHandler { public: - //! The single instance of the Openbox class for the application. + //! 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. @@ -46,6 +65,12 @@ public: State_Normal, //!< The window manager is running in its normal state State_Exiting //!< The window manager is exiting (being destroyed) }; + + //! A map for looking up a specific client class from the window id + typedef std::map ClientMap; + + //! A list of OBScreen classes + typedef std::vector ScreenList; private: // stuff that can be passed on the command line @@ -59,11 +84,22 @@ private: Defaults to $(HOME)/.openbox/menu3 */ std::string _menufilepath; + //! Path to the script file to execute on startup + /*! + Defaults to $(HOME)/.openbox/user.py + */ + std::string _scriptfilepath; //! 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; + //! The value of argv, i.e. how this application was executed + char **_argv; + //! 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 @@ -71,9 +107,6 @@ private: */ 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 @@ -82,12 +115,45 @@ private: */ otk::OBProperty *_property; + //! The action interface through which all user-available actions occur + OBActions *_actions; + + //! The interface through which keys/buttons are grabbed and handled + OBBindings *_bindings; + + //! Run the application in synchronous mode? (for debugging) + bool _sync; + //! 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; + bool _shutdown; + + //! When set to true, and Openbox is about to exit, it will spawn a new + //! process + bool _restart; + + //! If this contains anything, a restart will try to execute the program in + //! this variable, and will fallback to reexec'ing itself if that fails + std::string _restart_prog; + + //! The client with input focus + /*! + Updated by the clients themselves. + */ + OBClient *_focused_client; + //! The screen with input focus + /*! + Updated by the clients when they update the Openbox::focused_client + property. + */ + OBScreen *_focused_screen; + //! Parses the command line used when executing this application void parseCommandLine(int argv, char **argv); //! Displays the version string to stdout @@ -99,6 +165,7 @@ private: static void signalHandler(int signal); public: +#ifndef SWIG //! Openbox constructor. /*! \param argc Number of command line arguments, as received in main() @@ -107,6 +174,7 @@ public: Openbox(int argc, char **argv); //! Openbox destructor. virtual ~Openbox(); +#endif //! Returns the state of the window manager (starting, exiting, etc) inline RunState state() const { return _state; } @@ -118,8 +186,32 @@ public: */ inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; } + //! Returns the otk::OBProperty instance for the window manager inline const otk::OBProperty *property() const { return _property; } + //! Returns the OBActions instance for the window manager + inline OBActions *actions() const { return _actions; } + + //! Returns the OBBindings instance for the window manager + inline OBBindings *bindings() const { return _bindings; } + + //! Returns a managed screen + inline OBScreen *screen(int num) { + assert(num >= 0); assert(num < (signed)_screens.size()); + if (num >= screenCount()) + return NULL; + return _screens[num]; + } + + //! Returns the number of managed screens + inline int screenCount() const { + return (signed)_screens.size(); + } + + //! Returns the mouse cursors used throughout Openbox + inline const Cursors &cursors() const { return _cursors; } + +#ifndef SWIG //! The main function of the Openbox class /*! This function should be called after instantiating the Openbox class. @@ -127,13 +219,42 @@ public: The Openbox::shutdown method will cause this function to exit. */ void eventLoop(); +#endif + + //! 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); + + //! The client with input focus + inline OBClient *focusedClient() { return _focused_client; } + + //! Change the client which has focus. + /*! + This is called by the clients themselves when their focus state changes. + */ + void setFocusedClient(OBClient *c); + + //! The screen with input focus + inline OBScreen *focusedScreen() { return _focused_screen; } + //! 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; } + inline void shutdown() { _shutdown = true; } + + inline void restart(const std::string &bin = "") { + _shutdown = true; _restart = true; _restart_prog = bin; + } + + //! Executes a command on a screen + void execute(int screen, const std::string &bin); }; }