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