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
10 #include "widgetbase.hh"
11 #include "otk/point.hh"
12 #include "otk/strut.hh"
13 #include "otk/rect.hh"
14 #include "otk/eventhandler.hh"
15 #include "otk/ustring.hh"
21 #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
, public WidgetBase
{
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::Point _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 size of the client window
241 If the min is > the max, then the window is not resizable
243 otk::Point _min_size
;
244 //! The maximum size of the client window
246 If the min is > the max, then the window is not resizable
248 otk::Point _max_size
;
249 //! The size of increments to resize the client window by
250 otk::Point _size_inc
;
251 //! The base size of the client window
253 This value should be subtracted from the window's actual size when
254 displaying its size to the user, or working with its min/max size
256 otk::Point _base_size
;
258 //! Window decoration and functionality hints
261 //! Where to place the decorated window in relation to the undecorated window
264 //! The state of the window, one of WithdrawnState, IconicState, or
268 //! True if the client supports the delete_window protocol
271 //! Was the window's position requested by the application? if not, we should
272 //! place the window ourselves when it first appears
275 //! Can the window receive input focus?
279 //! Notify the window when it receives focus?
281 //! Does the client window have the input focus?
284 //! The window uses shape extension to be non-rectangular?
287 //! The window is modal, so it must be processed before any windows it is
288 //! related to can be focused
290 //! Only the window's titlebar is displayed
292 //! The window is iconified
294 //! The window is maximized to fill the screen vertically
296 //! The window is maximized to fill the screen horizontally
298 //! The window should not be displayed by pagers
300 //! The window should not be displayed by taskbars
302 //! The window is a 'fullscreen' window, and should be on top of all others
304 //! The window should be on top of other windows of the same type
306 //! The window should be underneath other windows of the same type
311 //! A bitmask of values in the Client::Decoration enum
313 The values in the variable are the decorations that the client wants to be
316 DecorationFlags _decorations
;
318 //! A bitmask of values in the Client::Function enum
320 The values in the variable specify the ways in which the user is allowed to
323 FunctionFlags _functions
;
325 //! Retrieves the window's initial gravity
327 //! Retrieves the desktop hint's value and sets Client::_desktop
329 //! Retrieves the window's type and sets Client::_type
331 //! Gets the MWM Hints and adjusts Client::_functions and
332 //! Client::_decorations
334 //! Gets the position and size of the window and sets Client::_area
336 //! Gets the net_state hint and sets the boolean flags for any states set in
339 //! Determines if the window uses the Shape extension and sets
343 //! Set up what decor should be shown on the window and what functions should
344 //! be allowed (Client::_decorations and Client::_functions).
346 This also updates the NET_WM_ALLOWED_ACTIONS hint.
348 void setupDecorAndFunctions();
350 //! Sets the wm_state to the specified value
351 void setWMState(long state
);
352 //! Adjusts the window's net_state
354 This should not be called as part of the window mapping process! It is for
355 use when updating the state post-mapping.<br>
356 Client::applyStartupState is used to do the same things during the mapping
359 void setState(StateAction action
, long data1
, long data2
);
361 //! Sends the window to the specified desktop
363 A window is iconified by sending it to the ICONIC_DESKTOP, and restored
364 by sending it to any other valid desktop.
366 void setDesktop(long desktop
);
368 //! Calculates the stacking layer for the client window
371 //! Update the protocols that the window supports and adjusts things if they
373 void updateProtocols();
374 //! Updates the WMNormalHints and adjusts things if they change
375 void updateNormalHints();
376 //! Updates the WMHints and adjusts things if they change
378 @param initstate Whether to read the initial_state property from the
379 WMHints. This should only be used during the mapping
382 void updateWMHints(bool initstate
= false);
383 //! Updates the window's title
385 //! Updates the window's icon title
386 void updateIconTitle();
387 //! Updates the window's application name and class
389 //! Updates the strut for the client
391 //! Updates the window's transient status, and any parents of it
392 void updateTransientFor();
394 //! Change the client's state hints to match the class' data
396 //! Change the allowed actions set on the client
397 void changeAllowedActions();
399 //! Request the client to close its window.
402 //! Shades or unshades the client window
404 @param shade true if the window should be shaded; false if it should be
407 void shade(bool shade
);
409 //! Fires the urgent callbacks which lets the user do what they want with
413 //! Fullscreen's or unfullscreen's the client window
415 @param fs true if the window should be made fullscreen; false if it should
416 be returned to normal state.
418 void fullscreen(bool fs
);
420 //! Internal version of the Client::move function
422 @param x The X coordinate to move to.
423 @param y The Y coordinate to move to.
425 void internal_move(int x
, int y
);
426 //! Internal version of the Client::resize function
428 This also maintains things like the client's minsize, and size increments.
429 @param anchor The corner to keep in the same position when resizing.
430 @param w The width component of the new size for the client.
431 @param h The height component of the new size for the client.
432 @param x An optional X coordinate to which the window will be moved
434 @param y An optional Y coordinate to which the window will be moved
436 The x and y coordinates must both be sepcified together, or they will have
437 no effect. When they are specified, the anchor is ignored.
439 void internal_resize(Corner anchor
, int w
, int h
,
440 int x
= INT_MIN
, int y
= INT_MIN
);
444 //! Constructs a new Client object around a specified window id
446 BB @param window The window id that the Client class should handle
447 @param screen The screen on which the window resides
449 Client(int screen
, Window window
);
450 //! Destroys the Client object
454 //! Returns the screen on which the clien resides
455 inline int screen() const { return _screen
; }
457 //! Returns the window id that the Client object is handling
458 inline Window
window() const { return _window
; }
460 //! Returns the type of the window, one of the Client::WindowType values
461 inline WindowType
type() const { return _type
; }
462 //! Returns if the window should be treated as a normal window.
464 Some windows (desktops, docks, splash screens) have special rules applied
465 to them in a number of places regarding focus or user interaction.
467 inline bool normal() const {
468 return ! (_type
== Type_Desktop
|| _type
== Type_Dock
||
469 _type
== Type_Splash
);
472 //! Returns the desktop on which the window resides
474 This value is a 0-based index.<br>
475 A value of 0xffffffff indicates that the window exists on all desktops.
477 inline long desktop() const { return _desktop
; }
478 //! Returns the window's title
479 inline const otk::ustring
&title() const { return _title
; }
480 //! Returns the window's title when it is iconified
481 inline const otk::ustring
&iconTitle() const { return _title
; }
482 //! Returns the application's name to whom the window belongs
483 inline const std::string
&appName() const { return _app_name
; }
484 //! Returns the class of the window
485 inline const std::string
&appClass() const { return _app_class
; }
486 //! Returns the program-specified role of the window
487 inline const std::string
&role() const { return _role
; }
488 //! Returns if the window can be focused
490 @return true if the window can receive focus; otherwise, false
492 inline bool canFocus() const { return _can_focus
; }
493 //! Returns if the window has indicated that it needs urgent attention
494 inline bool urgent() const { return _urgent
; }
495 //! Returns if the window wants to be notified when it receives focus
496 inline bool focusNotify() const { return _focus_notify
; }
497 //! Returns if the window uses the Shape extension
498 inline bool shaped() const { return _shaped
; }
499 //! Returns the window's gravity
501 This value determines where to place the decorated window in relation to
502 its position without decorations.<br>
503 One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
504 SouthGravity, StaticGravity, ForgetGravity
506 inline int gravity() const { return _gravity
; }
507 //! Returns if the application requested the initial position for the window
509 If the application did not request a position (this function returns false)
510 then the window should be placed intelligently by the window manager
513 inline bool positionRequested() const { return _positioned
; }
514 //! Returns the decorations that the client window wishes to be displayed on
516 inline DecorationFlags
decorations() const { return _decorations
; }
517 //! Returns the functions that the user can perform on the window
518 inline FunctionFlags
funtions() const { return _functions
; }
520 //! Return the client this window is transient for
521 inline Client
*transientFor() const { return _transient_for
; }
523 //! Returns if the window is modal
525 If the window is modal, then no other windows that it is related to can get
526 focus while it exists/remains modal.
528 inline bool modal() const { return _modal
; }
529 //! Returns if the window is shaded
531 When the window is shaded, only its titlebar is visible.
533 inline bool shaded() const { return _shaded
; }
534 //! Returns if the window is in fullscreen mode
535 inline bool fullscreen() const { return _fullscreen
; }
536 //! Returns if the window is iconified
538 When the window is iconified, it is not visible at all (except in iconbars/
539 panels/etc that want to show lists of iconified windows
541 inline bool iconic() const { return _iconic
; }
542 //! Returns if the window is maximized vertically
543 inline bool maxVert() const { return _max_vert
; }
544 //! Returns if the window is maximized horizontally
545 inline bool maxHorz() const { return _max_horz
; }
546 //! Returns the window's stacking layer
547 inline StackLayer
layer() const { return _layer
; }
549 //! Applies the states requested when the window mapped
551 This should be called only once, during the window mapping process. It
552 applies things like maximized, and fullscreen.
554 void applyStartupState();
556 //! Removes or reapplies the client's border to its window
558 Used when managing and unmanaging a window.
559 @param addborder true if adding the border to the client; false if removing
562 void toggleClientBorder(bool addborder
);
564 //! Returns the position and size of the client relative to the root window
565 inline const otk::Rect
&area() const { return _area
; }
567 //! Returns the client's strut definition
568 inline const otk::Strut
&strut() const { return _strut
; }
570 //! Move the client window
572 @param x The X coordinate to move to.
573 @param y The Y coordinate to move to.
575 void move(int x
, int y
);
577 //! Resizes the client window, anchoring it in a given corner
579 This also maintains things like the client's minsize, and size increments.
580 @param anchor The corner to keep in the same position when resizing.
581 @param w The width component of the new size for the client.
582 @param h The height component of the new size for the client.
584 void resize(Corner anchor
, int w
, int h
);
586 //! Attempt to focus the client window
589 //! Remove focus from the client window
590 void unfocus() const;
592 virtual void focusHandler(const XFocusChangeEvent
&e
);
593 virtual void unfocusHandler(const XFocusChangeEvent
&e
);
594 virtual void propertyHandler(const XPropertyEvent
&e
);
595 virtual void clientMessageHandler(const XClientMessageEvent
&e
);
596 virtual void configureRequestHandler(const XConfigureRequestEvent
&e
);
597 virtual void unmapHandler(const XUnmapEvent
&e
);
598 virtual void destroyHandler(const XDestroyWindowEvent
&e
);
599 virtual void reparentHandler(const XReparentEvent
&e
);
600 virtual void mapRequestHandler(const XMapRequestEvent
&e
);
602 virtual void shapeHandler(const XShapeEvent
&e
);
608 #endif // __client_hh