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
39class X11SalGraphics;
41
42namespace vcl_sal { class WMAdaptor; class NetWMAdaptor; class GnomeWMAdaptor; }
43
44// X11SalFrame
45enum class X11ShowState
46{
47 Unknown = -1,
48 Minimized = 0,
49 Normal = 1,
50 Hidden = 2
51};
52
53enum class WMWindowType
54{
55 Normal,
57 Utility,
58 Splash,
59 Toolbar,
60 Dock
61};
62
63class X11SalFrame final : public SalFrame
64{
65 friend class vcl_sal::WMAdaptor;
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;
79 // window to fall back to when no longer in fullscreen mode
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
93 int nWidth_; // client width
94 int nHeight_; // client height
101 bool bDefaultPosition_; // client is centered initially
106
109
111
112 // data for WMAdaptor
118
119 // icon id
121
122 OUString m_aTitle;
123
124 OUString m_sWMClass;
125
127
128 std::unique_ptr<SalI18N_InputContext> mpInputContext;
130
131 std::vector<XRectangle> m_vClipRectangles;
132
134
135 void GetPosSize( tools::Rectangle &rPosSize );
136 void SetSize ( const Size &rSize );
137 void Center();
138 void SetPosSize( const tools::Rectangle &rPosSize );
139 void Minimize();
140 void Maximize();
141 void Restore();
142
143 void RestackChildren( ::Window* pTopLevelWindows, int nTopLevelWindows );
145
146 bool HandleKeyEvent ( XKeyEvent *pEvent );
147 bool HandleMouseEvent ( XEvent *pEvent );
148 bool HandleFocusEvent ( XFocusChangeEvent const *pEvent );
149 bool HandleExposeEvent ( XEvent const *pEvent );
150 bool HandleSizeEvent ( XConfigureEvent *pEvent );
151 bool HandleStateEvent ( XPropertyEvent const *pEvent );
152 bool HandleReparentEvent ( XReparentEvent *pEvent );
153 bool HandleClientMessage ( XClientMessageEvent*pEvent );
154
155 DECL_LINK( HandleAlwaysOnTopRaise, Timer*, void );
156
157 void createNewWindow( ::Window aParent, SalX11Screen nXScreen = SalX11Screen( -1 ) );
159
161 void askForXEmbedFocus( sal_Int32 i_nTimeCode );
162
164public:
165 X11SalFrame( SalFrame* pParent, SalFrameStyleFlags nSalFrameStyle, SystemParentData const * pSystemParent = nullptr );
166 virtual ~X11SalFrame() override;
167
168 bool Dispatch( XEvent *pEvent );
169 void Init( SalFrameStyleFlags nSalFrameStyle, SalX11Screen nScreen,
170 SystemParentData const * pParentData, bool bUseGeometry = false );
171
173 {
174 return pDisplay_;
175 }
177 {
178 return pDisplay_->GetDisplay();
179 }
180 const SalX11Screen& GetScreenNumber() const { return m_nXScreen; }
181 ::Window GetWindow() const { return mhWindow; }
182 ::Window GetShellWindow() const { return mhShellWindow; }
183 ::Window GetForeignParent() const { return mhForeignParent; }
184 ::Window GetStackingWindow() const { return mhStackingWindow; }
185 void Close() const { CallCallback( SalEvent::Close, nullptr ); }
187
188 Cursor GetCursor() const { return hCursor_; }
189 bool IsCaptured() const { return nCaptured_ == 1; }
190#if !defined(__synchronous_extinput__)
191 void HandleExtTextEvent (XClientMessageEvent const *pEvent);
192#endif
193 bool IsOverrideRedirect() const;
196 bool IsFloatGrabWindow() const;
198 bool hasFocus() const { return mbInputFocus; }
199
203
204 virtual SalGraphics* AcquireGraphics() override;
205 virtual void ReleaseGraphics( SalGraphics* pGraphics ) override;
206
207 // call with true to clear graphics (setting None as drawable)
208 // call with false to setup graphics with window (GetWindow())
209 virtual void updateGraphics( bool bClear );
210
211 virtual bool PostEvent(std::unique_ptr<ImplSVEvent> pData) override;
212
213 virtual void SetTitle( const OUString& rTitle ) override;
214 virtual void SetIcon( sal_uInt16 nIcon ) override;
215 virtual void SetMenu( SalMenu* pMenu ) 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 vcl::WindowData*) override;
226 virtual bool GetWindowState(vcl::WindowData*) 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;
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
265};
266
267#endif // INCLUDED_VCL_INC_UNX_SALFRAME_H
268
269/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Display * GetDisplay() const
Definition: saldisp.hxx:359
A SalFrame is a system window (e.g. an X11 window).
Definition: salframe.hxx:115
virtual void Flush()=0
bool CallCallback(SalEvent nEvent, const void *pEvent) const
Definition: salframe.hxx:305
Definition: timer.hxx:27
std::unique_ptr< X11SalGraphics > pFreeGraphics_
Definition: unx/salframe.h:87
WMWindowType meWindowType
Definition: unx/salframe.h:113
virtual void SimulateKeyPress(sal_uInt16 nKeyCode) override
OUString m_aTitle
Definition: unx/salframe.h:122
virtual void SetMinClientSize(tools::Long nWidth, tools::Long nHeight) override
virtual void StartPresentation(bool bStart) override
::Window GetForeignParent() const
Definition: unx/salframe.h:183
void Init(SalFrameStyleFlags nSalFrameStyle, SalX11Screen nScreen, SystemParentData const *pParentData, bool bUseGeometry=false)
Display * GetXDisplay() const
Definition: unx/salframe.h:176
void RestackChildren(::Window *pTopLevelWindows, int nTopLevelWindows)
ModKeyFlags mnExtKeyMod
Definition: unx/salframe.h:90
bool bViewable_
Definition: unx/salframe.h:99
virtual void EndSetClipRegion() override
std::vector< XRectangle > m_vClipRectangles
Definition: unx/salframe.h:131
virtual void updateGraphics(bool bClear)
virtual void ResetClipRegion() override
virtual void ToTop(SalFrameToTop nFlags) override
virtual void SetExtendedFrameStyle(SalExtStyle nExtStyle) override
::Window mhWindow
Definition: unx/salframe.h:76
bool HandleSizeEvent(XConfigureEvent *pEvent)
bool HandleReparentEvent(XReparentEvent *pEvent)
X11SalFrame * mpParent
Definition: unx/salframe.h:69
virtual void SetPointer(PointerStyle ePointerStyle) override
X11SalFrame(SalFrame *pParent, SalFrameStyleFlags nSalFrameStyle, SystemParentData const *pSystemParent=nullptr)
virtual const SystemEnvData * GetSystemData() const override
DECL_LINK(HandleAlwaysOnTopRaise, Timer *, void)
bool IsSysChildWindow() const
Definition: unx/salframe.h:195
virtual void SetPointerPos(tools::Long nX, tools::Long nY) override
void updateWMClass()
std::list< X11SalFrame * > maChildren
Definition: unx/salframe.h:72
SalExtStyle mnExtStyle
Definition: unx/salframe.h:97
void updateScreenNumber()
void Maximize()
tools::Rectangle maRestorePosSize
Definition: unx/salframe.h:95
::Window GetStackingWindow() const
Definition: unx/salframe.h:184
bool HandleStateEvent(XPropertyEvent const *pEvent)
virtual void CaptureMouse(bool bMouse) override
bool mbTransientForRoot
Definition: unx/salframe.h:71
virtual void SetTitle(const OUString &rTitle) override
bool appendUnicodeSequence(sal_Unicode)
bool bDefaultPosition_
Definition: unx/salframe.h:101
::Window mhStackingWindow
Definition: unx/salframe.h:80
bool HandleFocusEvent(XFocusChangeEvent const *pEvent)
void beginUnicodeSequence()
SalX11Screen m_nXScreen
Definition: unx/salframe.h:75
bool mbSendExtKeyModChange
Definition: unx/salframe.h:89
virtual void SetParent(SalFrame *pNewParent) override
bool HandleMouseEvent(XEvent *pEvent)
virtual void SetAlwaysOnTop(bool bOnTop) override
Cursor hCursor_
Definition: unx/salframe.h:83
SystemEnvData maSystemChildData
Definition: unx/salframe.h:126
void Restore()
bool m_bIsPartialFullScreen
Definition: unx/salframe.h:117
virtual void GetClientSize(tools::Long &rWidth, tools::Long &rHeight) override
::Window mhForeignParent
Definition: unx/salframe.h:78
SalDisplay * GetDisplay() const
Definition: unx/salframe.h:172
bool Dispatch(XEvent *pEvent)
bool IsFloatGrabWindow() const
ScreenSaverInhibitor maScreenSaverInhibitor
Definition: unx/salframe.h:107
virtual bool MapUnicodeToKeyCode(sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode &rKeyCode) override
bool HandleKeyEvent(XKeyEvent *pEvent)
::Window GetShellWindow() const
Definition: unx/salframe.h:182
virtual void SetPosSize(tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, sal_uInt16 nFlags) override
bool bAlwaysOnTop_
Definition: unx/salframe.h:98
Cursor GetCursor() const
Definition: unx/salframe.h:188
void setXEmbedInfo()
bool HandleExposeEvent(XEvent const *pEvent)
virtual SalPointerState GetPointerState() override
SalI18N_InputContext * getInputContext() const
Definition: unx/salframe.h:197
bool mbMaximizedVert
Definition: unx/salframe.h:114
void Center()
void SetSize(const Size &rSize)
virtual void SetPluginParent(SystemParentData *pNewParent) override
std::unique_ptr< X11SalGraphics > pGraphics_
Definition: unx/salframe.h:86
OUString m_sWMClass
Definition: unx/salframe.h:124
virtual ~X11SalFrame() override
void askForXEmbedFocus(sal_Int32 i_nTimeCode)
virtual void SetMenu(SalMenu *pMenu) override
virtual void UpdateSettings(AllSettings &rSettings) override
virtual SalGraphics * AcquireGraphics() override
::Window GetWindow() const
Definition: unx/salframe.h:181
Timer maAlwaysOnTopRaiseTimer
Definition: unx/salframe.h:110
SalFrameStyleFlags nStyle_
Definition: unx/salframe.h:96
bool IsCaptured() const
Definition: unx/salframe.h:189
friend class vcl_sal::GnomeWMAdaptor
Definition: unx/salframe.h:67
::Window mhShellWindow
Definition: unx/salframe.h:77
virtual KeyIndicatorState GetIndicatorState() override
virtual void ShowFullScreen(bool bFullScreen, sal_Int32 nMonitor) override
bool mbFullScreen
Definition: unx/salframe.h:116
SalFrameStyleFlags GetStyle() const
Definition: unx/salframe.h:186
void GetPosSize(tools::Rectangle &rPosSize)
void Minimize()
virtual void SetApplicationID(const OUString &rWMClass) override
tools::Rectangle maPaintRegion
Definition: unx/salframe.h:108
virtual void ReleaseGraphics(SalGraphics *pGraphics) override
void setPendingSizeEvent()
virtual void SetIcon(sal_uInt16 nIcon) override
void createNewWindow(::Window aParent, SalX11Screen nXScreen=SalX11Screen(-1))
bool hasFocus() const
Definition: unx/salframe.h:198
void Close() const
Definition: unx/salframe.h:185
bool HandleClientMessage(XClientMessageEvent *pEvent)
bool endUnicodeSequence()
void RestackChildren()
virtual void Beep() override
bool IsChildWindow() const
Definition: unx/salframe.h:194
X11ShowState nShowState_
Definition: unx/salframe.h:92
void SetPosSize(const tools::Rectangle &rPosSize)
Bool mbInputFocus
Definition: unx/salframe.h:129
virtual void SetInputContext(SalInputContext *pContext) override
bool IsOverrideRedirect() const
friend class vcl_sal::NetWMAdaptor
Definition: unx/salframe.h:66
virtual void BeginSetClipRegion(sal_uInt32 nRects) override
virtual void Flush() override
virtual LanguageType GetInputLanguage() override
virtual void GetWorkArea(tools::Rectangle &rRect) override
virtual void SetWindowState(const vcl::WindowData *) override
const SalX11Screen & GetScreenNumber() const
Definition: unx/salframe.h:180
std::unique_ptr< SalI18N_InputContext > mpInputContext
Definition: unx/salframe.h:128
virtual void SetMaxClientSize(tools::Long nWidth, tools::Long nHeight) override
virtual void SetScreenNumber(unsigned int) override
SalDisplay * pDisplay_
Definition: unx/salframe.h:74
virtual bool GetWindowState(vcl::WindowData *) override
virtual SalFrame * GetParent() const override
virtual void EndExtTextInput(EndExtTextInputFlags nFlags) override
virtual OUString GetKeyName(sal_uInt16 nKeyCode) override
virtual void UnionClipRegion(tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight) override
bool m_bSetFocusOnMap
Definition: unx/salframe.h:105
virtual bool PostEvent(std::unique_ptr< ImplSVEvent > pData) override
bool mbMaximizedHorz
Definition: unx/salframe.h:115
virtual void Show(bool bVisible, bool bNoActivate=false) override
void HandleExtTextEvent(XClientMessageEvent const *pEvent)
bool mPendingSizeEvent
Definition: unx/salframe.h:133
KeyIndicatorState
Definition: keycodes.hxx:186
ModKeyFlags
Definition: keycodes.hxx:165
Unknown
Display
long Long
PointerStyle
Definition: ptrstyle.hxx:26
sal_uInt64 SalExtStyle
Definition: salframe.hxx:95
SalFrameToTop
Definition: salframe.hxx:43
SalFrameStyleFlags
Definition: salframe.hxx:65
sal_uInt16 sal_Unicode
X11ShowState
Definition: unx/salframe.h:46
WMWindowType
Definition: unx/salframe.h:54
EndExtTextInputFlags
Definition: window.hxx:346