X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;f=src%2Fclient.hh;h=37a38ac1084231c04ed397e61e228bae3d2161ce;hb=4c2f4e75372c4814413e3a105a045395e10892ca;hp=799ff70337670178805f63a106240e7f2318396a;hpb=9df8ba78f3438f7ea63d9aef8121da969d5a1d9b;p=chaz%2Fopenbox diff --git a/src/client.hh b/src/client.hh index 799ff703..37a38ac1 100644 --- a/src/client.hh +++ b/src/client.hh @@ -2,100 +2,254 @@ #ifndef __client_hh #define __client_hh +/*! @file client.hh + @brief The Client class maintains the state of a client window by handling + 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" +#include "otk/ustring.hh" + extern "C" { #include + +#ifdef SHAPE +#include +#endif // SHAPE } #include - -#include "otk/strut.hh" -#include "otk/rect.hh" +#include namespace ob { -class OBClient { +class Frame; + +//! 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 { + unsigned long flags; //!< A bitmask of Client::MwmFlags values + unsigned long functions; //!< A bitmask of Client::MwmFunctions values + unsigned long decorations;//!< A bitmask of Client::MwmDecorations values + //! The number of elements in the Client::MwmHints struct + static const unsigned int elements = 3; +}; + +//! Maintains the state of a client window. +/*! + Client maintains the state of a client window. The state consists of the + hints that the application sets on the window, such as the title, or window + gravity. +

