LibreOffice Module vcl (master)  1
salframe.hxx
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_SALFRAME_HXX
21 #define INCLUDED_VCL_INC_SALFRAME_HXX
22 
23 #include "impdel.hxx"
24 #include "salwtype.hxx"
25 #include "salgeom.hxx"
26 
27 #include <vcl/help.hxx>
28 #include <o3tl/typed_flags_set.hxx>
29 
30 #include <vcl/window.hxx>
31  // complete vcl::Window for SalFrame::CallCallback under -fsanitize=function
32 
33 class AllSettings;
34 class SalGraphics;
35 class SalBitmap;
36 class SalMenu;
37 
38 struct SalFrameState;
39 struct SalInputContext;
40 struct SystemEnvData;
41 
42 // SalFrame types
43 enum class SalFrameToTop {
44  NONE = 0x00,
45  RestoreWhenMin = 0x01,
46  ForegroundTask = 0x02,
47  GrabFocus = 0x04,
48  GrabFocusOnly = 0x08
49 };
50 namespace o3tl {
51  template<> struct typed_flags<SalFrameToTop> : is_typed_flags<SalFrameToTop, 0x0f> {};
52 };
53 
54 namespace vcl { class KeyCode; }
55 
56 namespace weld
57 {
58  class Window;
59 }
60 
61 enum class FloatWinPopupFlags;
62 
63 // SalFrame styles
65 {
66  NONE = 0x00000000,
67  DEFAULT = 0x00000001,
68  MOVEABLE = 0x00000002,
69  SIZEABLE = 0x00000004,
70  CLOSEABLE = 0x00000008,
71  // no shadow effect on Windows XP
72  NOSHADOW = 0x00000010,
73  // indicate tooltip windows, so they can always be topmost
74  TOOLTIP = 0x00000020,
75  // windows without windowmanager decoration, this typically only applies to floating windows
76  OWNERDRAWDECORATION = 0x00000040,
77  // dialogs
78  DIALOG = 0x00000080,
79  // the window containing the intro bitmap, aka splashscreen
80  INTRO = 0x00000100,
81  // partial fullscreen: fullscreen on one monitor of a multimonitor display
82  PARTIAL_FULLSCREEN = 0x00800000,
83  // tdf#144624: don't set icon
84  NOICON = 0x01000000,
85  // system child window inside another SalFrame
86  SYSTEMCHILD = 0x08000000,
87  // plugged system child window
88  PLUG = 0x10000000,
89  // floating window
90  FLOAT = 0x20000000,
91  // toolwindows should be painted with a smaller decoration
92  TOOLWINDOW = 0x40000000,
93 };
94 
95 namespace o3tl {
96  template<> struct typed_flags<SalFrameStyleFlags> : is_typed_flags<SalFrameStyleFlags, 0x798001ff> {};
97 };
98 
99 // Extended frame style (sal equivalent to extended WinBits)
100 typedef sal_uInt64 SalExtStyle;
101 #define SAL_FRAME_EXT_STYLE_DOCUMENT SalExtStyle(0x00000001)
102 #define SAL_FRAME_EXT_STYLE_DOCMODIFIED SalExtStyle(0x00000002)
103 
104 // Flags for SetPosSize
105 #define SAL_FRAME_POSSIZE_X (sal_uInt16(0x0001))
106 #define SAL_FRAME_POSSIZE_Y (sal_uInt16(0x0002))
107 #define SAL_FRAME_POSSIZE_WIDTH (sal_uInt16(0x0004))
108 #define SAL_FRAME_POSSIZE_HEIGHT (sal_uInt16(0x0008))
109 
110 struct SystemParentData;
111 struct ImplSVEvent;
112 
115  : public vcl::DeletionNotifier
116  , public SalGeometryProvider
117 {
118 private:
119  // the VCL window corresponding to this frame
123 protected:
124  mutable std::unique_ptr<weld::Window> m_xFrameWeld;
125 public:
126  SalFrame();
127  virtual ~SalFrame() override;
128 
129  SalFrameGeometry maGeometry = {};
130 
131  // SalGeometryProvider
132  virtual tools::Long GetWidth() const override { return maGeometry.nWidth; }
133  virtual tools::Long GetHeight() const override { return maGeometry.nHeight; }
134  virtual bool IsOffScreen() const override { return false; }
135 
136  // SalGraphics or NULL, but two Graphics for all SalFrames
137  // must be returned
138  virtual SalGraphics* AcquireGraphics() = 0;
139  virtual void ReleaseGraphics( SalGraphics* pGraphics ) = 0;
140 
141  // Event must be destroyed, when Frame is destroyed
142  // When Event is called, SalInstance::Yield() must be returned
143  virtual bool PostEvent(std::unique_ptr<ImplSVEvent> pData) = 0;
144 
145  virtual void SetTitle( const OUString& rTitle ) = 0;
146  virtual void SetIcon( sal_uInt16 nIcon ) = 0;
147  virtual void SetRepresentedURL( const OUString& );
148  virtual void SetMenu( SalMenu *pSalMenu ) = 0;
149  virtual void DrawMenuBar() = 0;
150 
151  virtual void SetExtendedFrameStyle( SalExtStyle nExtStyle ) = 0;
152 
153  // Before the window is visible, a resize event
154  // must be sent with the correct size
155  virtual void Show( bool bVisible, bool bNoActivate = false ) = 0;
156 
157  // Set ClientSize and Center the Window to the desktop
158  // and send/post a resize message
159  virtual void SetMinClientSize( tools::Long nWidth, tools::Long nHeight ) = 0;
160  virtual void SetMaxClientSize( tools::Long nWidth, tools::Long nHeight ) = 0;
161  virtual void SetPosSize( tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, sal_uInt16 nFlags ) = 0;
162  virtual void GetClientSize( tools::Long& rWidth, tools::Long& rHeight ) = 0;
163  virtual void GetWorkArea( tools::Rectangle& rRect ) = 0;
164  virtual SalFrame* GetParent() const = 0;
165  // Note: x will be mirrored at parent if UI mirroring is active
166  SalFrameGeometry GetGeometry() const;
167  const SalFrameGeometry& GetUnmirroredGeometry() const { return maGeometry; }
168 
169  virtual void SetWindowState( const SalFrameState* pState ) = 0;
170  // return the absolute, unmirrored system frame state
171  // if this returns false the structure is uninitialised
172  [[nodiscard]]
173  virtual bool GetWindowState( SalFrameState* pState ) = 0;
174  virtual void ShowFullScreen( bool bFullScreen, sal_Int32 nDisplay ) = 0;
176 
177  // Enable/Disable ScreenSaver, SystemAgents, ...
178  virtual void StartPresentation( bool bStart ) = 0;
179  // Show Window over all other Windows
180  virtual void SetAlwaysOnTop( bool bOnTop ) = 0;
181 
182  // Window to top and grab focus
183  virtual void ToTop( SalFrameToTop nFlags ) = 0;
184 
185  // grab focus to the main widget, can be no-op if the vclplug only uses one widget
186  virtual void GrabFocus() {}
187 
188  // this function can call with the same
189  // pointer style
190  virtual void SetPointer( PointerStyle ePointerStyle ) = 0;
191  virtual void CaptureMouse( bool bMouse ) = 0;
192  virtual void SetPointerPos( tools::Long nX, tools::Long nY ) = 0;
193 
194  // flush output buffer
195  virtual void Flush() = 0;
196  virtual void Flush( const tools::Rectangle& );
197 
198  virtual void SetInputContext( SalInputContext* pContext ) = 0;
199  virtual void EndExtTextInput( EndExtTextInputFlags nFlags ) = 0;
200 
201  virtual OUString GetKeyName( sal_uInt16 nKeyCode ) = 0;
202 
203  // returns in 'rKeyCode' the single keycode that translates to the given unicode when using a keyboard layout of language 'aLangType'
204  // returns false if no mapping exists or function not supported
205  // this is required for advanced menu support
206  virtual bool MapUnicodeToKeyCode( sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode& rKeyCode ) = 0;
207 
208  // returns the input language used for the last key stroke
209  // may be LANGUAGE_DONTKNOW if not supported by the OS
210  virtual LanguageType GetInputLanguage() = 0;
211 
212  virtual void UpdateSettings( AllSettings& rSettings ) = 0;
213 
214  virtual void Beep() = 0;
215 
216  // returns system data (most prominent: window handle)
217  virtual const SystemEnvData*
218  GetSystemData() const = 0;
219 
220  // tdf#139609 SystemEnvData::GetWindowHandle() calls this to on-demand fill the aWindow
221  // member of SystemEnvData for backends that want to defer doing that
222  virtual void ResolveWindowHandle(SystemEnvData& /*rData*/) const {};
223 
224  // get current modifier, button mask and mouse position
226  {
227  sal_Int32 mnState;
228  Point maPos; // in frame coordinates
229  };
230 
231  virtual SalPointerState GetPointerState() = 0;
232 
233  virtual KeyIndicatorState GetIndicatorState() = 0;
234 
235  virtual void SimulateKeyPress( sal_uInt16 nKeyCode ) = 0;
236 
237  // set new parent window
238  virtual void SetParent( SalFrame* pNewParent ) = 0;
239  // reparent window to act as a plugin; implementation
240  // may choose to use a new system window internally
241  // return false to indicate failure
242  virtual void SetPluginParent( SystemParentData* pNewParent ) = 0;
243 
244  // move the frame to a new screen
245  virtual void SetScreenNumber( unsigned int nScreen ) = 0;
246 
247  virtual void SetApplicationID( const OUString &rApplicationID) = 0;
248 
249  // shaped system windows
250  // set clip region to none (-> rectangular windows, normal state)
251  virtual void ResetClipRegion() = 0;
252  // start setting the clipregion consisting of nRects rectangles
253  virtual void BeginSetClipRegion( sal_uInt32 nRects ) = 0;
254  // add a rectangle to the clip region
255  virtual void UnionClipRegion( tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight ) = 0;
256  // done setting up the clipregion
257  virtual void EndSetClipRegion() = 0;
258 
259  virtual void SetModal(bool /*bModal*/)
260  {
261  }
262 
263  virtual bool GetModal() const
264  {
265  return false;
266  }
267 
268  // return true to indicate tooltips are shown natively, false otherwise
269  virtual bool ShowTooltip(const OUString& /*rHelpText*/, const tools::Rectangle& /*rHelpArea*/)
270  {
271  return false;
272  }
273 
274  // return !0 to indicate popovers are shown natively, 0 otherwise
275  virtual void* ShowPopover(const OUString& /*rHelpText*/, vcl::Window* /*pParent*/, const tools::Rectangle& /*rHelpArea*/, QuickHelpFlags /*nFlags*/)
276  {
277  return nullptr;
278  }
279 
280  // return true to indicate popovers are shown natively, false otherwise
281  virtual bool UpdatePopover(void* /*nId*/, const OUString& /*rHelpText*/, vcl::Window* /*pParent*/, const tools::Rectangle& /*rHelpArea*/)
282  {
283  return false;
284  }
285 
286  // return true to indicate popovers are shown natively, false otherwise
287  virtual bool HidePopover(void* /*nId*/)
288  {
289  return false;
290  }
291 
292  virtual weld::Window* GetFrameWeld() const;
293 
294  // Callbacks (independent part in vcl/source/window/winproc.cxx)
295  // for default message handling return 0
296  void SetCallback( vcl::Window* pWindow, SALFRAMEPROC pProc );
297 
298  // returns the instance set
299  vcl::Window* GetWindow() const { return m_pWindow; }
300 
301  void SetModalHierarchyHdl(const Link<bool, void>& rLink) { m_aModalHierarchyHdl = rLink; }
302  void NotifyModalHierarchy(bool bModal) { m_aModalHierarchyHdl.Call(bModal); }
303 
304  // Call the callback set; this sometimes necessary for implementation classes
305  // that should not know more than necessary about the SalFrame implementation
306  // (e.g. input methods, printer update handlers).
307  bool CallCallback( SalEvent nEvent, const void* pEvent ) const
308  { return m_pProc && m_pProc( m_pWindow, nEvent, pEvent ); }
309 };
310 
311 #ifdef _WIN32
312 bool HasAtHook();
313 #endif
314 
315 #endif // INCLUDED_VCL_INC_SALFRAME_HXX
316 
317 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Interface used to share logic on sizing between SalVirtualDevices and SalFrames.
Definition: salgeom.hxx:63
bool CallCallback(SalEvent nEvent, const void *pEvent) const
Definition: salframe.hxx:307
virtual void ResolveWindowHandle(SystemEnvData &) const
Definition: salframe.hxx:222
Link< bool, void > m_aModalHierarchyHdl
Definition: salframe.hxx:122
long Long
FloatWinPopupFlags
Definition: vclenum.hxx:367
sal_uInt16 sal_Unicode
void NotifyModalHierarchy(bool bModal)
Definition: salframe.hxx:302
sal_uInt64 SalExtStyle
Definition: salframe.hxx:97
SalFrameToTop
Definition: salframe.hxx:43
std::unique_ptr< weld::Window > m_xFrameWeld
Definition: salframe.hxx:124
KeyIndicatorState
Definition: keycodes.hxx:184
QuickHelpFlags
Definition: help.hxx:32
EndExtTextInputFlags
Definition: window.hxx:344
virtual tools::Long GetWidth() const override
Definition: salframe.hxx:132
void SetModalHierarchyHdl(const Link< bool, void > &rLink)
Definition: salframe.hxx:301
const SalFrameGeometry & GetUnmirroredGeometry() const
Definition: salframe.hxx:167
virtual bool IsOffScreen() const override
Definition: salframe.hxx:134
SalEvent
Definition: salwtype.hxx:41
tools::ULong nWidth
Definition: salgeom.hxx:32
VclPtr< vcl::Window > m_pWindow
Definition: salframe.hxx:120
#define VCL_PLUGIN_PUBLIC
Definition: dllapi.h:40
A SalFrame is a system window (e.g. an X11 window).
Definition: salframe.hxx:114
virtual bool UpdatePopover(void *, const OUString &, vcl::Window *, const tools::Rectangle &)
Definition: salframe.hxx:281
virtual void SetModal(bool)
Definition: salframe.hxx:259
virtual bool HidePopover(void *)
Definition: salframe.hxx:287
virtual void GrabFocus()
Definition: salframe.hxx:186
virtual tools::Long GetHeight() const override
Definition: salframe.hxx:133
SalFrameStyleFlags
Definition: salframe.hxx:64
virtual void PositionByToolkit(const tools::Rectangle &, FloatWinPopupFlags)
Definition: salframe.hxx:175
tools::ULong nHeight
Definition: salgeom.hxx:32
PointerStyle
Definition: ptrstyle.hxx:25
virtual bool ShowTooltip(const OUString &, const tools::Rectangle &)
Definition: salframe.hxx:269
SALFRAMEPROC m_pProc
Definition: salframe.hxx:121
virtual void * ShowPopover(const OUString &, vcl::Window *, const tools::Rectangle &, QuickHelpFlags)
Definition: salframe.hxx:275
bool(* SALFRAMEPROC)(vcl::Window *pInst, SalEvent nEvent, const void *pEvent)
Definition: salwtype.hxx:226
weld::Window * GetFrameWeld(const SfxFrame *pFrame)
vcl::Window * GetWindow() const
Definition: salframe.hxx:299
virtual bool GetModal() const
Definition: salframe.hxx:263