1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
6 @brief The Client class maintains the state of a client window by handling
7 property changes on the window and some client messages
11 #include "otk/strut.hh"
12 #include "otk/rect.hh"
13 #include "otk/eventhandler.hh"
14 #include "otk/ustring.hh"
20 #include <X11/extensions/shape.h>
37 //! The MWM Hints as retrieved from the window property
39 This structure only contains 3 elements, even though the Motif 2.0
40 structure contains 5. We only use the first 3, so that is all gets defined.
43 unsigned long flags
; //!< A bitmask of Client::MwmFlags values
44 unsigned long functions
; //!< A bitmask of Client::MwmFunctions values
45 unsigned long decorations
;//!< A bitmask of Client::MwmDecorations values
46 //! The number of elements in the Client::MwmHints struct
47 static const unsigned int elements
= 3;
50 //! Maintains the state of a client window.
52 Client maintains the state of a client window. The state consists of the
53 hints that the application sets on the window, such as the title, or window
56 Client also manages client messages for the client window. When the
57 application (or any application) requests something to be changed for the
58 client, it will call the ActionHandler (for client messages) or update the
59 class' member variables and call whatever is nessary to complete the
60 change (such as causing a redraw of the titlebar after the title is changed).
62 class Client
: public otk::EventHandler
{
65 //! The frame window which decorates around the client window
67 NOTE: This should NEVER be used inside the client class's constructor!
71 //! Holds a list of Clients
72 typedef std::list
<Client
*> List
;
74 //! The possible stacking layers a client window can be a part of
76 Layer_Icon
, //!< 0 - iconified windows, in any order at all
77 Layer_Desktop
, //!< 1 - desktop windows
78 Layer_Below
, //!< 2 - normal windows w/ below
79 Layer_Normal
, //!< 3 - normal windows
80 Layer_Above
, //!< 4 - normal windows w/ above
81 Layer_Top
, //!< 5 - always-on-top-windows (docks?)
82 Layer_Fullscreen
, //!< 6 - fullscreeen windows
83 Layer_Internal
, //!< 7 - openbox windows/menus
87 //! Corners of the client window, used for anchor positions
88 enum Corner
{ TopLeft
,
93 //! Possible window types
94 enum WindowType
{ Type_Desktop
, //!< A desktop (bottom-most window)
95 Type_Dock
, //!< A dock bar/panel window
96 Type_Toolbar
, //!< A toolbar window, pulled off an app
97 Type_Menu
, //!< An unpinned menu from an app
98 Type_Utility
, //!< A small utility window such as a palette
99 Type_Splash
, //!< A splash screen window
100 Type_Dialog
, //!< A dialog window
101 Type_Normal
//!< A normal application window
104 //! Possible flags for MWM Hints (defined by Motif 2.0)
105 enum MwmFlags
{ MwmFlag_Functions
= 1 << 0, //!< The MMW Hints define funcs
106 MwmFlag_Decorations
= 1 << 1 //!< The MWM Hints define decor
109 //! Possible functions for MWM Hints (defined by Motif 2.0)
110 enum MwmFunctions
{ MwmFunc_All
= 1 << 0, //!< All functions
111 MwmFunc_Resize
= 1 << 1, //!< Allow resizing
112 MwmFunc_Move
= 1 << 2, //!< Allow moving
113 MwmFunc_Iconify
= 1 << 3, //!< Allow to be iconfied
114 MwmFunc_Maximize
= 1 << 4 //!< Allow to be maximized
115 //MwmFunc_Close = 1 << 5 //!< Allow to be closed
118 //! Possible decorations for MWM Hints (defined by Motif 2.0)
119 enum MemDecorations
{ MwmDecor_All
= 1 << 0, //!< All decorations
120 MwmDecor_Border
= 1 << 1, //!< Show a border
121 MwmDecor_Handle
= 1 << 2, //!< Show a handle (bottom)
122 MwmDecor_Title
= 1 << 3, //!< Show a titlebar
123 //MwmDecor_Menu = 1 << 4, //!< Show a menu
124 MwmDecor_Iconify
= 1 << 5, //!< Show an iconify button
125 MwmDecor_Maximize
= 1 << 6 //!< Show a maximize button
128 //! The things the user can do to the client window
129 enum Function
{ Func_Resize
= 1 << 0, //!< Allow resizing
130 Func_Move
= 1 << 1, //!< Allow moving
131 Func_Iconify
= 1 << 2, //!< Allow to be iconified
132 Func_Maximize
= 1 << 3, //!< Allow to be maximized
133 Func_Shade
= 1 << 4, //!< Allow to be shaded
134 Func_Fullscreen
= 1 << 5, //!< Allow to be made fullscreen
135 Func_Close
= 1 << 6 //!< Allow to be closed
137 //! Holds a bitmask of Client::Function values
138 typedef unsigned char FunctionFlags
;
140 //! The decorations the client window wants to be displayed on it
141 enum Decoration
{ Decor_Titlebar
= 1 << 0, //!< Display a titlebar
142 Decor_Handle
= 1 << 1, //!< Display a handle (bottom)
143 Decor_Border
= 1 << 2, //!< Display a border
144 Decor_Iconify
= 1 << 3, //!< Display an iconify button
145 Decor_Maximize
= 1 << 4, //!< Display a maximize button
146 //! Display a button to toggle the window's placement on
148 Decor_AllDesktops
= 1 << 5,
149 Decor_Close
= 1 << 6 //!< Display a close button
151 //! Holds a bitmask of Client::Decoration values
152 typedef unsigned char DecorationFlags
;
154 //! Possible actions that can be made with the _NET_WM_STATE client message
155 enum StateAction
{ State_Remove
= 0, //!< _NET_WM_STATE_REMOVE
156 State_Add
, //!< _NET_WM_STATE_ADD
157 State_Toggle
//!< _NET_WM_STATE_TOGGLE
160 //! The event mask to grab on client windows
161 static const long event_mask
= PropertyChangeMask
| FocusChangeMask
|
164 //! The mask of events to not let propogate past the client
166 This makes things like xprop work on the client window, but means we have
167 to explicitly grab clicks that we want.
169 static const long no_propagate_mask
= ButtonPressMask
| ButtonReleaseMask
|
172 //! The number of unmap events to ignore on the window
176 //! The screen number on which the client resides
179 //! The actual window that this class is wrapping up
182 //! The id of the group the window belongs to
185 //! The client which this client is a transient (child) for
186 Client
*_transient_for
;
188 //! The clients which are transients (children) of this client
189 Client::List _transients
;
191 //! The desktop on which the window resides (0xffffffff for all desktops)
192 unsigned int _desktop
;
194 //! Normal window title
196 //! Window title when iconifiged
197 otk::ustring _icon_title
;
199 //! The application that created the window
200 std::string _app_name
;
201 //! The class of the window, can used for grouping
202 std::string _app_class
;
203 //! The specified role of the window, used for identification
206 //! The type of window (what its function is)
209 //! Position and size of the window
211 This will not always be the actual position of the window on screen, it is
212 rather, the position requested by the client, to which the window's gravity
217 //! The window's strut
219 The strut defines areas of the screen that are marked off-bounds for window
220 placement. In theory, where this window exists.
224 //! The logical size of the window
226 The "logical" size of the window is refers to the user's perception of the
227 size of the window, and is the value that should be displayed to the user.
228 For example, with xterms, this value it the number of characters being
229 displayed in the terminal, instead of the number of pixels.
231 otk::Size _logical_size
;
233 //! Width of the border on the window.
235 The window manager will set this to 0 while the window is being managed,
236 but needs to restore it afterwards, so it is saved here.
240 //! The minimum aspect ratio the client window can be sized to.
242 A value of 0 means this is ignored.
245 //! The maximum aspect ratio the client window can be sized to.
247 A value of 0 means this is ignored.
251 //! The minimum size of the client window
253 If the min is > the max, then the window is not resizable
256 //! The maximum size of the client window
258 If the min is > the max, then the window is not resizable
261 //! The size of increments to resize the client window by
263 //! The base size of the client window
265 This value should be subtracted from the window's actual size when
266 displaying its size to the user, or working with its min/max size
268 otk::Size _base_size
;
270 //! Window decoration and functionality hints
273 //! Where to place the decorated window in relation to the undecorated window
276 //! The state of the window, one of WithdrawnState, IconicState, or
280 //! True if the client supports the delete_window protocol
283 //! Was the window's position requested by the application? if not, we should
284 //! place the window ourselves when it first appears
287 //! Can the window receive input focus?
291 //! Notify the window when it receives focus?
293 //! Does the client window have the input focus?
296 //! The window uses shape extension to be non-rectangular?
299 //! The window is modal, so it must be processed before any windows it is
300 //! related to can be focused
302 //! Only the window's titlebar is displayed
304 //! The window is iconified
306 //! The window is maximized to fill the screen vertically
308 //! The window is maximized to fill the screen horizontally
310 //! The window should not be displayed by pagers
312 //! The window should not be displayed by taskbars
314 //! The window is a 'fullscreen' window, and should be on top of all others
316 //! The window should be on top of other windows of the same type
318 //! The window should be underneath other windows of the same type
321 //! The layer in which the window will be stacked, windows in lower layers
322 //! are always below windows in higher layers.
325 //! A bitmask of values in the Client::Decoration enum
327 The values in the variable are the decorations that the client wants to be
330 DecorationFlags _decorations
;
332 //! A bitmask of values in the Client::Decoration enum.
334 Specifies the decorations that should NOT be displayed on the client.
336 DecorationFlags _disabled_decorations
;
338 //! A bitmask of values in the Client::Function enum
340 The values in the variable specify the ways in which the user is allowed to
343 FunctionFlags _functions
;
345 //! Retrieves the window's initial gravity
347 //! Retrieves the desktop hint's value and sets Client::_desktop
349 //! Retrieves the window's type and sets Client::_type
351 //! Gets the MWM Hints and adjusts Client::_functions and
352 //! Client::_decorations
354 //! Gets the position and size of the window and sets Client::_area
356 //! Gets the net_state hint and sets the boolean flags for any states set in
359 //! Determines if the window uses the Shape extension and sets
363 //! Set up what decor should be shown on the window and what functions should
364 //! be allowed (Client::_decorations and Client::_functions).
366 This also updates the NET_WM_ALLOWED_ACTIONS hint.
368 void setupDecorAndFunctions();
370 //! Sets the wm_state to the specified value
371 void setWMState(long state
);
372 //! Adjusts the window's net_state
374 This should not be called as part of the window mapping process! It is for
375 use when updating the state post-mapping.<br>
376 Client::applyStartupState is used to do the same things during the mapping
379 void setState(StateAction action
, long data1
, long data2
);
381 //! Sends the window to the specified desktop
382 void setDesktop(unsigned int desktop
);
384 //! Calculates the stacking layer for the client window
387 //! Update the protocols that the window supports and adjusts things if they
389 void updateProtocols();
390 //! Updates the WMNormalHints and adjusts things if they change
391 void updateNormalHints();
392 //! Updates the WMHints and adjusts things if they change
394 @param initstate Whether to read the initial_state property from the
395 WMHints. This should only be used during the mapping
398 void updateWMHints(bool initstate
= false);
399 //! Updates the window's title
401 //! Updates the window's icon title
402 void updateIconTitle();
403 //! Updates the window's application name and class
405 //! Updates the strut for the client
407 //! Updates the window's transient status, and any parents of it
408 void updateTransientFor();
410 //! Change the client's state hints to match the class' data
412 //! Change the allowed actions set on the client
413 void changeAllowedActions();
415 //! Request the client to close its window.
418 //! Shades or unshades the client window
420 @param shade true if the window should be shaded; false if it should be
423 void shade(bool shade
);
425 //! Recursively searches the client 'tree' for a modal client, always skips
426 //! the topmost node (the window you're starting with).
427 Client
*Client::searchModalTree(Client
*node
, Client
*skip
);
429 //! Fires the urgent callbacks which lets the user do what they want with
433 //! Fullscreen's or unfullscreen's the client window
435 @param fs true if the window should be made fullscreen; false if it should
436 be returned to normal state.
437 @param savearea true to have the client's current size and position saved;
438 otherwise, they are not. You should not save when mapping a
439 new window that is set to fullscreen. This has no effect
440 when restoring a window from fullscreen.
442 void fullscreen(bool fs
, bool savearea
= true);
444 //! Iconifies or uniconifies the client window
446 @param iconic true if the window should be iconified; false if it should be
448 @param curdesk If iconic is false, then this determines if the window will
449 be uniconified to the current viewable desktop (true) or to
450 its previous desktop (false)
452 void iconify(bool iconic
, bool curdesk
= true);
454 //! Maximize or unmaximize the client window
456 @param max true if the window should be maximized; false if it should be
457 returned to normal size.
458 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
459 @param savearea true to have the client's current size and position saved;
460 otherwise, they are not. You should not save when mapping a
461 new window that is set to fullscreen. This has no effect
462 when unmaximizing a window.
464 void maximize(bool max
, int dir
, bool savearea
= true);
466 //! Internal version of the Client::move function
468 @param x The X coordinate to move to.
469 @param y The Y coordinate to move to.
471 void internal_move(int x
, int y
);
472 //! Internal version of the Client::resize function
474 This also maintains things like the client's minsize, and size increments.
475 @param anchor The corner to keep in the same position when resizing.
476 @param w The width component of the new size for the client.
477 @param h The height component of the new size for the client.
478 @param user Specifies whether this is a user-requested change or a
479 program requested change.
480 @param x An optional X coordinate to which the window will be moved
482 @param y An optional Y coordinate to which the window will be moved
484 The x and y coordinates must both be sepcified together, or they will have
485 no effect. When they are specified, the anchor is ignored.
487 void internal_resize(Corner anchor
, int w
, int h
,
488 bool user
= true, int x
= INT_MIN
, int y
= INT_MIN
);
490 //! Removes or reapplies the client's border to its window
492 Used when managing and unmanaging a window.
493 @param addborder true if adding the border to the client; false if removing
496 void toggleClientBorder(bool addborder
);
498 //! Applies the states requested when the window mapped
500 This should be called only once, during the window mapping process. It
501 applies things like maximized, and fullscreen.
503 void applyStartupState();
507 //! Constructs a new Client object around a specified window id
509 BB @param window The window id that the Client class should handle
510 @param screen The screen on which the window resides
512 Client(int screen
, Window window
);
513 //! Destroys the Client object
517 //! Returns the screen on which the clien resides
518 inline int screen() const { return _screen
; }
520 //! Returns the window id that the Client object is handling
521 inline Window
window() const { return _window
; }
523 //! Returns the type of the window, one of the Client::WindowType values
524 inline WindowType
type() const { return _type
; }
525 //! Returns if the window should be treated as a normal window.
527 Some windows (desktops, docks, splash screens) have special rules applied
528 to them in a number of places regarding focus or user interaction.
530 inline bool normal() const {
531 return ! (_type
== Type_Desktop
|| _type
== Type_Dock
||
532 _type
== Type_Splash
);
535 //! Returns the desktop on which the window resides
537 This value is a 0-based index.<br>
538 A value of 0xffffffff indicates that the window exists on all desktops.
540 inline unsigned int desktop() const { return _desktop
; }
541 //! Returns the window's title
542 inline const otk::ustring
&title() const { return _title
; }
543 //! Returns the window's title when it is iconified
544 inline const otk::ustring
&iconTitle() const { return _title
; }
545 //! Returns the application's name to whom the window belongs
546 inline const std::string
&appName() const { return _app_name
; }
547 //! Returns the class of the window
548 inline const std::string
&appClass() const { return _app_class
; }
549 //! Returns the program-specified role of the window
550 inline const std::string
&role() const { return _role
; }
551 //! Returns if the window can be focused
553 @return true if the window can receive focus; otherwise, false
555 inline bool canFocus() const { return _can_focus
; }
556 //! Returns if the window has indicated that it needs urgent attention
557 inline bool urgent() const { return _urgent
; }
558 //! Returns if the window wants to be notified when it receives focus
559 inline bool focusNotify() const { return _focus_notify
; }
560 //! Returns if the window is the focused window
561 inline bool focused() const { return _focused
; }
562 //! Returns if the window uses the Shape extension
563 inline bool shaped() const { return _shaped
; }
564 //! Returns the window's gravity
566 This value determines where to place the decorated window in relation to
567 its position without decorations.<br>
568 One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
569 SouthGravity, StaticGravity, ForgetGravity
571 inline int gravity() const { return _gravity
; }
572 //! Returns if the application requested the initial position for the window
574 If the application did not request a position (this function returns false)
575 then the window should be placed intelligently by the window manager
578 inline bool positionRequested() const { return _positioned
; }
579 //! Returns the decorations that the client window wishes to be displayed on
581 inline DecorationFlags
decorations() const { return _decorations
; }
582 //! Returns the decorations that the user has requested to be disabled on the
584 inline DecorationFlags
disabledDecorations() const
585 { return _disabled_decorations
; }
586 //! Returns the functions that the user can perform on the window
587 inline FunctionFlags
funtions() const { return _functions
; }
589 //! Return the client this window is transient for
590 inline Client
*transientFor() const { return _transient_for
; }
592 //! Returns if the window is modal
594 If the window is modal, then no other windows that it is related to can get
595 focus while it exists/remains modal.
597 inline bool modal() const { return _modal
; }
598 //! The window should not be displayed by pagers
599 inline bool skipPager() const { return _skip_pager
; }
600 //! The window should not be displayed by taskbars
601 inline bool skipTaskbar() const { return _skip_taskbar
; }
602 //! Returns if the window is shaded
604 When the window is shaded, only its titlebar is visible.
606 inline bool shaded() const { return _shaded
; }
607 //! Returns if the window is in fullscreen mode
608 inline bool fullscreen() const { return _fullscreen
; }
609 //! Returns if the window is iconified
611 When the window is iconified, it is not visible at all (except in iconbars/
612 panels/etc that want to show lists of iconified windows
614 inline bool iconic() const { return _iconic
; }
615 //! Returns if the window is maximized vertically
616 inline bool maxVert() const { return _max_vert
; }
617 //! Returns if the window is maximized horizontally
618 inline bool maxHorz() const { return _max_horz
; }
619 //! Returns the window's stacking layer
620 inline StackLayer
layer() const { return _layer
; }
622 //! Returns the logical size of the window
624 The "logical" size of the window is refers to the user's perception of the
625 size of the window, and is the value that should be displayed to the user.
626 For example, with xterms, this value it the number of characters being
627 displayed in the terminal, instead of the number of pixels.
629 const otk::Size
&logicalSize() const { return _logical_size
; }
631 //! Returns the position and size of the client relative to the root window
633 Note that this value is *not* the size and position of the window's
634 frame, though the position will often line up.<br>
635 If you want the frame's area, use Frame::area() instead.
637 inline const otk::Rect
&area() const { return _area
; }
639 //! Returns the client's strut definition
640 inline const otk::Strut
&strut() const { return _strut
; }
642 //! Move the window (actually, its frame) to a position.
644 This moves the window so that the top-left corner of its frame will be at
645 the position specified.
646 @param x The X coordinate to move to.
647 @param y The Y coordinate to move to.
649 void move(int x
, int y
);
651 //! Resizes the client window, anchoring it in a given corner
653 This also maintains things like the client's minsize, and size increments.
654 @param anchor The corner to keep in the same position when resizing.
655 @param w The width component of the new size for the client.
656 @param h The height component of the new size for the client.
658 void resize(Corner anchor
, int w
, int h
);
660 //! Reapplies the maximized state to the window
662 Use this to make the window readjust its maximized size to new
663 surroundings (struts, etc).
667 //! Shows the window if it should be shown, or hides it
669 Used when changing desktops, the window's state, etc.
673 //! Choose a mask of decorations to not display on the client
675 Pass a value of 0 to the function to turn all decorations back on. Note
676 that you cannot add decorations to a window with this, you can only remove
677 decorations that would otherwise have been displayed.
678 @param flags The mask of values from Client::Decoration to specify which
679 decorations should not be displayed.
681 void disableDecorations(DecorationFlags flags
);
683 //! Return a modal child of the client window
685 @return A modal child of the client window, or 0 if none was found.
687 Client
*findModalChild();
689 //! Attempt to focus the client window
692 //! Remove focus from the client window
693 void unfocus() const;
695 //! Validate client, by making sure no Destroy or Unmap events exist in
696 //! the event queue for the window.
698 @return true if the client is valid; false if the client has already
699 been unmapped/destroyed, and so is invalid.
701 bool validate() const;
703 void installColormap(bool install
) const;
705 virtual void focusHandler(const XFocusChangeEvent
&e
);
706 virtual void unfocusHandler(const XFocusChangeEvent
&e
);
707 virtual void propertyHandler(const XPropertyEvent
&e
);
708 virtual void clientMessageHandler(const XClientMessageEvent
&e
);
709 virtual void configureRequestHandler(const XConfigureRequestEvent
&e
);
710 virtual void unmapHandler(const XUnmapEvent
&e
);
711 virtual void destroyHandler(const XDestroyWindowEvent
&e
);
712 virtual void reparentHandler(const XReparentEvent
&e
);
713 virtual void mapRequestHandler(const XMapRequestEvent
&e
);
715 virtual void shapeHandler(const XShapeEvent
&e
);
718 friend void Screen::manageWindow(Window
);
719 friend void Screen::unmanageWindow(Client
*);
724 #endif // __client_hh