X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fopenbox.hh;h=976a49774ed2261cc51370d147d6accc3c812a9f;hb=c645416035d64cc959d1dd0e937b31b07489e54b;hp=8c2015f95870af95005b39bc65525f048762b1e4;hpb=74cb09bb2cc4832463a57743b1495eef24237d2a;p=chaz%2Fopenbox diff --git a/src/openbox.hh b/src/openbox.hh index 8c2015f9..976a4977 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 @@ -24,13 +24,25 @@ extern "C" { #include "otk/configuration.hh" #include "otk/eventdispatcher.hh" #include "otk/eventhandler.hh" -#include "client.hh" namespace ob { 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. +//! 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 @@ -43,7 +55,7 @@ class OBScreen; 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. @@ -57,16 +69,6 @@ public: 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 ClientMap; @@ -85,6 +87,11 @@ 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 @@ -111,6 +118,12 @@ private: */ otk::OBProperty *_property; + //! The action interface through which all user-available actions occur + OBActions *_actions; + + //! Run the application in synchronous mode? (for debugging) + bool _sync; + //! The running state of the window manager RunState _state; @@ -123,6 +136,19 @@ private: //! The configuration of the application. TEMPORARY otk::Configuration _config; + //! 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 @@ -134,6 +160,7 @@ private: static void signalHandler(int signal); public: +#ifndef SWIG //! Openbox constructor. /*! \param argc Number of command line arguments, as received in main() @@ -142,6 +169,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; } @@ -159,12 +187,20 @@ public: //! 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. @@ -172,6 +208,7 @@ 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); @@ -182,14 +219,24 @@ public: //! 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; } - - virtual void mapRequestHandler(const XMapRequestEvent &); }; }