1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef INCLUDED_VCL_INC_UNX_WMADAPTOR_HXX
21 #define INCLUDED_VCL_INC_UNX_WMADAPTOR_HXX
23 #include <rtl/ustring.hxx>
24 #include <tools/gen.hxx>
27 #include <X11/Xutil.h>
29 #include <vclpluginapi.h>
38 class VCLPLUG_GEN_PUBLIC WMAdaptor
45 // atoms for extended WM hints
47 NET_SUPPORTING_WM_CHECK
,
54 NET_WM_STATE_MAXIMIZED_HORZ
,
55 NET_WM_STATE_MAXIMIZED_VERT
,
58 NET_WM_STATE_SKIP_PAGER
,
59 NET_WM_STATE_SKIP_TASKBAR
,
60 NET_WM_STATE_STAYS_ON_TOP
,
62 NET_WM_STATE_FULLSCREEN
,
67 NET_WM_WINDOW_TYPE_DESKTOP
,
68 NET_WM_WINDOW_TYPE_DIALOG
,
69 NET_WM_WINDOW_TYPE_DOCK
,
70 NET_WM_WINDOW_TYPE_MENU
,
71 NET_WM_WINDOW_TYPE_NORMAL
,
72 NET_WM_WINDOW_TYPE_TOOLBAR
,
73 KDE_NET_WM_WINDOW_TYPE_OVERRIDE
,
74 NET_WM_WINDOW_TYPE_SPLASH
,
75 NET_WM_WINDOW_TYPE_UTILITY
,
76 NET_NUMBER_OF_DESKTOPS
,
81 // atoms for Gnome WM hints
82 WIN_SUPPORTING_WM_CHECK
,
94 // atoms for general WM hints
118 * flags for frame decoration
120 static const int decoration_Title
= 0x00000001;
121 static const int decoration_Border
= 0x00000002;
122 static const int decoration_Resize
= 0x00000004;
123 static const int decoration_MinimizeBtn
= 0x00000008;
124 static const int decoration_MaximizeBtn
= 0x00000010;
125 static const int decoration_CloseBtn
= 0x00000020;
126 static const int decoration_All
= 0x10000000;
129 SalDisplay
* m_pSalDisplay
; // Display to use
130 Display
* m_pDisplay
; // X Display of SalDisplay
132 Atom m_aWMAtoms
[ NetAtomMax
];
134 bool m_bEqualWorkAreas
;
135 ::std::vector
< tools::Rectangle
>
137 bool m_bEnableAlwaysOnTopWorks
;
138 bool m_bLegacyPartialFullscreen
;
140 int m_nInitWinGravity
;
141 bool m_bWMshouldSwitchWorkspace
;
142 bool m_bWMshouldSwitchWorkspaceInit
;
144 WMAdaptor( SalDisplay
* )
150 * returns whether this instance is useful
151 * only useful for createWMAdaptor
153 virtual bool isValid() const;
155 bool getWMshouldSwitchWorkspace() const;
157 virtual ~WMAdaptor();
160 * creates a valid WMAdaptor instance for the SalDisplay
162 static WMAdaptor
* createWMAdaptor( SalDisplay
* );
165 * may return an empty string if the window manager could
168 const OUString
& getWindowManagerName() const
169 { return m_aWMName
; }
172 * gets the current work area/desktop number: [0,m_nDesktops[ or -1 if unknown
174 int getCurrentWorkArea() const;
176 * gets the workarea the specified window is on (or -1)
178 int getWindowWorkArea( ::Window aWindow
) const;
180 * gets the specified workarea
182 const tools::Rectangle
& getWorkArea( int n
) const
183 { return m_aWMWorkAreas
[n
]; }
186 * attempt to switch the desktop to a certain workarea (ie. virtual desktops)
188 void switchToWorkArea( int nWorkArea
) const;
193 virtual void setWMName( X11SalFrame
* pFrame
, const OUString
& rWMName
) const;
198 void setPID( X11SalFrame
* pFrame
) const;
201 * set WM_CLIENT_MACHINE
203 void setClientMachine( X11SalFrame
* pFrame
) const;
205 void answerPing( X11SalFrame
*, XClientMessageEvent
* ) const;
209 * maximization can be toggled in either direction
210 * to get the original position and size
211 * use maximizeFrame( pFrame, false, false )
213 virtual void maximizeFrame( X11SalFrame
* pFrame
, bool bHorizontal
= true, bool bVertical
= true ) const;
215 * start/stop fullscreen mode on a frame
217 virtual void showFullScreen( X11SalFrame
* pFrame
, bool bFullScreen
) const;
219 * tell whether legacy partial full screen handling is necessary
220 * see #i107249#: NET_WM_STATE_FULLSCREEN is not well defined, but de facto
221 * modern WM's interpret it the "right" way, namely they make "full screen"
222 * taking twin view or Xinerama into account and honor the positioning hints
223 * to see which screen actually was meant to use for fullscreen.
225 bool isLegacyPartialFullscreen() const
226 { return m_bLegacyPartialFullscreen
; }
228 * set _NET_WM_USER_TIME property, if NetWM
230 virtual void setUserTime( X11SalFrame
* i_pFrame
, long i_nUserTime
) const;
233 * tells whether fullscreen mode is supported by WM
235 bool supportsFullScreen() const { return m_aWMAtoms
[ NET_WM_STATE_FULLSCREEN
] != 0; }
238 * shade/unshade frame
240 virtual void shade( X11SalFrame
* pFrame
, bool bToShaded
) const;
243 * set hints what decoration is needed;
244 * must be called before showing the frame
246 virtual void setFrameTypeAndDecoration( X11SalFrame
* pFrame
, WMWindowType eType
, int nDecorationFlags
, X11SalFrame
* pTransientFrame
) const;
249 * tells whether there is WM support for splash screens
251 bool supportsSplash() const { return m_aWMAtoms
[ NET_WM_WINDOW_TYPE_SPLASH
] != 0; }
254 * enables always on top or equivalent if possible
256 virtual void enableAlwaysOnTop( X11SalFrame
* pFrame
, bool bEnable
) const;
259 * tells whether enableAlwaysOnTop actually works with this WM
261 bool isAlwaysOnTopOK() const { return m_bEnableAlwaysOnTopWorks
; }
264 * handle WM messages (especially WM state changes)
266 virtual int handlePropertyNotify( X11SalFrame
* pFrame
, XPropertyEvent
* pEvent
) const;
269 * called by SalFrame::Show: time to update state properties
271 virtual void frameIsMapping( X11SalFrame
* ) const;
276 Atom
getAtom( WMAtom eAtom
) const
277 { return m_aWMAtoms
[ eAtom
]; }
279 int getPositionWinGravity () const
280 { return m_nWinGravity
; }
281 int getInitWinGravity() const
282 { return m_nInitWinGravity
; }
285 * changes the transient hint of a window to reference frame
286 * if reference frame is NULL the root window is used instead
288 void changeReferenceFrame( X11SalFrame
* pFrame
, X11SalFrame
* pReferenceFrame
) const;
295 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */