vcl/inc/unx/wmadaptor.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_INC_UNX_WMADAPTOR_HXX
  21 #define INCLUDED_VCL_INC_UNX_WMADAPTOR_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <tools/gen.hxx>
  25
  26 #include <X11/Xlib.h>
  27
  28 #include <vclpluginapi.h>
  29 #include "salframe.h"
  30 #include <vector>
  31
  32 class SalDisplay;
  33 class X11SalFrame;
  34
  35 namespace vcl_sal {
  36
  37 class VCLPLUG_GEN_PUBLIC WMAdaptor
  38 {
  39 public:
  40     enum WMAtom {
  41         // atoms for types
  42         UTF8_STRING,
  43
  44         // atoms for extended WM hints
  45         NET_ACTIVE_WINDOW,
  46         NET_SUPPORTED,
  47         NET_SUPPORTING_WM_CHECK,
  48         NET_WM_NAME,
  49         NET_WM_DESKTOP,
  50         NET_WM_ICON_NAME,
  51         NET_WM_PID,
  52         NET_WM_PING,
  53         NET_WM_STATE,
  54         NET_WM_STATE_MAXIMIZED_HORZ,
  55         NET_WM_STATE_MAXIMIZED_VERT,
  56         NET_WM_STATE_MODAL,
  57         NET_WM_STATE_SHADED,
  58         NET_WM_STATE_SKIP_PAGER,
  59         NET_WM_STATE_SKIP_TASKBAR,
  60         NET_WM_STATE_STAYS_ON_TOP,
  61         NET_WM_STATE_STICKY,
  62         NET_WM_STATE_FULLSCREEN,
  63         NET_WM_STRUT,
  64         NET_WM_STRUT_PARTIAL,
  65         NET_WM_USER_TIME,
  66         NET_WM_WINDOW_TYPE,
  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,
  77         NET_CURRENT_DESKTOP,
  78         NET_WORKAREA,
  79         NET_WM_ICON,
  80
  81         // atoms for Gnome WM hints
  82         WIN_SUPPORTING_WM_CHECK,
  83         WIN_PROTOCOLS,
  84         WIN_WORKSPACE_COUNT,
  85         WIN_WORKSPACE,
  86         WIN_LAYER,
  87         WIN_STATE,
  88         WIN_HINTS,
  89         WIN_APP_STATE,
  90         WIN_EXPANDED_SIZE,
  91         WIN_ICONS,
  92         WIN_CLIENT_LIST,
  93
  94         // atoms for general WM hints
  95         WM_STATE,
  96         MOTIF_WM_HINTS,
  97         WM_PROTOCOLS,
  98         WM_DELETE_WINDOW,
  99         WM_TAKE_FOCUS,
 100         WM_CLIENT_LEADER,
 101         WM_COMMAND,
 102         WM_LOCALE_NAME,
 103         WM_TRANSIENT_FOR,
 104
 105         // special atoms
 106         SAL_QUITEVENT,
 107         SAL_USEREVENT,
 108         SAL_EXTTEXTEVENT,
 109         SAL_GETTIMEEVENT,
 110         VCL_SYSTEM_SETTINGS,
 111         XSETTINGS,
 112         XEMBED,
 113         XEMBED_INFO,
 114         NetAtomMax
 115     };
 116
 117     /*
 118      *  flags for frame decoration
 119      */
 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;
 127
 128 protected:
 129     SalDisplay* const       m_pSalDisplay;      // Display to use
 130     Display*                m_pDisplay;         // X Display of SalDisplay
 131     OUString                m_aWMName;
 132     Atom                    m_aWMAtoms[ NetAtomMax];
 133     int                     m_nDesktops;
 134     bool                    m_bEqualWorkAreas;
 135     ::std::vector< tools::Rectangle >
 136                             m_aWMWorkAreas;
 137     bool                    m_bEnableAlwaysOnTopWorks;
 138     bool                    m_bLegacyPartialFullscreen;
 139     int                     m_nWinGravity;
 140     int                     m_nInitWinGravity;
 141     bool                    m_bWMshouldSwitchWorkspace;
 142     bool                    m_bWMshouldSwitchWorkspaceInit;
 143
 144     WMAdaptor( SalDisplay * )
 145 ;
 146     void initAtoms();
 147     bool getNetWmName();
 148
 149     /*
 150      *  returns whether this instance is useful
 151      *  only useful for createWMAdaptor
 152      */
 153     virtual bool isValid() const;
 154
 155     bool getWMshouldSwitchWorkspace() const;
 156 public:
 157     virtual ~WMAdaptor();
 158
 159     /*
 160      *  creates a valid WMAdaptor instance for the SalDisplay
 161      */
 162     static std::unique_ptr<WMAdaptor> createWMAdaptor( SalDisplay* );
 163
 164     /*
 165      *  may return an empty string if the window manager could
 166      *  not be identified.
 167      */
 168     const OUString& getWindowManagerName() const
 169     { return m_aWMName; }
 170
 171     /*
 172      * gets the current work area/desktop number: [0,m_nDesktops[ or -1 if unknown
 173      */
 174     int getCurrentWorkArea() const;
 175     /*
 176      * gets the workarea the specified window is on (or -1)
 177      */
 178     int getWindowWorkArea( ::Window aWindow ) const;
 179     /*
 180      *  gets the specified workarea
 181      */
 182     const tools::Rectangle& getWorkArea( int n ) const
 183     { return m_aWMWorkAreas[n]; }
 184
 185     /*
 186      * attempt to switch the desktop to a certain workarea (ie. virtual desktops)
 187      */
 188     void switchToWorkArea( int nWorkArea ) const;
 189
 190     /*
 191      *  sets window title
 192      */
 193     virtual void setWMName( X11SalFrame* pFrame, const OUString& rWMName ) const;
 194
 195     /*
 196      * set NET_WM_PID
 197      */
 198     void setPID( X11SalFrame const * pFrame ) const;
 199
 200     /*
 201      * set WM_CLIENT_MACHINE
 202      */
 203     void setClientMachine( X11SalFrame const * pFrame ) const;
 204
 205     void answerPing( X11SalFrame const *, XClientMessageEvent const * ) const;
 206
 207     /*
 208      *  maximizes frame
 209      *  maximization can be toggled in either direction
 210      *  to get the original position and size
 211      *  use maximizeFrame( pFrame, false, false )
 212      */
 213     virtual void maximizeFrame( X11SalFrame* pFrame, bool bHorizontal = true, bool bVertical = true ) const;
 214     /*
 215      *  start/stop fullscreen mode on a frame
 216      */
 217     virtual void showFullScreen( X11SalFrame* pFrame, bool bFullScreen ) const;
 218     /*
 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.
 224      */
 225     bool isLegacyPartialFullscreen() const
 226     { return m_bLegacyPartialFullscreen; }
 227     /*
 228      * set _NET_WM_USER_TIME property, if NetWM
 229      */
 230     virtual void setUserTime( X11SalFrame* i_pFrame, long i_nUserTime ) const;
 231
 232     /*
 233      *  tells whether fullscreen mode is supported by WM
 234      */
 235     bool supportsFullScreen() const { return m_aWMAtoms[ NET_WM_STATE_FULLSCREEN ] != 0; }
 236
 237     /*
 238      *  shade/unshade frame
 239      */
 240     virtual void shade( X11SalFrame* pFrame, bool bToShaded ) const;
 241
 242     /*
 243      *  set hints what decoration is needed;
 244      *  must be called before showing the frame
 245      */
 246     virtual void setFrameTypeAndDecoration( X11SalFrame* pFrame, WMWindowType eType, int nDecorationFlags, X11SalFrame* pTransientFrame ) const;
 247
 248     /*
 249      *  tells whether there is WM support for splash screens
 250      */
 251     bool supportsSplash() const { return m_aWMAtoms[ NET_WM_WINDOW_TYPE_SPLASH ] != 0; }
 252
 253     /*
 254      *  enables always on top or equivalent if possible
 255      */
 256     virtual void enableAlwaysOnTop( X11SalFrame* pFrame, bool bEnable ) const;
 257
 258     /*
 259      *  tells whether enableAlwaysOnTop actually works with this WM
 260      */
 261     bool isAlwaysOnTopOK() const { return m_bEnableAlwaysOnTopWorks; }
 262
 263     /*
 264      *  handle WM messages (especially WM state changes)
 265      */
 266     virtual int handlePropertyNotify( X11SalFrame* pFrame, XPropertyEvent* pEvent ) const;
 267
 268     /*
 269      * called by SalFrame::Show: time to update state properties
 270      */
 271     virtual void frameIsMapping( X11SalFrame* ) const;
 272
 273     /*
 274      *  gets a WM atom
 275      */
 276     Atom getAtom( WMAtom eAtom ) const
 277     { return m_aWMAtoms[ eAtom ]; }
 278
 279     int getPositionWinGravity () const
 280     { return m_nWinGravity; }
 281     int getInitWinGravity() const
 282     { return m_nInitWinGravity; }
 283
 284     /*
 285      *  changes the transient hint of a window to reference frame
 286      *  if reference frame is NULL the root window is used instead
 287      */
 288     void changeReferenceFrame( X11SalFrame* pFrame, X11SalFrame const * pReferenceFrame ) const;
 289
 290     /*
 291      *  Requests the change of active window by sending
 292      *  _NET_ACTIVE_WINDOW message to the frame. The frame
 293      *  has to be mapped
 294      */
 295     void activateWindow( X11SalFrame const *pFrame, Time nTimestamp );
 296 };
 297
 298 } // namespace
 299
 300 #endif
 301
 302 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */