X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fopenbox.hh;h=1489ffb744b1af37301053cbf99b5a3f794529cb;hb=3c61812e588fb3c34d0713d7f82ccbf21091f032;hp=f49f711d2be0a36bb0f200f8a30b463a4aa868aa;hpb=d557e816bea578ea72f80b1d97492515e926d76b;p=chaz%2Fopenbox diff --git a/src/openbox.hh b/src/openbox.hh index f49f711d..1489ffb7 100644 --- a/src/openbox.hh +++ b/src/openbox.hh @@ -1,20 +1,48 @@ -// -*- mode: C++; indent-tabs-mode: nil; -*- +// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*- #ifndef __openbox_hh #define __openbox_hh +/*! @file openbox.hh + @brief The main class for the Openbox window manager +*/ + +/* + cuz girls look soooo goood.. on the end of my DICK +*/ + extern "C" { #include } #include #include +#include #include "otk/screeninfo.hh" #include "otk/timerqueuemanager.hh" +#include "otk/property.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; + +//! 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 @@ -24,10 +52,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. @@ -36,13 +64,16 @@ public: //! The posible running states of the window manager enum RunState { - //! The window manager is starting up (being created) - State_Starting, - //! The window manager is running in its normal state - State_Normal, - //! The window manager is exiting (being destroyed) - State_Exiting + 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) }; + + //! 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 @@ -56,11 +87,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; + //! 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 @@ -68,12 +110,29 @@ private: */ otk::OBTimerQueueManager _timermanager; + //! 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 after the display + is initialized in this class' constructor. + */ + otk::OBProperty *_property; + + //! The action interface through which all user-available actions occur + OBActions *_actions; + //! 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 @@ -85,6 +144,7 @@ private: static void signalHandler(int signal); public: +#ifndef SWIG //! Openbox constructor. /*! \param argc Number of command line arguments, as received in main() @@ -93,6 +153,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; } @@ -104,16 +165,43 @@ 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 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. - Loops indefinately while handling all events in the application. + It loops indefinately while handling all events for the application. 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); - // XXX: TEMPORARY!#!@%*!^#*!#!#! - virtual void process_event(XEvent *) = 0; + //! Finds an OBClient based on its window id + OBClient *findClient(Window window); //! Requests that the window manager exit /*!