+ Client also manages client messages for the client window. When the + application (or any application) requests something to be changed for the + client, it will call the ActionHandler (for client messages) or update the + 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 Client : public otk::EventHandler, public WidgetBase { public: - enum Max { Max_None, - Max_Horz, - Max_Vert, - Max_Full }; - - enum WindowType { Type_Desktop, - Type_Dock, - Type_Toolbar, - Type_Menu, - Type_Utility, - Type_Splash, - Type_Dialog, - Type_Normal }; - - enum MwmFlags { Functions = 1 << 0, - Decorations = 1 << 1 }; - - enum MwmFunctions { MwmFunc_All = 1 << 0, - MwmFunc_Resize = 1 << 1, - MwmFunc_Move = 1 << 2, - MwmFunc_Iconify = 1 << 3, - MwmFunc_Maximize = 1 << 4, - MwmFunc_Close = 1 << 5 }; - - enum MemDecorations { MemDecor_All = 1 << 0, - MemDecor_Border = 1 << 1, - MemDecor_Handle = 1 << 2, - MemDecor_Title = 1 << 3, - //MemDecor_Menu = 1 << 4, - MemDecor_Iconify = 1 << 5, - MemDecor_Maximize = 1 << 6 }; - - // this structure only contains 3 elements... the Motif 2.0 structure - // contains 5... we only need the first 3... so that is all we will define - typedef struct MwmHints { - static const int elements = 3; - unsigned long flags; - unsigned long functions; - unsigned long decorations; + + //! The frame window which decorates around the client window + /*! + NOTE: This should NEVER be used inside the client class's constructor! + */ + Frame *frame; + + //! Holds a list of Clients + 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 + Type_Toolbar, //!< A toolbar window, pulled off an app + Type_Menu, //!< A sticky menu from an app + Type_Utility, //!< A small utility window such as a palette + Type_Splash, //!< A splash screen window + Type_Dialog, //!< A dialog window + Type_Normal //!< A normal application window + }; + + //! Possible flags for MWM Hints (defined by Motif 2.0) + enum MwmFlags { MwmFlag_Functions = 1 << 0, //!< The MMW Hints define funcs + MwmFlag_Decorations = 1 << 1 //!< The MWM Hints define decor + }; + + //! Possible functions for MWM Hints (defined by Motif 2.0) + enum MwmFunctions { MwmFunc_All = 1 << 0, //!< All functions + MwmFunc_Resize = 1 << 1, //!< Allow resizing + MwmFunc_Move = 1 << 2, //!< Allow moving + MwmFunc_Iconify = 1 << 3, //!< Allow to be iconfied + MwmFunc_Maximize = 1 << 4 //!< Allow to be maximized + //MwmFunc_Close = 1 << 5 //!< Allow to be closed + }; + + //! Possible decorations for MWM Hints (defined by Motif 2.0) + enum MemDecorations { MwmDecor_All = 1 << 0, //!< All decorations + MwmDecor_Border = 1 << 1, //!< Show a border + MwmDecor_Handle = 1 << 2, //!< Show a handle (bottom) + MwmDecor_Title = 1 << 3, //!< Show a titlebar + //MwmDecor_Menu = 1 << 4, //!< Show a menu + MwmDecor_Iconify = 1 << 5, //!< Show an iconify button + MwmDecor_Maximize = 1 << 6 //!< Show a maximize button + }; + + //! The things the user can do to the client window + enum Function { Func_Resize = 1 << 0, //!< Allow resizing + Func_Move = 1 << 1, //!< Allow moving + Func_Iconify = 1 << 2, //!< Allow to be iconified + Func_Maximize = 1 << 3, //!< Allow to be maximized + Func_Close = 1 << 4 //!< Allow to be closed + }; + //! Holds a bitmask of Client::Function values + typedef unsigned char FunctionFlags; + + //! The decorations the client window wants to be displayed on it + enum Decoration { Decor_Titlebar = 1 << 0, //!< Display a titlebar + Decor_Handle = 1 << 1, //!< Display a handle (bottom) + Decor_Border = 1 << 2, //!< Display a border + Decor_Iconify = 1 << 3, //!< Display an iconify button + Decor_Maximize = 1 << 4, //!< Display a maximize button + Decor_Sticky = 1 << 5, //!< Display a sticky button + Decor_Close = 1 << 6 //!< Display a close button }; + //! Holds a bitmask of Client::Decoration values + typedef unsigned char DecorationFlags; - enum StateAction { State_Remove = 0, // _NET_WM_STATE_REMOVE - State_Add, // _NET_WM_STATE_ADD - State_Toggle // _NET_WM_STATE_TOGGLE + //! 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 + State_Toggle //!< _NET_WM_STATE_TOGGLE }; + //! The event mask to grab on client windows + 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; + private: + //! The screen number on which the client resides + int _screen; + //! The actual window that this class is wrapping up Window _window; //! 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 + Client *_transient_for; + + //! The clients which are transients (children) of this client + Client::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 + otk::ustring _title; //! Window title when iconifiged - std::string _icon_title; + otk::ustring _icon_title; //! The application that created the window 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; - // size bounds - // if min > max, then the window is not resizable - int _min_x, _min_y; // minumum size - int _max_x, _max_y; // maximum size - int _inc_x, _inc_y; // resize increments - int _base_x, _base_y; // base size - + //! The window's strut + /*! + The strut defines areas of the screen that are marked off-bounds for window + placement. In theory, where this window exists. + */ + otk::Strut _strut; + + //! The logical size of the window + /*! + 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. + */ + otk::Point _logical_size; + + //! Width of the border on the window. + /*! + 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 _border_width; + + //! The minimum size of the client window + /*! + If the min is > the max, then the window is not resizable + */ + otk::Point _min_size; + //! The maximum size of the client window + /*! + If the min is > the max, then the window is not resizable + */ + 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 size when + displaying its size to the user, or working with its min/max size + */ + 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; @@ -113,6 +267,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; @@ -128,71 +284,258 @@ 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; - - // XXX: motif decoration hints! - + bool _above; + //! The window should be underneath other windows of the same type + bool _below; + + StackLayer _layer; + + //! A bitmask of values in the Client::Decoration enum + /*! + The values in the variable are the decorations that the client wants to be + displayed around it. + */ + DecorationFlags _decorations; + + //! A bitmask of values in the Client::Function enum + /*! + The values in the variable specify the ways in which the user is allowed to + modify this window. + */ + FunctionFlags _functions; + + //! Retrieves the window's initial gravity + void getGravity(); + //! Retrieves the desktop hint's value and sets Client::_desktop void getDesktop(); + //! Retrieves the window's type and sets Client::_type void getType(); + //! Gets the MWM Hints and adjusts Client::_functions and + //! Client::_decorations + void getMwmHints(); + //! Gets the position and size of the window and sets Client::_area void getArea(); + //! Gets the net_state hint and sets the boolean flags for any states set in + //! the hint void getState(); + //! Determines if the window uses the Shape extension and sets + //! Client::_shaped void getShaped(); + //! Set up what decor should be shown on the window and what functions should + //! be allowed (Client::_decorations and Client::_functions). + /*! + This also updates the NET_WM_ALLOWED_ACTIONS hint. + */ + void setupDecorAndFunctions(); + + //! Sets the wm_state to the specified value void setWMState(long state); - 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(); + + //! Update the protocols that the window supports and adjusts things if they + //! change + void updateProtocols(); + //! Updates the WMNormalHints and adjusts things if they change void updateNormalHints(); + //! Updates the WMHints and adjusts things if they change void updateWMHints(); - // XXX: updateTransientFor(); + //! Updates the window's title void updateTitle(); + //! Updates the window's icon title + void updateIconTitle(); + //! Updates the window's application name and class void updateClass(); - + //! 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: - OBClient(Window window); - virtual ~OBClient(); - +#ifndef SWIG + //! Constructs a new Client object around a specified window id + /*! +BB @param window The window id that the Client class should handle + @param screen The screen on which the window resides + */ + Client(int screen, Window window); + //! Destroys the Client object + virtual ~Client(); +#endif + + //! Returns the screen on which the clien resides + inline int screen() const { return _screen; } + + //! Returns the window id that the Client object is handling inline Window window() const { return _window; } + //! Returns the type of the window, one of the Client::WindowType values inline WindowType type() const { return _type; } - inline unsigned long desktop() const { return _desktop; } - inline const std::string &title() const { return _title; } - inline const std::string &iconTitle() const { return _title; } + //! 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 long desktop() const { return _desktop; } + //! Returns the window's title + inline const otk::ustring &title() const { return _title; } + //! Returns the window's title when it is iconified + inline const otk::ustring &iconTitle() const { return _title; } + //! Returns the application's name to whom the window belongs 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 focus; otherwise, false + */ inline bool canFocus() const { return _can_focus; } + //! Returns if the window has indicated that it needs urgent attention inline bool urgent() const { return _urgent; } + //! Returns if the window wants to be notified when it receives focus inline bool focusNotify() const { return _focus_notify; } + //! Returns if the window uses the Shape extension inline bool shaped() const { return _shaped; } + //! Returns the window's gravity + /*! + This value determines where to place the decorated window in relation to + its position without decorations.
+ One of: NorthWestGravity, SouthWestGravity, EastGravity, ..., + SouthGravity, StaticGravity, ForgetGravity + */ inline int gravity() const { return _gravity; } - - // states + //! Returns if the application requested the initial position for the window + /*! + If the application did not request a position (this function returns false) + then the window should be placed intelligently by the window manager + initially + */ + inline bool positionRequested() const { return _positioned; } + //! Returns the decorations that the client window wishes to be displayed on + //! it + inline DecorationFlags decorations() const { return _decorations; } + //! 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 Client *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 + focus while it exists/remains modal. + */ inline bool modal() const { return _modal; } + //! Returns if the window is shaded + /*! + When the window is shaded, only its titlebar is visible. + */ inline bool shaded() const { return _shaded; } + //! Returns if the window is iconified + /*! + When the window is iconified, it is not visible at all (except in iconbars/ + panels/etc that want to show lists of iconified windows + */ inline bool iconic() const { return _iconic; } + //! Returns if the window is maximized vertically inline bool maxVert() const { return _max_vert; } + //! Returns if the window is maximized horizontally inline bool maxHorz() const { return _max_horz; } - inline bool fullscreen() const { return _fullscreen; } - inline bool floating() const { return _floating; } - - inline int minX() const { return _min_x; } - inline int minY() const { return _min_y; } - inline int maxX() const { return _max_x; } - inline int maxY() const { return _max_y; } - inline int incrementX() const { return _inc_x; } - inline int incrementY() const { return _inc_y; } - inline int baseX() const { return _base_x; } - inline int baseY() const { return _base_y; } - + //! Returns the window's stacking layer + inline StackLayer layer() const { return _layer; } + + //! Removes or reapplies the client's border to its window + /*! + Used when managing and unmanaging a window. + @param addborder true if adding the border to the client; false if removing + from the client + */ + 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; } - void update(const XPropertyEvent &e); - void update(const XClientMessageEvent &e); + //! Returns the client's strut definition + inline const otk::Strut &strut() const { return _strut; } - void setArea(const otk::Rect &area); + //! Move the client window + /*! + @param x The X coordinate to move to. + @param y The Y coordinate to move to. + */ + void move(int x, int y); + + //! Resizes the client window, anchoring it in a given corner + /*! + 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. + */ + void resize(Corner anchor, int w, int h, int x = INT_MIN, int y = INT_MIN); + + //! Attempt to focus the client window + bool focus() const; + + //! Remove focus from the client window + void unfocus() const; + + 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); +#if defined(SHAPE) + virtual void shapeHandler(const XShapeEvent &e); +#endif // SHAPE }; }