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_Icon
= 1 << 3, //!< Display the window's icon
145 Decor_Iconify
= 1 << 4, //!< Display an iconify button
146 Decor_Maximize
= 1 << 5, //!< Display a maximize button
147 //! Display a button to toggle the window's placement on
149 Decor_AllDesktops
= 1 << 6,
150 Decor_Close
= 1 << 7 //!< Display a close button
152 //! Holds a bitmask of Client::Decoration values
153 typedef unsigned char DecorationFlags
;
155 //! Possible actions that can be made with the _NET_WM_STATE client message
156 enum StateAction
{ State_Remove
= 0, //!< _NET_WM_STATE_REMOVE
157 State_Add
, //!< _NET_WM_STATE_ADD
158 State_Toggle
//!< _NET_WM_STATE_TOGGLE
161 //! The event mask to grab on client windows
162 static const long event_mask
= PropertyChangeMask
| FocusChangeMask
|
165 //! The mask of events to not let propogate past the client
167 This makes things like xprop work on the client window, but means we have
168 to explicitly grab clicks that we want.
170 static const long no_propagate_mask
= ButtonPressMask
| ButtonReleaseMask
|
173 //! The number of unmap events to ignore on the window
177 //! The screen number on which the client resides
180 //! The actual window that this class is wrapping up
183 //! The id of the group the window belongs to
186 //! The client which this client is a transient (child) for
187 Client
*_transient_for
;
189 //! The clients which are transients (children) of this client
190 Client::List _transients
;
192 //! The desktop on which the window resides (0xffffffff for all desktops)
193 unsigned int _desktop
;
195 //! Normal window title
197 //! Window title when iconifiged
198 otk::ustring _icon_title
;
200 //! The application that created the window
201 std::string _app_name
;
202 //! The class of the window, can used for grouping
203 std::string _app_class
;
204 //! The specified role of the window, used for identification
207 //! The type of window (what its function is)
210 //! Position and size of the window
212 This will not always be the actual position of the window on screen, it is
213 rather, the position requested by the client, to which the window's gravity
218 //! The window's strut
220 The strut defines areas of the screen that are marked off-bounds for window
221 placement. In theory, where this window exists.
225 //! The logical size of the window
227 The "logical" size of the window is refers to the user's perception of the
228 size of the window, and is the value that should be displayed to the user.
229 For example, with xterms, this value it the number of characters being
230 displayed in the terminal, instead of the number of pixels.
232 otk::Size _logical_size
;
234 //! Width of the border on the window.
236 The window manager will set this to 0 while the window is being managed,
237 but needs to restore it afterwards, so it is saved here.
241 //! The minimum aspect ratio the client window can be sized to.
243 A value of 0 means this is ignored.
246 //! The maximum aspect ratio the client window can be sized to.
248 A value of 0 means this is ignored.
252 //! The minimum size of the client window
254 If the min is > the max, then the window is not resizable
257 //! The maximum size of the client window
259 If the min is > the max, then the window is not resizable
262 //! The size of increments to resize the client window by
264 //! The base size of the client window
266 This value should be subtracted from the window's actual size when
267 displaying its size to the user, or working with its min/max size
269 otk::Size _base_size
;
271 //! Window decoration and functionality hints
274 //! Where to place the decorated window in relation to the undecorated window
277 //! The state of the window, one of WithdrawnState, IconicState, or
281 //! True if the client supports the delete_window protocol
284 //! Was the window's position requested by the application? if not, we should
285 //! place the window ourselves when it first appears
288 //! Can the window receive input focus?
292 //! Notify the window when it receives focus?
294 //! Does the client window have the input focus?
297 //! The window uses shape extension to be non-rectangular?
300 //! The window is modal, so it must be processed before any windows it is
301 //! related to can be focused
303 //! Only the window's titlebar is displayed
305 //! The window is iconified
307 //! The window is maximized to fill the screen vertically
309 //! The window is maximized to fill the screen horizontally
311 //! The window should not be displayed by pagers
313 //! The window should not be displayed by taskbars
315 //! The window is a 'fullscreen' window, and should be on top of all others
317 //! The window should be on top of other windows of the same type
319 //! The window should be underneath other windows of the same type
322 //! The layer in which the window will be stacked, windows in lower layers
323 //! are always below windows in higher layers.
326 //! A bitmask of values in the Client::Decoration enum
328 The values in the variable are the decorations that the client wants to be
331 DecorationFlags _decorations
;
333 //! A bitmask of values in the Client::Decoration enum.
335 Specifies the decorations that should NOT be displayed on the client.
337 DecorationFlags _disabled_decorations
;
339 //! A bitmask of values in the Client::Function enum
341 The values in the variable specify the ways in which the user is allowed to
344 FunctionFlags _functions
;
346 //! Icons for the client as specified on the client window
348 //! The number of icons in _icons
351 //! Retrieves the window's initial gravity
353 //! Retrieves the desktop hint's value and sets Client::_desktop
355 //! Retrieves the window's type and sets Client::_type
357 //! Gets the MWM Hints and adjusts Client::_functions and
358 //! Client::_decorations
360 //! Gets the position and size of the window and sets Client::_area
362 //! Gets the net_state hint and sets the boolean flags for any states set in
365 //! Determines if the window uses the Shape extension and sets
369 //! Set up what decor should be shown on the window and what functions should
370 //! be allowed (Client::_decorations and Client::_functions).
372 This also updates the NET_WM_ALLOWED_ACTIONS hint.
374 void setupDecorAndFunctions();
376 //! Sets the wm_state to the specified value
377 void setWMState(long state
);
378 //! Adjusts the window's net_state
380 This should not be called as part of the window mapping process! It is for
381 use when updating the state post-mapping.<br>
382 Client::applyStartupState is used to do the same things during the mapping
385 void setState(StateAction action
, long data1
, long data2
);
387 //! Sends the window to the specified desktop
388 void setDesktop(unsigned int desktop
);
390 //! Calculates the stacking layer for the client window
393 //! Update the protocols that the window supports and adjusts things if they
395 void updateProtocols();
396 //! Updates the WMNormalHints and adjusts things if they change
397 void updateNormalHints();
398 //! Updates the WMHints and adjusts things if they change
400 @param initstate Whether to read the initial_state property from the
401 WMHints. This should only be used during the mapping
404 void updateWMHints(bool initstate
= false);
405 //! Updates the window's title
407 //! Updates the window's icon title
408 void updateIconTitle();
409 //! Updates the window's application name and class
411 //! Updates the strut for the client
413 //! Updates the window's transient status, and any parents of it
414 void updateTransientFor();
415 //! Updates the window's icons
418 //! Change the client's state hints to match the class' data
420 //! Change the allowed actions set on the client
421 void changeAllowedActions();
423 //! Request the client to close its window.
426 //! Shades or unshades the client window
428 @param shade true if the window should be shaded; false if it should be
431 void shade(bool shade
);
433 //! Recursively searches the client 'tree' for a modal client, always skips
434 //! the topmost node (the window you're starting with).
435 Client
*Client::searchModalTree(Client
*node
, Client
*skip
);
437 //! Recursively searches the client 'tree' for a focused client, always skips
438 //! the topmost node (the window you're starting with).
439 Client
*Client::searchFocusTree(Client
*node
, Client
*skip
);
441 //! Fires the urgent callbacks which lets the user do what they want with
445 //! Fullscreen's or unfullscreen's the client window
447 @param fs true if the window should be made fullscreen; false if it should
448 be returned to normal state.
449 @param savearea true to have the client's current size and position saved;
450 otherwise, they are not. You should not save when mapping a
451 new window that is set to fullscreen. This has no effect
452 when restoring a window from fullscreen.
454 void fullscreen(bool fs
, bool savearea
= true);
456 //! Iconifies or uniconifies the client window
458 @param iconic true if the window should be iconified; false if it should be
460 @param curdesk If iconic is false, then this determines if the window will
461 be uniconified to the current viewable desktop (true) or to
462 its previous desktop (false)
464 void iconify(bool iconic
, bool curdesk
= true);
466 //! Maximize or unmaximize the client window
468 @param max true if the window should be maximized; false if it should be
469 returned to normal size.
470 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
471 @param savearea true to have the client's current size and position saved;
472 otherwise, they are not. You should not save when mapping a
473 new window that is set to fullscreen. This has no effect
474 when unmaximizing a window.
476 void maximize(bool max
, int dir
, bool savearea
= true);
478 //! Internal version of the Client::move function
480 @param x The X coordinate to move to.
481 @param y The Y coordinate to move to.
483 void internal_move(int x
, int y
);
484 //! Internal version of the Client::resize function
486 This also maintains things like the client's minsize, and size increments.
487 @param anchor The corner to keep in the same position when resizing.
488 @param w The width component of the new size for the client.
489 @param h The height component of the new size for the client.
490 @param user Specifies whether this is a user-requested change or a
491 program requested change.
492 @param x An optional X coordinate to which the window will be moved
494 @param y An optional Y coordinate to which the window will be moved
496 The x and y coordinates must both be sepcified together, or they will have
497 no effect. When they are specified, the anchor is ignored.
499 void internal_resize(Corner anchor
, int w
, int h
,
500 bool user
= true, int x
= INT_MIN
, int y
= INT_MIN
);
502 //! Removes or reapplies the client's border to its window
504 Used when managing and unmanaging a window.
505 @param addborder true if adding the border to the client; false if removing
508 void toggleClientBorder(bool addborder
);
510 //! Applies the states requested when the window mapped
512 This should be called only once, during the window mapping process. It
513 applies things like maximized, and fullscreen.
515 void applyStartupState();
519 //! Constructs a new Client object around a specified window id
521 BB @param window The window id that the Client class should handle
522 @param screen The screen on which the window resides
524 Client(int screen
, Window window
);
525 //! Destroys the Client object
529 //! Returns the screen on which the clien resides
530 inline int screen() const { return _screen
; }
532 //! Returns the window id that the Client object is handling
533 inline Window
window() const { return _window
; }
535 //! Returns the type of the window, one of the Client::WindowType values
536 inline WindowType
type() const { return _type
; }
537 //! Returns if the window should be treated as a normal window.
539 Some windows (desktops, docks, splash screens) have special rules applied
540 to them in a number of places regarding focus or user interaction.
542 inline bool normal() const {
543 return ! (_type
== Type_Desktop
|| _type
== Type_Dock
||
544 _type
== Type_Splash
);
547 //! Returns the desktop on which the window resides
549 This value is a 0-based index.<br>
550 A value of 0xffffffff indicates that the window exists on all desktops.
552 inline unsigned int desktop() const { return _desktop
; }
553 //! Returns the window's title
554 inline const otk::ustring
&title() const { return _title
; }
555 //! Returns the window's title when it is iconified
556 inline const otk::ustring
&iconTitle() const { return _title
; }
557 //! Returns the application's name to whom the window belongs
558 inline const std::string
&appName() const { return _app_name
; }
559 //! Returns the class of the window
560 inline const std::string
&appClass() const { return _app_class
; }
561 //! Returns the program-specified role of the window
562 inline const std::string
&role() const { return _role
; }
563 //! Returns if the window can be focused
565 @return true if the window can receive focus; otherwise, false
567 inline bool canFocus() const { return _can_focus
; }
568 //! Returns if the window has indicated that it needs urgent attention
569 inline bool urgent() const { return _urgent
; }
570 //! Returns if the window wants to be notified when it receives focus
571 inline bool focusNotify() const { return _focus_notify
; }
572 //! Returns if the window is the focused window
573 inline bool focused() const { return _focused
; }
574 //! Returns if the window uses the Shape extension
575 inline bool shaped() const { return _shaped
; }
576 //! Returns the window's gravity
578 This value determines where to place the decorated window in relation to
579 its position without decorations.<br>
580 One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
581 SouthGravity, StaticGravity, ForgetGravity
583 inline int gravity() const { return _gravity
; }
584 //! Returns if the application requested the initial position for the window
586 If the application did not request a position (this function returns false)
587 then the window should be placed intelligently by the window manager
590 inline bool positionRequested() const { return _positioned
; }
591 //! Returns the decorations that the client window wishes to be displayed on
593 inline DecorationFlags
decorations() const { return _decorations
; }
594 //! Returns the decorations that the user has requested to be disabled on the
596 inline DecorationFlags
disabledDecorations() const
597 { return _disabled_decorations
; }
598 //! Returns the functions that the user can perform on the window
599 inline FunctionFlags
funtions() const { return _functions
; }
601 //! Return the client this window is transient for
602 inline Client
*transientFor() const { return _transient_for
; }
604 //! Returns if the window is modal
606 If the window is modal, then no other windows that it is related to can get
607 focus while it exists/remains modal.
609 inline bool modal() const { return _modal
; }
610 //! The window should not be displayed by pagers
611 inline bool skipPager() const { return _skip_pager
; }
612 //! The window should not be displayed by taskbars
613 inline bool skipTaskbar() const { return _skip_taskbar
; }
614 //! Returns if the window is shaded
616 When the window is shaded, only its titlebar is visible.
618 inline bool shaded() const { return _shaded
; }
619 //! Returns if the window is in fullscreen mode
620 inline bool fullscreen() const { return _fullscreen
; }
621 //! Returns if the window is iconified
623 When the window is iconified, it is not visible at all (except in iconbars/
624 panels/etc that want to show lists of iconified windows
626 inline bool iconic() const { return _iconic
; }
627 //! Returns if the window is maximized vertically
628 inline bool maxVert() const { return _max_vert
; }
629 //! Returns if the window is maximized horizontally
630 inline bool maxHorz() const { return _max_horz
; }
631 //! Returns the window's stacking layer
632 inline StackLayer
layer() const { return _layer
; }
634 //! Returns the logical size of the window
636 The "logical" size of the window is refers to the user's perception of the
637 size of the window, and is the value that should be displayed to the user.
638 For example, with xterms, this value it the number of characters being
639 displayed in the terminal, instead of the number of pixels.
641 const otk::Size
&logicalSize() const { return _logical_size
; }
643 //! Returns the position and size of the client relative to the root window
645 Note that this value is *not* the size and position of the window's
646 frame, though the position will often line up.<br>
647 If you want the frame's area, use Frame::area() instead.
649 inline const otk::Rect
&area() const { return _area
; }
651 //! Returns the client's strut definition
652 inline const otk::Strut
&strut() const { return _strut
; }
654 //! Returns an icon for the window
656 The icon chosen will be the smallest icon available that is still bigger or
657 equal to the specified Size.<br>
658 If none that meet the requirements is found, the largest icon that is
659 smaller than the specified size will be returned.
661 const Icon
*icon(const otk::Size
&s
) const;
663 //! Move the window (actually, its frame) to a position.
665 This moves the window so that the top-left corner of its frame will be at
666 the position specified.
667 @param x The X coordinate to move to.
668 @param y The Y coordinate to move to.
670 void move(int x
, int y
);
672 //! Resizes the client window, anchoring it in a given corner
674 This also maintains things like the client's minsize, and size increments.
675 @param anchor The corner to keep in the same position when resizing.
676 @param w The width component of the new size for the client.
677 @param h The height component of the new size for the client.
679 void resize(Corner anchor
, int w
, int h
);
681 //! Reapplies the maximized state to the window
683 Use this to make the window readjust its maximized size to new
684 surroundings (struts, etc).
688 //! Shows the window if it should be shown, or hides it
690 Used when changing desktops, the window's state, etc.
694 //! Choose a mask of decorations to not display on the client
696 Pass a value of 0 to the function to turn all decorations back on. Note
697 that you cannot add decorations to a window with this, you can only remove
698 decorations that would otherwise have been displayed.
699 @param flags The mask of values from Client::Decoration to specify which
700 decorations should not be displayed.
702 void disableDecorations(DecorationFlags flags
);
704 //! Return a modal child of the client window
706 @return A modal child of the client window, or 0 if none was found.
708 Client
*findModalChild();
710 //! Attempt to focus the client window
713 //! Remove focus from the client window
714 void unfocus() const;
716 //! Validate client, by making sure no Destroy or Unmap events exist in
717 //! the event queue for the window.
719 @return true if the client is valid; false if the client has already
720 been unmapped/destroyed, and so is invalid.
722 bool validate() const;
724 void installColormap(bool install
) const;
726 virtual void focusHandler(const XFocusChangeEvent
&e
);
727 virtual void unfocusHandler(const XFocusChangeEvent
&e
);
728 virtual void propertyHandler(const XPropertyEvent
&e
);
729 virtual void clientMessageHandler(const XClientMessageEvent
&e
);
730 virtual void configureRequestHandler(const XConfigureRequestEvent
&e
);
731 virtual void unmapHandler(const XUnmapEvent
&e
);
732 virtual void destroyHandler(const XDestroyWindowEvent
&e
);
733 virtual void reparentHandler(const XReparentEvent
&e
);
734 virtual void mapRequestHandler(const XMapRequestEvent
&e
);
736 virtual void shapeHandler(const XShapeEvent
&e
);
739 friend void Screen::manageWindow(Window
);
740 friend void Screen::unmanageWindow(Client
*);
745 #endif // __client_hh