Avoid potential negative array index access to cached text.
[LibreOffice.git] / vcl / inc / headless / svpframe.hxx
blob3789e44745e7ecd49b60e42815977f9b6d8e04bb
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_VCL_INC_HEADLESS_SVPFRAME_HXX
21 #define INCLUDED_VCL_INC_HEADLESS_SVPFRAME_HXX
23 #include <vcl/sysdata.hxx>
25 #include <salframe.hxx>
27 #include <vector>
29 #ifdef IOS
30 #include <quartz/salgdi.h>
31 #define SvpSalInstance AquaSalInstance
32 #define SvpSalGraphics AquaSalGraphics
33 #endif
35 class SvpSalInstance;
36 class SvpSalGraphics;
38 class SvpSalFrame : public SalFrame
40 SvpSalInstance* m_pInstance;
41 SvpSalFrame* m_pParent; // pointer to parent frame
42 std::vector< SvpSalFrame* > m_aChildren; // Vector of child frames
43 SalFrameStyleFlags m_nStyle;
44 bool m_bVisible;
45 #ifndef IOS
46 cairo_surface_t* m_pSurface;
47 #endif
48 tools::Long m_nMinWidth;
49 tools::Long m_nMinHeight;
50 tools::Long m_nMaxWidth;
51 tools::Long m_nMaxHeight;
53 SystemEnvData m_aSystemChildData;
55 std::vector< SvpSalGraphics* > m_aGraphics;
57 static SvpSalFrame* s_pFocusFrame;
58 OUString m_sTitle;
60 public:
61 SvpSalFrame( SvpSalInstance* pInstance,
62 SalFrame* pParent,
63 SalFrameStyleFlags nSalFrameStyle );
64 virtual ~SvpSalFrame() override;
66 void GetFocus();
67 void LoseFocus();
68 void PostPaint() const;
70 const OUString& title() const { return m_sTitle; }
71 SalFrameStyleFlags style() const { return m_nStyle; }
72 bool isVisible() const { return m_bVisible; }
73 bool hasFocus() const { return s_pFocusFrame == this; }
75 // SalFrame
76 virtual SalGraphics* AcquireGraphics() override;
77 virtual void ReleaseGraphics( SalGraphics* pGraphics ) override;
79 virtual bool PostEvent(std::unique_ptr<ImplSVEvent> pData) override;
81 virtual void SetTitle( const OUString& rTitle ) override;
82 virtual void SetIcon( sal_uInt16 nIcon ) override;
83 virtual void SetMenu( SalMenu* pMenu ) override;
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( AbsoluteScreenPixelRectangle& rRect ) override;
92 virtual SalFrame* GetParent() const override;
93 virtual void SetWindowState(const vcl::WindowData*) override;
94 virtual bool GetWindowState(vcl::WindowData*) 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;
122 /*TODO: functional implementation */
123 virtual void SetScreenNumber( unsigned int ) override {}
124 virtual void SetApplicationID(const OUString &) override {}
126 private:
127 basegfx::B2IVector GetSurfaceFrameSize() const;
130 template <typename charT, typename traits>
131 inline std::basic_ostream<charT, traits>& operator<<(std::basic_ostream<charT, traits>& stream,
132 const SvpSalFrame& frame)
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;
143 #endif // INCLUDED_VCL_INC_HEADLESS_SVPFRAME_HXX
145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */