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