LibreOffice Module sdext (master) 1
PresenterPaneContainer.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_SDEXT_SOURCE_PRESENTER_PRESENTERPANECONTAINER_HXX
21#define INCLUDED_SDEXT_SOURCE_PRESENTER_PRESENTERPANECONTAINER_HXX
22
23#include "PresenterPaneBase.hxx"
24#include <com/sun/star/awt/XWindow.hpp>
25#include <com/sun/star/drawing/XPresenterHelper.hpp>
26#include <com/sun/star/drawing/framework/XResourceId.hpp>
27#include <com/sun/star/drawing/framework/XView.hpp>
28#include <com/sun/star/uno/XComponentContext.hpp>
31#include <rtl/ref.hxx>
32
33#include <functional>
34#include <memory>
35#include <vector>
36
37namespace sdext::presenter {
38
39class PresenterPaneBase;
40class PresenterSprite;
41
42typedef ::cppu::WeakComponentImplHelper <
43 css::lang::XEventListener
45
51 : private ::cppu::BaseMutex,
53{
54public:
56 const css::uno::Reference<css::uno::XComponentContext>& rxContext);
57 virtual ~PresenterPaneContainer() override;
60
61 virtual void SAL_CALL disposing() override;
62
63 typedef ::std::function<void (const css::uno::Reference<css::drawing::framework::XView>&)>
65
75 {
76 public:
77 css::uno::Reference<css::drawing::framework::XResourceId> mxPaneId;
78 OUString msViewURL;
80 css::uno::Reference<css::drawing::framework::XView> mxView;
81 css::uno::Reference<css::awt::XWindow> mxContentWindow;
82 css::uno::Reference<css::awt::XWindow> mxBorderWindow;
85 OUString msTitle;
90
91 void SetActivationState (const bool bIsActive);
92 };
93 typedef std::shared_ptr<PaneDescriptor> SharedPaneDescriptor;
94 typedef ::std::vector<SharedPaneDescriptor> PaneList;
96
97 void PreparePane (
98 const css::uno::Reference<css::drawing::framework::XResourceId>& rxPaneId,
99 const OUString& rsViewURL,
100 const OUString& rsTitle,
101 const OUString& rsAccessibleTitle,
102 const bool bIsOpaque,
103 const ViewInitializationFunction& rViewInitialization);
104
107
109 const css::uno::Reference<css::drawing::framework::XResourceId>& rxPaneId,
110 const css::uno::Reference<css::awt::XWindow>& rxBorderWindow);
111
113 const css::uno::Reference<css::drawing::framework::XView>& rxView);
114
116 const css::uno::Reference<css::drawing::framework::XResourceId>& rxPaneId);
117
119 const css::uno::Reference<css::drawing::framework::XView>& rxView);
120
125 const css::uno::Reference<css::awt::XWindow>& rxBorderWindow);
126
131 const css::uno::Reference<css::awt::XWindow>& rxBorderWindow);
132
135 SharedPaneDescriptor FindPaneURL (const OUString& rsPaneURL);
136
139 SharedPaneDescriptor FindPaneId (const css::uno::Reference<
140 css::drawing::framework::XResourceId>& rxPaneId);
141
142 SharedPaneDescriptor FindViewURL (const OUString& rsViewURL);
143
144 OUString GetPaneURLForViewURL (const OUString& rsViewURL);
145
146 void ToTop (const SharedPaneDescriptor& rpDescriptor);
147
148 // XEventListener
149
150 virtual void SAL_CALL disposing (
151 const css::lang::EventObject& rEvent) override;
152
153private:
154 css::uno::Reference<css::drawing::XPresenterHelper> mxPresenterHelper;
155};
156
157} // end of namespace ::sdext::presenter
158
159#endif
160
161/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Each pane descriptor holds references to one pane and the view displayed in this pane as well as the ...
css::uno::Reference< css::awt::XWindow > mxContentWindow
css::uno::Reference< css::drawing::framework::XView > mxView
css::uno::Reference< css::drawing::framework::XResourceId > mxPaneId
This class could also be called PresenterPaneAndViewContainer because it stores not only references t...
SharedPaneDescriptor FindPaneId(const css::uno::Reference< css::drawing::framework::XResourceId > &rxPaneId)
Find the pane whose resource id is identical to the given one.
css::uno::Reference< css::drawing::XPresenterHelper > mxPresenterHelper
SharedPaneDescriptor RemovePane(const css::uno::Reference< css::drawing::framework::XResourceId > &rxPaneId)
SharedPaneDescriptor FindViewURL(const OUString &rsViewURL)
SharedPaneDescriptor StoreBorderWindow(const css::uno::Reference< css::drawing::framework::XResourceId > &rxPaneId, const css::uno::Reference< css::awt::XWindow > &rxBorderWindow)
virtual void SAL_CALL disposing() override
void PreparePane(const css::uno::Reference< css::drawing::framework::XResourceId > &rxPaneId, const OUString &rsViewURL, const OUString &rsTitle, const OUString &rsAccessibleTitle, const bool bIsOpaque, const ViewInitializationFunction &rViewInitialization)
SharedPaneDescriptor RemoveView(const css::uno::Reference< css::drawing::framework::XView > &rxView)
SharedPaneDescriptor StorePane(const rtl::Reference< PresenterPaneBase > &rxPane)
OUString GetPaneURLForViewURL(const OUString &rsViewURL)
::std::vector< SharedPaneDescriptor > PaneList
PresenterPaneContainer & operator=(const PresenterPaneContainer &)=delete
SharedPaneDescriptor FindContentWindow(const css::uno::Reference< css::awt::XWindow > &rxBorderWindow)
Find the pane whose border window is identical to the given content window.
::std::function< void(const css::uno::Reference< css::drawing::framework::XView > &)> ViewInitializationFunction
std::shared_ptr< PaneDescriptor > SharedPaneDescriptor
PresenterPaneContainer(const css::uno::Reference< css::uno::XComponentContext > &rxContext)
SharedPaneDescriptor FindBorderWindow(const css::uno::Reference< css::awt::XWindow > &rxBorderWindow)
Find the pane whose border window is identical to the given border window.
SharedPaneDescriptor FindPaneURL(const OUString &rsPaneURL)
Find the pane whose pane URL is identical to the given URL string.
SharedPaneDescriptor StoreView(const css::uno::Reference< css::drawing::framework::XView > &rxView)
void ToTop(const SharedPaneDescriptor &rpDescriptor)
PresenterPaneContainer(const PresenterPaneContainer &)=delete
::cppu::WeakComponentImplHelper< css::lang::XEventListener > PresenterPaneContainerInterfaceBase