vcl/inc/unx/salframe.h

   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_SALFRAME_H
  21 #define INCLUDED_VCL_INC_UNX_SALFRAME_H
  22
  23 #include <X11/Xlib.h>
  24
  25 #include <unx/saltype.h>
  26 #include <unx/saldisp.hxx>
  27 #include <unx/screensaverinhibitor.hxx>
  28 #include <unx/nativewindowhandleprovider.hxx>
  29 #include <salframe.hxx>
  30 #include <salwtype.hxx>
  31 #include <salinst.hxx>
  32
  33 #include <vcl/ptrstyle.hxx>
  34 #include <vcl/sysdata.hxx>
  35 #include <vcl/timer.hxx>
  36 #include <vclpluginapi.h>
  37
  38 #include <list>
  39
  40 class   X11SalGraphics;
  41 class   SalI18N_InputContext;
  42
  43 namespace vcl_sal { class WMAdaptor; class NetWMAdaptor; class GnomeWMAdaptor; }
  44
  45 // X11SalFrame
  46 #define SHOWSTATE_UNKNOWN       -1
  47 #define SHOWSTATE_MINIMIZED     0
  48 #define SHOWSTATE_NORMAL        1
  49 #define SHOWSTATE_HIDDEN        2
  50
  51 enum class WMWindowType
  52 {
  53     Normal,
  54     ModelessDialogue,
  55     Utility,
  56     Splash,
  57     Toolbar,
  58     Dock
  59 };
  60
  61 class VCLPLUG_GEN_PUBLIC X11SalFrame final : public SalFrame, public NativeWindowHandleProvider
  62 {
  63     friend class vcl_sal::WMAdaptor;
  64     friend class vcl_sal::NetWMAdaptor;
  65     friend class vcl_sal::GnomeWMAdaptor;
  66
  67     X11SalFrame*    mpParent;             // pointer to parent frame
  68                                           // which should never obscure this frame
  69     bool            mbTransientForRoot;
  70     std::list< X11SalFrame* > maChildren; // List of child frames
  71
  72     SalDisplay     *pDisplay_;
  73     SalX11Screen    m_nXScreen;
  74     ::Window        mhWindow;
  75     ::Window        mhShellWindow;
  76     ::Window        mhForeignParent;
  77     // window to fall back to when no longer in fullscreen mode
  78     ::Window        mhStackingWindow;
  79     // window to listen for CirculateNotify events
  80
  81     Cursor          hCursor_;
  82     int             nCaptured_;         // is captured
  83
  84     std::unique_ptr<X11SalGraphics> pGraphics_;            // current frame graphics
  85     std::unique_ptr<X11SalGraphics> pFreeGraphics_;        // first free frame graphics
  86
  87     bool            mbSendExtKeyModChange;
  88     ModKeyFlags     mnExtKeyMod;
  89
  90     int             nShowState_;        // show state
  91     int             nWidth_;            // client width
  92     int             nHeight_;           // client height
  93     tools::Rectangle       maRestorePosSize;
  94     SalFrameStyleFlags nStyle_;
  95     SalExtStyle     mnExtStyle;
  96     bool            bAlwaysOnTop_;
  97     bool            bViewable_;
  98     bool            bMapped_;
  99     bool            bDefaultPosition_;  // client is centered initially
 100     bool            m_bXEmbed;
 101     int             nVisibility_;
 102     int             m_nWorkArea;
 103     bool            m_bSetFocusOnMap;
 104
 105     ScreenSaverInhibitor maScreenSaverInhibitor;
 106     tools::Rectangle       maPaintRegion;
 107
 108     Timer           maAlwaysOnTopRaiseTimer;
 109
 110     // data for WMAdaptor
 111     WMWindowType    meWindowType;
 112     bool            mbMaximizedVert;
 113     bool            mbMaximizedHorz;
 114     bool            mbShaded;
 115     bool            mbFullScreen;
 116
 117     // icon id
 118     int             mnIconID;
 119
 120     OUString        m_aTitle;
 121
 122     OUString        m_sWMClass;
 123
 124     SystemEnvData maSystemChildData;
 125
 126     std::unique_ptr<SalI18N_InputContext> mpInputContext;
 127     Bool            mbInputFocus;
 128
 129     std::vector<XRectangle> m_vClipRectangles;
 130
 131     bool mPendingSizeEvent;
 132
 133     void            GetPosSize( tools::Rectangle &rPosSize );
 134     void            SetSize   ( const Size      &rSize );
 135     void            Center();
 136     void            SetPosSize( const tools::Rectangle &rPosSize );
 137     void            Minimize();
 138     void            Maximize();
 139     void            Restore();
 140
 141     void            RestackChildren( ::Window* pTopLevelWindows, int nTopLevelWindows );
 142     void            RestackChildren();
 143
 144     bool            HandleKeyEvent      ( XKeyEvent         *pEvent );
 145     bool            HandleMouseEvent    ( XEvent            *pEvent );
 146     bool            HandleFocusEvent    ( XFocusChangeEvent const *pEvent );
 147     bool            HandleExposeEvent   ( XEvent const      *pEvent );
 148     bool            HandleSizeEvent     ( XConfigureEvent   *pEvent );
 149     bool            HandleStateEvent    ( XPropertyEvent const *pEvent );
 150     bool            HandleReparentEvent ( XReparentEvent    *pEvent );
 151     bool            HandleClientMessage ( XClientMessageEvent*pEvent );
 152
 153     DECL_LINK( HandleAlwaysOnTopRaise, Timer*, void );
 154
 155     void            createNewWindow( ::Window aParent, SalX11Screen nXScreen = SalX11Screen( -1 ) );
 156     void            updateScreenNumber();
 157
 158     void            setXEmbedInfo();
 159     void            askForXEmbedFocus( sal_Int32 i_nTimeCode );
 160
 161     void            updateWMClass();
 162 public:
 163     X11SalFrame( SalFrame* pParent, SalFrameStyleFlags nSalFrameStyle, SystemParentData const * pSystemParent = nullptr );
 164     virtual ~X11SalFrame() override;
 165
 166     bool            Dispatch( XEvent *pEvent );
 167     void            Init( SalFrameStyleFlags nSalFrameStyle, SalX11Screen nScreen,
 168                           SystemParentData const * pParentData, bool bUseGeometry = false );
 169
 170     SalDisplay* GetDisplay() const
 171     {
 172         return pDisplay_;
 173     }
 174     Display *GetXDisplay() const
 175     {
 176         return pDisplay_->GetDisplay();
 177     }
 178     const SalX11Screen&     GetScreenNumber() const { return m_nXScreen; }
 179     ::Window                GetWindow() const { return mhWindow; }
 180     ::Window                GetShellWindow() const { return mhShellWindow; }
 181     ::Window                GetForeignParent() const { return mhForeignParent; }
 182     ::Window                GetStackingWindow() const { return mhStackingWindow; }
 183     void                    Close() const { CallCallback( SalEvent::Close, nullptr ); }
 184     SalFrameStyleFlags      GetStyle() const { return nStyle_; }
 185
 186     Cursor                  GetCursor() const { return hCursor_; }
 187     bool                    IsCaptured() const { return nCaptured_ == 1; }
 188 #if !defined(__synchronous_extinput__)
 189     void                    HandleExtTextEvent (XClientMessageEvent const *pEvent);
 190 #endif
 191     bool                    IsOverrideRedirect() const;
 192     bool                    IsChildWindow() const { return bool(nStyle_ & (SalFrameStyleFlags::PLUG|SalFrameStyleFlags::SYSTEMCHILD)); }
 193     bool                    IsSysChildWindow() const { return bool(nStyle_ & SalFrameStyleFlags::SYSTEMCHILD); }
 194     bool                    IsFloatGrabWindow() const;
 195     SalI18N_InputContext* getInputContext() const { return mpInputContext.get(); }
 196     bool                    hasFocus() const { return mbInputFocus; }
 197
 198     void                    beginUnicodeSequence();
 199     bool                    appendUnicodeSequence( sal_Unicode );
 200     bool                    endUnicodeSequence();
 201
 202     virtual SalGraphics*        AcquireGraphics() override;
 203     virtual void                ReleaseGraphics( SalGraphics* pGraphics ) override;
 204
 205     // call with true to clear graphics (setting None as drawable)
 206     // call with false to setup graphics with window (GetWindow())
 207     virtual void                updateGraphics( bool bClear );
 208
 209     virtual bool                PostEvent(std::unique_ptr<ImplSVEvent> pData) override;
 210
 211     virtual void                SetTitle( const OUString& rTitle ) override;
 212     virtual void                SetIcon( sal_uInt16 nIcon ) override;
 213     virtual void                SetMenu( SalMenu* pMenu ) override;
 214     virtual void                                DrawMenuBar() override;
 215
 216     virtual void                SetExtendedFrameStyle( SalExtStyle nExtStyle ) override;
 217     virtual void                Show( bool bVisible, bool bNoActivate = false ) override;
 218     virtual void                SetMinClientSize( long nWidth, long nHeight ) override;
 219     virtual void                SetMaxClientSize( long nWidth, long nHeight ) override;
 220     virtual void                SetPosSize( long nX, long nY, long nWidth, long nHeight, sal_uInt16 nFlags ) override;
 221     virtual void                GetClientSize( long& rWidth, long& rHeight ) override;
 222     virtual void                GetWorkArea( tools::Rectangle& rRect ) override;
 223     virtual SalFrame*           GetParent() const override;
 224     virtual void                SetWindowState( const SalFrameState* pState ) override;
 225     virtual bool                GetWindowState( SalFrameState* pState ) override;
 226     virtual void                ShowFullScreen( bool bFullScreen, sal_Int32 nMonitor ) override;
 227     virtual void                StartPresentation( bool bStart ) override;
 228     virtual void                SetAlwaysOnTop( bool bOnTop ) override;
 229     virtual void                ToTop( SalFrameToTop nFlags ) override;
 230     virtual void                SetPointer( PointerStyle ePointerStyle ) override;
 231     virtual void                CaptureMouse( bool bMouse ) override;
 232     virtual void                SetPointerPos( long nX, long nY ) override;
 233     using SalFrame::Flush;
 234     virtual void                Flush() override;
 235     virtual void                SetInputContext( SalInputContext* pContext ) override;
 236     virtual void                EndExtTextInput( EndExtTextInputFlags nFlags ) override;
 237     virtual OUString              GetKeyName( sal_uInt16 nKeyCode ) override;
 238     virtual bool                MapUnicodeToKeyCode( sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode& rKeyCode ) override;
 239     virtual LanguageType        GetInputLanguage() override;
 240     virtual void                UpdateSettings( AllSettings& rSettings ) override;
 241     virtual void                Beep() override;
 242     virtual const SystemEnvData*    GetSystemData() const override;
 243     virtual SalPointerState     GetPointerState() override;
 244     virtual KeyIndicatorState   GetIndicatorState() override;
 245     virtual void                SimulateKeyPress( sal_uInt16 nKeyCode ) override;
 246     virtual void                SetParent( SalFrame* pNewParent ) override;
 247     virtual bool                SetPluginParent( SystemParentData* pNewParent ) override;
 248
 249     virtual void                SetScreenNumber( unsigned int ) override;
 250     virtual void                SetApplicationID( const OUString &rWMClass ) override;
 251
 252     // shaped system windows
 253     // set clip region to none (-> rectangular windows, normal state)
 254     virtual void                    ResetClipRegion() override;
 255     // start setting the clipregion consisting of nRects rectangles
 256     virtual void                    BeginSetClipRegion( sal_uInt32 nRects ) override;
 257     // add a rectangle to the clip region
 258     virtual void                    UnionClipRegion( long nX, long nY, long nWidth, long nHeight ) override;
 259     // done setting up the clipregion
 260     virtual void                    EndSetClipRegion() override;
 261
 262     virtual sal_uIntPtr         GetNativeWindowHandle() override;
 263
 264     /// @internal
 265     void setPendingSizeEvent();
 266 };
 267
 268 #endif // INCLUDED_VCL_INC_UNX_SALFRAME_H
 269
 270 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */