LibreOffice Module vcl (master)  1
svpframe.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_HEADLESS_SVPFRAME_HXX
21 #define INCLUDED_VCL_INC_HEADLESS_SVPFRAME_HXX
22 
23 #include <vcl/sysdata.hxx>
24 
25 #include <salframe.hxx>
26 
27 #include <vector>
28 
29 #ifdef IOS
30 #define SvpSalInstance AquaSalInstance
31 #define SvpSalGraphics AquaSalGraphics
32 #endif
33 
34 class SvpSalInstance;
35 class SvpSalGraphics;
36 
37 class SvpSalFrame : public SalFrame
38 {
40  SvpSalFrame* m_pParent; // pointer to parent frame
41  std::vector< SvpSalFrame* > m_aChildren; // Vector of child frames
43  bool m_bVisible;
44 #ifndef IOS
46 #endif
51 
53 
54  std::vector< SvpSalGraphics* > m_aGraphics;
55 
57  OUString m_sTitle;
58 
59 public:
60  SvpSalFrame( SvpSalInstance* pInstance,
61  SalFrame* pParent,
62  SalFrameStyleFlags nSalFrameStyle );
63  virtual ~SvpSalFrame() override;
64 
65  void GetFocus();
66  void LoseFocus();
67  void PostPaint() const;
68 
69  const OUString& title() const { return m_sTitle; }
70  SalFrameStyleFlags style() const { return m_nStyle; }
71  bool isVisible() const { return m_bVisible; }
72  bool hasFocus() const { return s_pFocusFrame == this; }
73 
74  // SalFrame
75  virtual SalGraphics* AcquireGraphics() override;
76  virtual void ReleaseGraphics( SalGraphics* pGraphics ) override;
77 
78  virtual bool PostEvent(std::unique_ptr<ImplSVEvent> pData) override;
79 
80  virtual void SetTitle( const OUString& rTitle ) override;
81  virtual void SetIcon( sal_uInt16 nIcon ) override;
82  virtual void SetMenu( SalMenu* pMenu ) override;
83  virtual void DrawMenuBar() override;
84 
85  virtual void SetExtendedFrameStyle( SalExtStyle nExtStyle ) override;
86  virtual void Show( bool bVisible, bool bNoActivate = false ) override;
87  virtual void SetMinClientSize( tools::Long nWidth, tools::Long nHeight ) override;
88  virtual void SetMaxClientSize( tools::Long nWidth, tools::Long nHeight ) override;
89  virtual void SetPosSize( tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, sal_uInt16 nFlags ) override;
90  virtual void GetClientSize( tools::Long& rWidth, tools::Long& rHeight ) override;
91  virtual void GetWorkArea( tools::Rectangle& rRect ) override;
92  virtual SalFrame* GetParent() const override;
93  virtual void SetWindowState( const SalFrameState* pState ) override;
94  virtual bool GetWindowState( SalFrameState* pState ) override;
95  virtual void ShowFullScreen( bool bFullScreen, sal_Int32 nDisplay ) override;
96  virtual void StartPresentation( bool bStart ) override;
97  virtual void SetAlwaysOnTop( bool bOnTop ) override;
98  virtual void ToTop( SalFrameToTop nFlags ) override;
99  virtual void SetPointer( PointerStyle ePointerStyle ) override;
100  virtual void CaptureMouse( bool bMouse ) override;
101  virtual void SetPointerPos( tools::Long nX, tools::Long nY ) override;
102  using SalFrame::Flush;
103  virtual void Flush() override;
104  virtual void SetInputContext( SalInputContext* pContext ) override;
105  virtual void EndExtTextInput( EndExtTextInputFlags nFlags ) override;
106  virtual OUString GetKeyName( sal_uInt16 nKeyCode ) override;
107  virtual bool MapUnicodeToKeyCode( sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode& rKeyCode ) override;
108  virtual LanguageType GetInputLanguage() override;
109  virtual void UpdateSettings( AllSettings& rSettings ) override;
110  virtual void Beep() override;
111  virtual const SystemEnvData* GetSystemData() const override;
112  virtual SalPointerState GetPointerState() override;
113  virtual KeyIndicatorState GetIndicatorState() override;
114  virtual void SimulateKeyPress( sal_uInt16 nKeyCode ) override;
115  virtual void SetParent( SalFrame* pNewParent ) override;
116  virtual void SetPluginParent( SystemParentData* pNewParent ) override;
117  virtual void ResetClipRegion() override;
118  virtual void BeginSetClipRegion( sal_uInt32 nRects ) override;
119  virtual void UnionClipRegion( tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight ) override;
120  virtual void EndSetClipRegion() override;
121 
122  /*TODO: functional implementation */
123  virtual void SetScreenNumber( unsigned int ) override {}
124  virtual void SetApplicationID(const OUString &) override {}
125 
126 private:
128 };
129 
130 template <typename charT, typename traits>
131 inline std::basic_ostream<charT, traits>& operator<<(std::basic_ostream<charT, traits>& stream,
132  const SvpSalFrame& frame)
133 {
134  stream << &frame << " (vis " << frame.isVisible() << " focus " << frame.hasFocus();
135  stream << " style " << std::hex << std::setfill('0') << std::setw(8) << static_cast<sal_uInt32>(frame.style());
136  OUString sTitle = frame.title();
137  if (!sTitle.isEmpty())
138  stream << " '" << sTitle << "'";
139  stream << ")";
140  return stream;
141 }
142 
143 #endif // INCLUDED_VCL_INC_HEADLESS_SVPFRAME_HXX
144 
145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual void SetIcon(sal_uInt16 nIcon) override
void GetFocus()
virtual OUString GetKeyName(sal_uInt16 nKeyCode) override
SvpSalFrame(SvpSalInstance *pInstance, SalFrame *pParent, SalFrameStyleFlags nSalFrameStyle)
virtual void Flush() override
virtual bool MapUnicodeToKeyCode(sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode &rKeyCode) override
virtual void EndSetClipRegion() override
virtual LanguageType GetInputLanguage() override
long Long
virtual void SetExtendedFrameStyle(SalExtStyle nExtStyle) override
std::vector< SvpSalGraphics * > m_aGraphics
Definition: svpframe.hxx:54
virtual SalPointerState GetPointerState() override
SalFrameStyleFlags m_nStyle
Definition: svpframe.hxx:42
virtual void UpdateSettings(AllSettings &rSettings) override
virtual void SetMinClientSize(tools::Long nWidth, tools::Long nHeight) override
basegfx::B2IVector GetSurfaceFrameSize() const
virtual void ResetClipRegion() override
virtual void GetClientSize(tools::Long &rWidth, tools::Long &rHeight) override
SvpSalFrame * m_pParent
Definition: svpframe.hxx:40
SvpSalInstance * m_pInstance
Definition: svpframe.hxx:39
SalFrameStyleFlags style() const
Definition: svpframe.hxx:70
virtual const SystemEnvData * GetSystemData() const override
virtual KeyIndicatorState GetIndicatorState() override
virtual void SetApplicationID(const OUString &) override
Definition: svpframe.hxx:124
SystemEnvData m_aSystemChildData
Definition: svpframe.hxx:52
sal_uInt16 sal_Unicode
virtual void SetTitle(const OUString &rTitle) override
virtual void ToTop(SalFrameToTop nFlags) override
exports com.sun.star. frame
sal_uInt64 SalExtStyle
Definition: salframe.hxx:97
virtual void SetPluginParent(SystemParentData *pNewParent) override
tools::Long m_nMinWidth
Definition: svpframe.hxx:47
virtual void BeginSetClipRegion(sal_uInt32 nRects) override
virtual bool GetWindowState(SalFrameState *pState) override
virtual void SetScreenNumber(unsigned int) override
Definition: svpframe.hxx:123
virtual void Show(bool bVisible, bool bNoActivate=false) override
virtual void SetAlwaysOnTop(bool bOnTop) override
SalFrameToTop
Definition: salframe.hxx:43
virtual void GetWorkArea(tools::Rectangle &rRect) override
virtual void ShowFullScreen(bool bFullScreen, sal_Int32 nDisplay) override
virtual void EndExtTextInput(EndExtTextInputFlags nFlags) override
virtual void SetPosSize(tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, sal_uInt16 nFlags) override
virtual void CaptureMouse(bool bMouse) override
virtual ~SvpSalFrame() override
virtual void UnionClipRegion(tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight) override
bool hasFocus() const
Definition: svpframe.hxx:72
virtual void SetPointerPos(tools::Long nX, tools::Long nY) override
const OUString & title() const
Definition: svpframe.hxx:69
KeyIndicatorState
Definition: keycodes.hxx:184
OUString m_sTitle
Definition: svpframe.hxx:57
tools::Long m_nMaxHeight
Definition: svpframe.hxx:50
EndExtTextInputFlags
Definition: window.hxx:344
virtual void StartPresentation(bool bStart) override
virtual void Flush()=0
bool isVisible() const
Definition: svpframe.hxx:71
virtual void SetMenu(SalMenu *pMenu) override
virtual void DrawMenuBar() override
Reference< XOutputStream > stream
void PostPaint() const
virtual void SimulateKeyPress(sal_uInt16 nKeyCode) override
A SalFrame is a system window (e.g. an X11 window).
Definition: salframe.hxx:114
virtual void SetPointer(PointerStyle ePointerStyle) override
tools::Long m_nMinHeight
Definition: svpframe.hxx:48
virtual bool PostEvent(std::unique_ptr< ImplSVEvent > pData) override
std::vector< SvpSalFrame * > m_aChildren
Definition: svpframe.hxx:41
static SvpSalFrame * s_pFocusFrame
Definition: svpframe.hxx:56
SalFrameStyleFlags
Definition: salframe.hxx:64
virtual SalFrame * GetParent() const override
void LoseFocus()
PointerStyle
Definition: ptrstyle.hxx:25
virtual void Beep() override
cairo_surface_t * m_pSurface
Definition: svpframe.hxx:45
bool m_bVisible
Definition: svpframe.hxx:43
tools::Long m_nMaxWidth
Definition: svpframe.hxx:49
virtual SalGraphics * AcquireGraphics() override
virtual void SetParent(SalFrame *pNewParent) override
virtual void SetMaxClientSize(tools::Long nWidth, tools::Long nHeight) override
virtual void ReleaseGraphics(SalGraphics *pGraphics) override
virtual void SetWindowState(const SalFrameState *pState) override
virtual void SetInputContext(SalInputContext *pContext) override
struct _cairo_surface cairo_surface_t
Definition: CairoCommon.hxx:72