X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fclient.hh;h=6cafb94326ca05b30bc8906eb8fee67eff8fbdc5;hb=7b20aad5bde2d5338e42dadcfe1175b4390744db;hp=f782a3559ef4dac5984a332b8ea222c754c482a3;hpb=7bae794382c7a64a6427b16d1339b98120a5166f;p=chaz%2Fopenbox diff --git a/src/client.hh b/src/client.hh index f782a355..6cafb943 100644 --- a/src/client.hh +++ b/src/client.hh @@ -7,6 +7,12 @@ property changes on the window and some client messages */ +#include "widgetbase.hh" +#include "otk/point.hh" +#include "otk/strut.hh" +#include "otk/rect.hh" +#include "otk/eventhandler.hh" + extern "C" { #include @@ -16,13 +22,7 @@ extern "C" { } #include - -#include "screen.hh" -#include "widget.hh" -#include "otk/point.hh" -#include "otk/strut.hh" -#include "otk/rect.hh" -#include "otk/eventhandler.hh" +#include namespace ob { @@ -34,14 +34,13 @@ class OBFrame; structure contains 5. We only use the first 3, so that is all gets defined. */ struct MwmHints { - //! The number of elements in the OBClient::MwmHints struct - static const unsigned int elements = 3; unsigned long flags; //!< A bitmask of OBClient::MwmFlags values unsigned long functions; //!< A bitmask of OBClient::MwmFunctions values unsigned long decorations;//!< A bitmask of OBClient::MwmDecorations values + //! The number of elements in the OBClient::MwmHints struct + static const unsigned int elements = 3; }; - //! Maintains the state of a client window. /*! OBClient maintains the state of a client window. The state consists of the @@ -63,6 +62,22 @@ public: */ OBFrame *frame; + //! Holds a list of OBClients + typedef std::list List; + + //! The possible stacking layers a client window can be a part of + enum StackLayer { + Layer_Icon, //!< 0 - iconified windows, in any order at all + Layer_Desktop, //!< 1 - desktop windows + Layer_Below, //!< 2 - normal windows w/ below + Layer_Normal, //!< 3 - normal windows + Layer_Above, //!< 4 - normal windows w/ above + Layer_Top, //!< 5 - always-on-top-windows (docks?) + Layer_Fullscreen, //!< 6 - fullscreeen windows + Layer_Internal, //!< 7 - openbox windows/menus + NUM_LAYERS + }; + //! Corners of the client window, used for anchor positions enum Corner { TopLeft, TopRight, @@ -157,10 +172,14 @@ private: //! The id of the group the window belongs to Window _group; - // XXX: transient_for, transients + //! The client which this client is a transient (child) for + OBClient *_transient_for; + + //! The clients which are transients (children) of this client + OBClient::List _transients; //! The desktop on which the window resides (0xffffffff for all desktops) - unsigned long _desktop; + long _desktop; //! Normal window title std::string _title; // XXX: Have to keep track if this string is Utf8 or not @@ -171,6 +190,8 @@ private: std::string _app_name; //! The class of the window, can used for grouping std::string _app_class; + //! The specified role of the window, used for identification + std::string _role; //! The type of window (what its function is) WindowType _type; @@ -225,6 +246,9 @@ private: */ otk::Point _base_size; + //! Window decoration and functionality hints + MwmHints _mwmhints; + //! Where to place the decorated window in relation to the undecorated window int _gravity; @@ -270,7 +294,7 @@ private: //! The window should be underneath other windows of the same type bool _below; - OBScreen::StackLayer _layer; + StackLayer _layer; //! A bitmask of values in the OBClient::Decoration enum /*! @@ -302,13 +326,21 @@ private: //! OBClient::_shaped void getShaped(); + //! Set up what decor should be shown on the window and what functions should + //! be allowed (OBClient::_decorations and OBClient::_functions). + /*! + This also updates the NET_WM_ALLOWED_ACTIONS hint. + */ + void setupDecorAndFunctions(); + //! Sets the wm_state to the specified value void setWMState(long state); - //! Sends the window to the specified desktop - void setDesktop(long desktop); //! Adjusts the window's net_state void setState(StateAction action, long data1, long data2); + //! Sends the window to the specified desktop + void setDesktop(long desktop); + //! Calculates the stacking layer for the client window void calcLayer(); @@ -325,18 +357,29 @@ private: void updateIconTitle(); //! Updates the window's application name and class void updateClass(); - // XXX: updateTransientFor(); //! Updates the strut for the client void updateStrut(); + //! Updates the window's transient status, and any parents of it + void updateTransientFor(); //! Change the client's state hints to match the class' data void changeState(); + + //! Request the client to close its window. + void close(); + + //! Shades or unshades the client window + /*! + @param shade true if the window should be shaded; false if it should be + unshaded. + */ + void shade(bool shade); public: #ifndef SWIG //! Constructs a new OBClient object around a specified window id /*! - @param window The window id that the OBClient class should handle +BB @param window The window id that the OBClient class should handle @param screen The screen on which the window resides */ OBClient(int screen, Window window); @@ -352,12 +395,22 @@ public: //! Returns the type of the window, one of the OBClient::WindowType values inline WindowType type() const { return _type; } + //! Returns if the window should be treated as a normal window. + /*! + Some windows (desktops, docks, splash screens) have special rules applied + to them in a number of places regarding focus or user interaction. + */ + inline bool normal() const { + return ! (_type == Type_Desktop || _type == Type_Dock || + _type == Type_Splash); + } + //! Returns the desktop on which the window resides /*! This value is a 0-based index.
A value of 0xffffffff indicates that the window exists on all desktops. */ - inline unsigned long desktop() const { return _desktop; } + inline long desktop() const { return _desktop; } //! Returns the window's title inline const std::string &title() const { return _title; } //! Returns the window's title when it is iconified @@ -366,9 +419,11 @@ public: inline const std::string &appName() const { return _app_name; } //! Returns the class of the window inline const std::string &appClass() const { return _app_class; } + //! Returns the program-specified role of the window + inline const std::string &role() const { return _role; } //! Returns if the window can be focused /*! - @return true if the window can receive focusl otherwise, false + @return true if the window can receive focus; otherwise, false */ inline bool canFocus() const { return _can_focus; } //! Returns if the window has indicated that it needs urgent attention @@ -398,6 +453,9 @@ public: //! Returns the functions that the user can perform on the window inline FunctionFlags funtions() const { return _functions; } + //! Return the client this window is transient for + inline OBClient *transientFor() const { return _transient_for; } + //! Returns if the window is modal /*! If the window is modal, then no other windows that it is related to can get @@ -406,8 +464,7 @@ public: inline bool modal() const { return _modal; } //! Returns if the window is shaded /*! - When the window is shaded, only its titlebar is visible, the client itself - is not mapped + When the window is shaded, only its titlebar is visible. */ inline bool shaded() const { return _shaded; } //! Returns if the window is iconified @@ -421,7 +478,7 @@ public: //! Returns if the window is maximized horizontally inline bool maxHorz() const { return _max_horz; } //! Returns the window's stacking layer - inline OBScreen::StackLayer layer() const { return _layer; } + inline StackLayer layer() const { return _layer; } //! Removes or reapplies the client's border to its window /*! @@ -455,21 +512,11 @@ public: */ void resize(Corner anchor, int w, int h, int x = INT_MIN, int y = INT_MIN); - //! Request the client to close its window. - void close(); - - //! Shades or unshades the client window - /*! - @param shade true if the window should be shaded; false if it should be - unshaded. - */ - void shade(bool shade); - //! Attempt to focus the client window - bool focus(); + bool focus() const; //! Remove focus from the client window - void unfocus(); + void unfocus() const; virtual void focusHandler(const XFocusChangeEvent &e); virtual void unfocusHandler(const XFocusChangeEvent &e);