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>
32 //! The MWM Hints as retrieved from the window property
34 This structure only contains 3 elements, even though the Motif 2.0
35 structure contains 5. We only use the first 3, so that is all gets defined.
38 unsigned long flags
; //!< A bitmask of Client::MwmFlags values
39 unsigned long functions
; //!< A bitmask of Client::MwmFunctions values
40 unsigned long decorations
;//!< A bitmask of Client::MwmDecorations values
41 //! The number of elements in the Client::MwmHints struct
42 static const unsigned int elements
= 3;
45 //! Maintains the state of a client window.
47 Client maintains the state of a client window. The state consists of the
48 hints that the application sets on the window, such as the title, or window
51 Client also manages client messages for the client window. When the
52 application (or any application) requests something to be changed for the
53 client, it will call the ActionHandler (for client messages) or update the
54 class' member variables and call whatever is nessary to complete the
55 change (such as causing a redraw of the titlebar after the title is changed).
57 class Client
: public otk::EventHandler
{
60 //! The frame window which decorates around the client window
62 NOTE: This should NEVER be used inside the client class's constructor!
66 //! Holds a list of Clients
67 typedef std::list
<Client
*> List
;
69 //! The possible stacking layers a client window can be a part of
71 Layer_Icon
, //!< 0 - iconified windows, in any order at all
72 Layer_Desktop
, //!< 1 - desktop windows
73 Layer_Below
, //!< 2 - normal windows w/ below
74 Layer_Normal
, //!< 3 - normal windows
75 Layer_Above
, //!< 4 - normal windows w/ above
76 Layer_Top
, //!< 5 - always-on-top-windows (docks?)
77 Layer_Fullscreen
, //!< 6 - fullscreeen windows
78 Layer_Internal
, //!< 7 - openbox windows/menus
82 //! Corners of the client window, used for anchor positions
83 enum Corner
{ TopLeft
,
88 //! Possible window types
89 enum WindowType
{ Type_Desktop
, //!< A desktop (bottom-most window)
90 Type_Dock
, //!< A dock bar/panel window
91 Type_Toolbar
, //!< A toolbar window, pulled off an app
92 Type_Menu
, //!< An unpinned menu from an app
93 Type_Utility
, //!< A small utility window such as a palette
94 Type_Splash
, //!< A splash screen window
95 Type_Dialog
, //!< A dialog window
96 Type_Normal
//!< A normal application window
99 //! Possible flags for MWM Hints (defined by Motif 2.0)
100 enum MwmFlags
{ MwmFlag_Functions
= 1 << 0, //!< The MMW Hints define funcs
101 MwmFlag_Decorations
= 1 << 1 //!< The MWM Hints define decor
104 //! Possible functions for MWM Hints (defined by Motif 2.0)
105 enum MwmFunctions
{ MwmFunc_All
= 1 << 0, //!< All functions
106 MwmFunc_Resize
= 1 << 1, //!< Allow resizing
107 MwmFunc_Move
= 1 << 2, //!< Allow moving
108 MwmFunc_Iconify
= 1 << 3, //!< Allow to be iconfied
109 MwmFunc_Maximize
= 1 << 4 //!< Allow to be maximized
110 //MwmFunc_Close = 1 << 5 //!< Allow to be closed
113 //! Possible decorations for MWM Hints (defined by Motif 2.0)
114 enum MemDecorations
{ MwmDecor_All
= 1 << 0, //!< All decorations
115 MwmDecor_Border
= 1 << 1, //!< Show a border
116 MwmDecor_Handle
= 1 << 2, //!< Show a handle (bottom)
117 MwmDecor_Title
= 1 << 3, //!< Show a titlebar
118 //MwmDecor_Menu = 1 << 4, //!< Show a menu
119 MwmDecor_Iconify
= 1 << 5, //!< Show an iconify button
120 MwmDecor_Maximize
= 1 << 6 //!< Show a maximize button
123 //! The things the user can do to the client window
124 enum Function
{ Func_Resize
= 1 << 0, //!< Allow resizing
125 Func_Move
= 1 << 1, //!< Allow moving
126 Func_Iconify
= 1 << 2, //!< Allow to be iconified
127 Func_Maximize
= 1 << 3, //!< Allow to be maximized
128 Func_Shade
= 1 << 4, //!< Allow to be shaded
129 Func_Fullscreen
= 1 << 5, //!< Allow to be made fullscreen
130 Func_Close
= 1 << 6 //!< Allow to be closed
132 //! Holds a bitmask of Client::Function values
133 typedef unsigned char FunctionFlags
;
135 //! The decorations the client window wants to be displayed on it
136 enum Decoration
{ Decor_Titlebar
= 1 << 0, //!< Display a titlebar
137 Decor_Handle
= 1 << 1, //!< Display a handle (bottom)
138 Decor_Border
= 1 << 2, //!< Display a border
139 Decor_Iconify
= 1 << 3, //!< Display an iconify button
140 Decor_Maximize
= 1 << 4, //!< Display a maximize button
141 //! Display a button to toggle the window's placement on
143 Decor_AllDesktops
= 1 << 5,
144 Decor_Close
= 1 << 6 //!< Display a close button
146 //! Holds a bitmask of Client::Decoration values
147 typedef unsigned char DecorationFlags
;
149 //! Possible actions that can be made with the _NET_WM_STATE client message
150 enum StateAction
{ State_Remove
= 0, //!< _NET_WM_STATE_REMOVE
151 State_Add
, //!< _NET_WM_STATE_ADD
152 State_Toggle
//!< _NET_WM_STATE_TOGGLE
155 //! The event mask to grab on client windows
156 static const long event_mask
= PropertyChangeMask
| FocusChangeMask
|
159 //! The mask of events to not let propogate past the client
161 This makes things like xprop work on the client window, but means we have
162 to explicitly grab clicks that we want.
164 static const long no_propagate_mask
= ButtonPressMask
| ButtonReleaseMask
|
167 //! The desktop value which indicated the window is iconified and not on any
169 static const long ICONIC_DESKTOP
= 0xfffffffe;
171 //! The number of unmap events to ignore on the window
175 //! The screen number on which the client resides
178 //! The actual window that this class is wrapping up
181 //! The id of the group the window belongs to
184 //! The client which this client is a transient (child) for
185 Client
*_transient_for
;
187 //! The clients which are transients (children) of this client
188 Client::List _transients
;
190 //! The desktop on which the window resides (0xffffffff for all desktops)
193 //! Normal window title
195 //! Window title when iconifiged
196 otk::ustring _icon_title
;
198 //! The application that created the window
199 std::string _app_name
;
200 //! The class of the window, can used for grouping
201 std::string _app_class
;
202 //! The specified role of the window, used for identification
205 //! The type of window (what its function is)
208 //! Position and size of the window
210 This will not always be the actual position of the window on screen, it is
211 rather, the position requested by the client, to which the window's gravity
216 //! The window's strut
218 The strut defines areas of the screen that are marked off-bounds for window
219 placement. In theory, where this window exists.
223 //! The logical size of the window
225 The "logical" size of the window is refers to the user's perception of the
226 size of the window, and is the value that should be displayed to the user.
227 For example, with xterms, this value it the number of characters being
228 displayed in the terminal, instead of the number of pixels.
230 otk::Size _logical_size
;
232 //! Width of the border on the window.
234 The window manager will set this to 0 while the window is being managed,
235 but needs to restore it afterwards, so it is saved here.
239 //! The minimum aspect ratio the client window can be sized to.
241 A value of 0 means this is ignored.
244 //! The maximum aspect ratio the client window can be sized to.
246 A value of 0 means this is ignored.
250 //! The minimum size of the client window
252 If the min is > the max, then the window is not resizable
255 //! The maximum size of the client window
257 If the min is > the max, then the window is not resizable
260 //! The size of increments to resize the client window by
262 //! The base size of the client window
264 This value should be subtracted from the window's actual size when
265 displaying its size to the user, or working with its min/max size
267 otk::Size _base_size
;
269 //! Window decoration and functionality hints
272 //! Where to place the decorated window in relation to the undecorated window
275 //! The state of the window, one of WithdrawnState, IconicState, or
279 //! True if the client supports the delete_window protocol
282 //! Was the window's position requested by the application? if not, we should
283 //! place the window ourselves when it first appears
286 //! Can the window receive input focus?
290 //! Notify the window when it receives focus?
292 //! Does the client window have the input focus?
295 //! The window uses shape extension to be non-rectangular?
298 //! The window is modal, so it must be processed before any windows it is
299 //! related to can be focused
301 //! Only the window's titlebar is displayed
303 //! The window is iconified
305 //! The window is maximized to fill the screen vertically
307 //! The window is maximized to fill the screen horizontally
309 //! The window should not be displayed by pagers
311 //! The window should not be displayed by taskbars
313 //! The window is a 'fullscreen' window, and should be on top of all others
315 //! The window should be on top of other windows of the same type
317 //! The window should be underneath other windows of the same type
322 //! A bitmask of values in the Client::Decoration enum
324 The values in the variable are the decorations that the client wants to be
327 DecorationFlags _decorations
;
329 //! A bitmask of values in the Client::Decoration enum.
331 Specifies the decorations that should NOT be displayed on the client.
333 DecorationFlags _disabled_decorations
;
335 //! A bitmask of values in the Client::Function enum
337 The values in the variable specify the ways in which the user is allowed to
340 FunctionFlags _functions
;
342 //! Retrieves the window's initial gravity
344 //! Retrieves the desktop hint's value and sets Client::_desktop
346 //! Retrieves the window's type and sets Client::_type
348 //! Gets the MWM Hints and adjusts Client::_functions and
349 //! Client::_decorations
351 //! Gets the position and size of the window and sets Client::_area
353 //! Gets the net_state hint and sets the boolean flags for any states set in
356 //! Determines if the window uses the Shape extension and sets
360 //! Set up what decor should be shown on the window and what functions should
361 //! be allowed (Client::_decorations and Client::_functions).
363 This also updates the NET_WM_ALLOWED_ACTIONS hint.
365 void setupDecorAndFunctions();
367 //! Sets the wm_state to the specified value
368 void setWMState(long state
);
369 //! Adjusts the window's net_state
371 This should not be called as part of the window mapping process! It is for
372 use when updating the state post-mapping.<br>
373 Client::applyStartupState is used to do the same things during the mapping
376 void setState(StateAction action
, long data1
, long data2
);
378 //! Sends the window to the specified desktop
380 A window is iconified by sending it to the ICONIC_DESKTOP, and restored
381 by sending it to any other valid desktop.
383 void setDesktop(long desktop
);
385 //! Calculates the stacking layer for the client window
388 //! Update the protocols that the window supports and adjusts things if they
390 void updateProtocols();
391 //! Updates the WMNormalHints and adjusts things if they change
392 void updateNormalHints();
393 //! Updates the WMHints and adjusts things if they change
395 @param initstate Whether to read the initial_state property from the
396 WMHints. This should only be used during the mapping
399 void updateWMHints(bool initstate
= false);
400 //! Updates the window's title
402 //! Updates the window's icon title
403 void updateIconTitle();
404 //! Updates the window's application name and class
406 //! Updates the strut for the client
408 //! Updates the window's transient status, and any parents of it
409 void updateTransientFor();
411 //! Change the client's state hints to match the class' data
413 //! Change the allowed actions set on the client
414 void changeAllowedActions();
416 //! Request the client to close its window.
419 //! Shades or unshades the client window
421 @param shade true if the window should be shaded; false if it should be
424 void shade(bool shade
);
426 //! Recursively searches the client 'tree' for a modal client, always skips
427 //! the topmost node (the window you're starting with).
428 Client
*Client::searchModalTree(Client
*node
, Client
*skip
);
430 //! Fires the urgent callbacks which lets the user do what they want with
434 //! Fullscreen's or unfullscreen's the client window
436 @param fs true if the window should be made fullscreen; false if it should
437 be returned to normal state.
438 @param savearea true to have the client's current size and position saved;
439 otherwise, they are not. You should not save when mapping a
440 new window that is set to fullscreen. This has no effect
441 when restoring a window from fullscreen.
443 void fullscreen(bool fs
, bool savearea
= true);
445 //! Maximize or unmaximize the client window
447 @param max true if the window should be maximized; false if it should be
448 returned to normal size.
449 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
450 @param savearea true to have the client's current size and position saved;
451 otherwise, they are not. You should not save when mapping a
452 new window that is set to fullscreen. This has no effect
453 when unmaximizing a window.
455 void maximize(bool max
, int dir
, bool savearea
= true);
457 //! Internal version of the Client::move function
459 @param x The X coordinate to move to.
460 @param y The Y coordinate to move to.
462 void internal_move(int x
, int y
);
463 //! Internal version of the Client::resize function
465 This also maintains things like the client's minsize, and size increments.
466 @param anchor The corner to keep in the same position when resizing.
467 @param w The width component of the new size for the client.
468 @param h The height component of the new size for the client.
469 @param user Specifies whether this is a user-requested change or a
470 program requested change.
471 @param x An optional X coordinate to which the window will be moved
473 @param y An optional Y coordinate to which the window will be moved
475 The x and y coordinates must both be sepcified together, or they will have
476 no effect. When they are specified, the anchor is ignored.
478 void internal_resize(Corner anchor
, int w
, int h
,
479 bool user
= true, int x
= INT_MIN
, int y
= INT_MIN
);
481 //! Removes or reapplies the client's border to its window
483 Used when managing and unmanaging a window.
484 @param addborder true if adding the border to the client; false if removing
487 void toggleClientBorder(bool addborder
);
489 //! Applies the states requested when the window mapped
491 This should be called only once, during the window mapping process. It
492 applies things like maximized, and fullscreen.
494 void applyStartupState();
498 //! Constructs a new Client object around a specified window id
500 BB @param window The window id that the Client class should handle
501 @param screen The screen on which the window resides
503 Client(int screen
, Window window
);
504 //! Destroys the Client object
508 //! Returns the screen on which the clien resides
509 inline int screen() const { return _screen
; }
511 //! Returns the window id that the Client object is handling
512 inline Window
window() const { return _window
; }
514 //! Returns the type of the window, one of the Client::WindowType values
515 inline WindowType
type() const { return _type
; }
516 //! Returns if the window should be treated as a normal window.
518 Some windows (desktops, docks, splash screens) have special rules applied
519 to them in a number of places regarding focus or user interaction.
521 inline bool normal() const {
522 return ! (_type
== Type_Desktop
|| _type
== Type_Dock
||
523 _type
== Type_Splash
);
526 //! Returns the desktop on which the window resides
528 This value is a 0-based index.<br>
529 A value of 0xffffffff indicates that the window exists on all desktops.
531 inline long desktop() const { return _desktop
; }
532 //! Returns the window's title
533 inline const otk::ustring
&title() const { return _title
; }
534 //! Returns the window's title when it is iconified
535 inline const otk::ustring
&iconTitle() const { return _title
; }
536 //! Returns the application's name to whom the window belongs
537 inline const std::string
&appName() const { return _app_name
; }
538 //! Returns the class of the window
539 inline const std::string
&appClass() const { return _app_class
; }
540 //! Returns the program-specified role of the window
541 inline const std::string
&role() const { return _role
; }
542 //! Returns if the window can be focused
544 @return true if the window can receive focus; otherwise, false
546 inline bool canFocus() const { return _can_focus
; }
547 //! Returns if the window has indicated that it needs urgent attention
548 inline bool urgent() const { return _urgent
; }
549 //! Returns if the window wants to be notified when it receives focus
550 inline bool focusNotify() const { return _focus_notify
; }
551 //! Returns if the window is the focused window
552 inline bool focused() const { return _focused
; }
553 //! Returns if the window uses the Shape extension
554 inline bool shaped() const { return _shaped
; }
555 //! Returns the window's gravity
557 This value determines where to place the decorated window in relation to
558 its position without decorations.<br>
559 One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
560 SouthGravity, StaticGravity, ForgetGravity
562 inline int gravity() const { return _gravity
; }
563 //! Returns if the application requested the initial position for the window
565 If the application did not request a position (this function returns false)
566 then the window should be placed intelligently by the window manager
569 inline bool positionRequested() const { return _positioned
; }
570 //! Returns the decorations that the client window wishes to be displayed on
572 inline DecorationFlags
decorations() const { return _decorations
; }
573 //! Returns the decorations that the user has requested to be disabled on the
575 inline DecorationFlags
disabledDecorations() const
576 { return _disabled_decorations
; }
577 //! Returns the functions that the user can perform on the window
578 inline FunctionFlags
funtions() const { return _functions
; }
580 //! Return the client this window is transient for
581 inline Client
*transientFor() const { return _transient_for
; }
583 //! Returns if the window is modal
585 If the window is modal, then no other windows that it is related to can get
586 focus while it exists/remains modal.
588 inline bool modal() const { return _modal
; }
589 //! The window should not be displayed by pagers
590 inline bool skipPager() const { return _skip_pager
; }
591 //! The window should not be displayed by taskbars
592 inline bool skipTaskbar() const { return _skip_taskbar
; }
593 //! Returns if the window is shaded
595 When the window is shaded, only its titlebar is visible.
597 inline bool shaded() const { return _shaded
; }
598 //! Returns if the window is in fullscreen mode
599 inline bool fullscreen() const { return _fullscreen
; }
600 //! Returns if the window is iconified
602 When the window is iconified, it is not visible at all (except in iconbars/
603 panels/etc that want to show lists of iconified windows
605 inline bool iconic() const { return _iconic
; }
606 //! Returns if the window is maximized vertically
607 inline bool maxVert() const { return _max_vert
; }
608 //! Returns if the window is maximized horizontally
609 inline bool maxHorz() const { return _max_horz
; }
610 //! Returns the window's stacking layer
611 inline StackLayer
layer() const { return _layer
; }
613 //! Returns the logical size of the window
615 The "logical" size of the window is refers to the user's perception of the
616 size of the window, and is the value that should be displayed to the user.
617 For example, with xterms, this value it the number of characters being
618 displayed in the terminal, instead of the number of pixels.
620 const otk::Size
&logicalSize() const { return _logical_size
; }
622 //! Returns the position and size of the client relative to the root window
623 inline const otk::Rect
&area() const { return _area
; }
625 //! Returns the client's strut definition
626 inline const otk::Strut
&strut() const { return _strut
; }
628 //! Move the window (actually, its frame) to a position.
630 This moves the window so that the top-left corner of its frame will be at
631 the position specified.
632 @param x The X coordinate to move to.
633 @param y The Y coordinate to move to.
635 void move(int x
, int y
);
637 //! Resizes the client window, anchoring it in a given corner
639 This also maintains things like the client's minsize, and size increments.
640 @param anchor The corner to keep in the same position when resizing.
641 @param w The width component of the new size for the client.
642 @param h The height component of the new size for the client.
644 void resize(Corner anchor
, int w
, int h
);
646 //! Reapplies the maximized state to the window
648 Use this to make the window readjust its maximized size to new
649 surroundings (struts, etc).
653 //! Choose a mask of decorations to not display on the client
655 Pass a value of 0 to the function to turn all decorations back on. Note
656 that you cannot add decorations to a window with this, you can only remove
657 decorations that would otherwise have been displayed.
658 @param flags The mask of values from Client::Decoration to specify which
659 decorations should not be displayed.
661 void disableDecorations(DecorationFlags flags
);
663 //! Return a modal child of the client window
665 @return A modal child of the client window, or 0 if none was found.
667 Client
*findModalChild();
669 //! Attempt to focus the client window
672 //! Remove focus from the client window
673 void unfocus() const;
675 //! Validate client, by making sure no Destroy or Unmap events exist in
676 //! the event queue for the window.
678 @return true if the client is valid; false if the client has already
679 been unmapped/destroyed, and so is invalid.
681 bool validate() const;
683 void installColormap(bool install
) const;
685 virtual void focusHandler(const XFocusChangeEvent
&e
);
686 virtual void unfocusHandler(const XFocusChangeEvent
&e
);
687 virtual void propertyHandler(const XPropertyEvent
&e
);
688 virtual void clientMessageHandler(const XClientMessageEvent
&e
);
689 virtual void configureRequestHandler(const XConfigureRequestEvent
&e
);
690 virtual void unmapHandler(const XUnmapEvent
&e
);
691 virtual void destroyHandler(const XDestroyWindowEvent
&e
);
692 virtual void reparentHandler(const XReparentEvent
&e
);
693 virtual void mapRequestHandler(const XMapRequestEvent
&e
);
695 virtual void shapeHandler(const XShapeEvent
&e
);
698 friend void Screen::manageWindow(Window
);
699 friend void Screen::unmanageWindow(Client
*);
704 #endif // __client_hh