X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fclient.hh;h=1726ce4415dec8de1103a465f46f8c41a0db01f4;hb=c7b22b4f9cee63d860ad4f6617cd5210299b9d8b;hp=325162edd9070916468012b541a6cbdf16908b5d;hpb=dca0c9f5a308e115ec308cdc8ca7987ff4fc0479;p=chaz%2Fopenbox diff --git a/src/client.hh b/src/client.hh index 325162ed..1726ce44 100644 --- a/src/client.hh +++ b/src/client.hh @@ -7,6 +7,12 @@ property changes on the window and some client messages */ +#include "widget.hh" +#include "otk/point.hh" +#include "otk/strut.hh" +#include "otk/rect.hh" +#include "otk/eventhandler.hh" + extern "C" { #include @@ -16,15 +22,25 @@ extern "C" { } #include - -#include "otk/strut.hh" -#include "otk/rect.hh" -#include "otk/eventhandler.hh" +#include namespace ob { class OBFrame; +//! The MWM Hints as retrieved from the window property +/*! + This structure only contains 3 elements, even though the Motif 2.0 + 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 +}; + //! Maintains the state of a client window. /*! OBClient maintains the state of a client window. The state consists of the @@ -37,12 +53,37 @@ class OBFrame; class' member variables and call whatever is nessary to complete the change (such as causing a redraw of the titlebar after the title is changed). */ -class OBClient : public otk::OtkEventHandler { +class OBClient : public otk::OtkEventHandler, public OBWidget { public: //! The frame window which decorates around the client window + /*! + NOTE: This should NEVER be used inside the client class's constructor! + */ 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, + BottomLeft, + BottomRight }; + //! Possible window types enum WindowType { Type_Desktop, //!< A desktop (bottom-most window) Type_Dock, //!< A dock bar/panel window @@ -100,19 +141,6 @@ public: //! Holds a bitmask of OBClient::Decoration values typedef unsigned char DecorationFlags; - //! The MWM Hints as retrieved from the window property - /*! - This structure only contains 3 elements, even though the Motif 2.0 - structure contains 5. We only use the first 3, so that is all gets defined. - */ - typedef 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 - }; - //! Possible actions that can be made with the _NET_WM_STATE client message enum StateAction { State_Remove = 0, //!< _NET_WM_STATE_REMOVE State_Add, //!< _NET_WM_STATE_ADD @@ -120,7 +148,16 @@ public: }; //! The event mask to grab on client windows - static const long event_mask = PropertyChangeMask | FocusChangeMask; + static const long event_mask = PropertyChangeMask | FocusChangeMask | + StructureNotifyMask; + + //! The mask of events to not let propogate past the client + /*! + This makes things like xprop work on the client window, but means we have + to explicitly grab clicks that we want. + */ + static const long no_propagate_mask = ButtonPressMask | ButtonReleaseMask | + ButtonMotionMask; //! The number of unmap events to ignore on the window int ignore_unmaps; @@ -135,7 +172,11 @@ 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; @@ -149,56 +190,61 @@ 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; - //! Position and size of the window (relative to the root window) + //! Position and size of the window + /*! + This will not always be the actual position of the window on screen, it is + rather, the position requested by the client, to which the window's gravity + is applied. + */ otk::Rect _area; - //! Width of the border on the window. + //! The window's strut /*! - The window manager will set this to 0 while the window is being managed, - but needs to restore it afterwards, so it is saved here. + The strut defines areas of the screen that are marked off-bounds for window + placement. In theory, where this window exists. */ - int _border_width; + otk::Strut _strut; - //! The minimum width of the client window + //! The logical size of the window /*! - If the min is > the max, then the window is not resizable + The "logical" size of the window is refers to the user's perception of the + size of the window, and is the value that should be displayed to the user. + For example, with xterms, this value it the number of characters being + displayed in the terminal, instead of the number of pixels. */ - int _min_x; - //! The minimum height of the client window + otk::Point _logical_size; + + //! Width of the border on the window. /*! - If the min is > the max, then the window is not resizable + The window manager will set this to 0 while the window is being managed, + but needs to restore it afterwards, so it is saved here. */ - int _min_y; - //! The maximum width of the client window + int _border_width; + + //! The minimum size of the client window /*! If the min is > the max, then the window is not resizable */ - int _max_x; - //! The maximum height of the client window + otk::Point _min_size; + //! The maximum size of the client window /*! If the min is > the max, then the window is not resizable */ - int _max_y; - //! The size of increments to resize the client window by (for the width) - int _inc_x; - //! The size of increments to resize the client window by (for the height) - int _inc_y; - //! The base width of the client window - /*! - This value should be subtracted from the window's actual width when - displaying its size to the user, or working with its min/max width - */ - int _base_x; - //! The base height of the client window + otk::Point _max_size; + //! The size of increments to resize the client window by + otk::Point _size_inc; + //! The base size of the client window /*! - This value should be subtracted from the window's actual height when - displaying its size to the user, or working with its min/max height + This value should be subtracted from the window's actual size when + displaying its size to the user, or working with its min/max size */ - int _base_y; + otk::Point _base_size; //! Where to place the decorated window in relation to the undecorated window int _gravity; @@ -217,6 +263,8 @@ private: bool _urgent; //! Notify the window when it receives focus? bool _focus_notify; + //! Does the client window have the input focus? + bool _focused; //! The window uses shape extension to be non-rectangular? bool _shaped; @@ -232,10 +280,18 @@ private: bool _max_vert; //! The window is maximized to fill the screen horizontally bool _max_horz; + //! The window should not be displayed by pagers + bool _skip_pager; + //! The window should not be displayed by taskbars + bool _skip_taskbar; //! The window is a 'fullscreen' window, and should be on top of all others bool _fullscreen; //! The window should be on top of other windows of the same type - bool _floating; + bool _above; + //! The window should be underneath other windows of the same type + bool _below; + + StackLayer _layer; //! A bitmask of values in the OBClient::Decoration enum /*! @@ -274,6 +330,9 @@ private: //! Adjusts the window's net_state void setState(StateAction action, long data1, long data2); + //! Calculates the stacking layer for the client window + void calcLayer(); + //! Update the protocols that the window supports and adjusts things if they //! change void updateProtocols(); @@ -287,9 +346,16 @@ 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(); + public: +#ifndef SWIG //! Constructs a new OBClient object around a specified window id /*! @param window The window id that the OBClient class should handle @@ -298,6 +364,7 @@ public: OBClient(int screen, Window window); //! Destroys the OBClient object virtual ~OBClient(); +#endif //! Returns the screen on which the clien resides inline int screen() const { return _screen; } @@ -307,6 +374,16 @@ 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.
@@ -321,9 +398,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 @@ -375,77 +454,78 @@ public: inline bool maxVert() const { return _max_vert; } //! Returns if the window is maximized horizontally inline bool maxHorz() const { return _max_horz; } - //! Returns if the window is fullscreen - /*! - When the window is fullscreen, it is kept above all others - */ - inline bool fullscreen() const { return _fullscreen; } - //! Returns if the window is floating - /*! - When the window is floating, it is kept above all others in the same - stacking layer as it - */ - inline bool floating() const { return _floating; } + //! Returns the window's stacking layer + inline StackLayer layer() const { return _layer; } - //! Returns the window's border width - /*! - The border width is set to 0 when the client becomes managed, but the - border width is stored here so that it can be restored to the client window - when it is unmanaged later. - */ - inline int borderWidth() const { return _border_width; } - //! Returns the minimum width of the client window - /*! - If the min is > the max, then the window is not resizable - */ - inline int minX() const { return _min_x; } - //! Returns the minimum height of the client window - /*! - If the min is > the max, then the window is not resizable - */ - inline int minY() const { return _min_y; } - //! Returns the maximum width of the client window + //! Removes or reapplies the client's border to its window /*! - If the min is > the max, then the window is not resizable + Used when managing and unmanaging a window. + @param addborder true if adding the border to the client; false if removing + from the client */ - inline int maxX() const { return _max_x; } - //! Returns the maximum height of the client window + void toggleClientBorder(bool addborder); + + //! Returns the position and size of the client relative to the root window + inline const otk::Rect &area() const { return _area; } + + //! Returns the client's strut definition + inline const otk::Strut &strut() const { return _strut; } + + //! Move the client window + void move(int x, int y); + + //! Resizes the client window, anchoring it in a given corner /*! - If the min is > the max, then the window is not resizable + This also maintains things like the client's minsize, and size increments. + @param anchor The corner to keep in the same position when resizing. + @param w The width component of the new size for the client. + @param h The height component of the new size for the client. + @param x An optional X coordinate to which the window will be moved + after resizing. + @param y An optional Y coordinate to which the window will be moved + after resizing. + The x and y coordinates must both be sepcified together, or they will have + no effect. When they are specified, the anchor is ignored. */ - inline int maxY() const { return _max_y; } - //! Returns the increment size for resizing the window (for the width) - inline int incrementX() const { return _inc_x; } - //! Returns the increment size for resizing the window (for the height) - inline int incrementY() const { return _inc_y; } - //! Returns the base width of the window + 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(); + + //! Sets the window's stacking layer /*! - This value should be subtracted from the window's actual width when - displaying its size to the user, or working with its min/max width + @param l An integer specifying the layer.
+ '0' - the normal layer
+ '> 0' - the 'above' layer
+ '< 0' - the 'below' layer */ - inline int baseX() const { return _base_x; } - //! Returns the base height of the window + void setStackLayer(int l); + + //! Shades or unshades the client window /*! - This value should be subtracted from the window's actual height when - displaying its size to the user, or working with its min/max height + @param shade true if the window should be shaded; false if it should be + unshaded. */ - inline int baseY() const { return _base_y; } + void shade(bool shade); + + //! Attempt to focus the client window + bool focus(); - //! Returns the position and size of the client relative to the root window - inline const otk::Rect &area() const { return _area; } + //! Remove focus from the client window + void unfocus(); + virtual void focusHandler(const XFocusChangeEvent &e); + virtual void unfocusHandler(const XFocusChangeEvent &e); virtual void propertyHandler(const XPropertyEvent &e); - virtual void clientMessageHandler(const XClientMessageEvent &e); - + virtual void configureRequestHandler(const XConfigureRequestEvent &e); + virtual void unmapHandler(const XUnmapEvent &e); + virtual void destroyHandler(const XDestroyWindowEvent &e); + virtual void reparentHandler(const XReparentEvent &e); + virtual void mapRequestHandler(const XMapRequestEvent &e); +#if defined(SHAPE) virtual void shapeHandler(const XShapeEvent &e); - - //! Changes the stored positions and size of the OBClient window - /*! - This does not actually change the physical geometry, that needs to be done - before/after setting this value to keep it in sync - */ - void setArea(const otk::Rect &area); +#endif // SHAPE }; }