1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SFX2_TASKPANE_HXX
#define INCLUDED_SFX2_TASKPANE_HXX
#include <sfx2/dllapi.h>
#include <sfx2/childwin.hxx>
#include <sfx2/titledockwin.hxx>
#include <svtools/toolpanel/tabalignment.hxx>
#include <svtools/toolpanel/tabitemcontent.hxx>
#include <boost/optional.hpp>
namespace svt
{
class ToolPanelDeck;
}
namespace sfx2
{
//= ITaskPaneToolPanelAccess
class SAL_NO_VTABLE ITaskPaneToolPanelAccess
{
public:
virtual void ActivateToolPanel( const OUString& i_rPanelURL ) = 0;
protected:
~ITaskPaneToolPanelAccess() {}
};
//= TaskPaneWrapper
class SFX2_DLLPUBLIC TaskPaneWrapper :public SfxChildWindow
,public ITaskPaneToolPanelAccess
{
public:
TaskPaneWrapper(
vcl::Window* i_pParent,
sal_uInt16 i_nId,
SfxBindings* i_pBindings,
SfxChildWinInfo* i_pInfo
);
SFX_DECL_CHILDWINDOW( TaskPaneWrapper );
// ITaskPaneToolPanelAccess
virtual void ActivateToolPanel( const OUString& i_rPanelURL ) override;
};
//= ModuleTaskPane
class ModuleTaskPane_Impl;
/** SFX-less version of a module dependent task pane, filled with tool panels as specified in the respective
module's configuration
*/
class SFX2_DLLPUBLIC ModuleTaskPane : public vcl::Window
{
public:
/** creates a new instance
@param i_rParentWindow
the parent window
@param i_rDocumentFrame
the frame to which the task pane belongs. Will be passed to any custom tool panels created
via an XUIElementFactory. Also, it is used to determine the module which the task pane is
responsible for, thus controlling which tool panels are actually available.
*/
ModuleTaskPane(
vcl::Window& i_rParentWindow,
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& i_rDocumentFrame
);
virtual ~ModuleTaskPane();
/** determines whether a given module has any registered tool panels
*/
static bool ModuleHasToolPanels( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& i_rDocumentFrame );
/** provides access to the Window aspect of the PanelDeck
Be careful with this method. For instance, you're not allowed to insert arbitrary IToolPanel implementations
into the deck, as the ModuleTaskPane has certain assumptions about the panel implementations. However,
you're allowed to remove and re-insert panels, which have originally been created by the ModuleTaskPane
itself.
*/
::svt::ToolPanelDeck& GetPanelDeck();
const ::svt::ToolPanelDeck& GetPanelDeck() const;
/** returns the position of the panel with the given resource URL
*/
::boost::optional< size_t >
GetPanelPos( const OUString& i_rResourceURL );
/// sets the "classical" layout of the tool panel deck, using drawers
void SetDrawersLayout();
/// sets the new layout of the tool panel deck, using tabs
void SetTabsLayout( const ::svt::TabAlignment i_eTabAlignment, const ::svt::TabItemContent i_eTabContent );
protected:
// Window overridables
virtual void Resize() override;
virtual void GetFocus() override;
private:
std::unique_ptr<ModuleTaskPane_Impl> m_xImpl;
};
//= TaskPaneController
class TaskPaneController_Impl;
/** is a helper class for connecting a ModuleTaskPane and a TitledDockingWindow, for clients of the ModuleTaskPane
which do not use the TaskPaneDockingWindow
The controller will add a drop down menu to the docking window which contains one item for each panel in the
panel deck, and allows toggling their visibility.
*/
class SFX2_DLLPUBLIC TaskPaneController
{
public:
TaskPaneController(
ModuleTaskPane& i_rTaskPane,
TitledDockingWindow& i_rDockingWindow
);
~TaskPaneController();
/// activates the panel with the given URL
void ActivateToolPanel( const OUString& i_rPanelURL );
private:
std::unique_ptr<TaskPaneController_Impl> m_xImpl;
};
//= TaskPaneDockingWindow
class TaskPaneDockingWindow :public TitledDockingWindow
,public ITaskPaneToolPanelAccess
{
public:
TaskPaneDockingWindow( SfxBindings* i_pBindings, TaskPaneWrapper& i_rWrapper,
vcl::Window* i_pParent, WinBits i_nBits );
virtual ~TaskPaneDockingWindow();
virtual void dispose() override;
// ITaskPaneToolPanelAccess
virtual void ActivateToolPanel( const OUString& i_rPanelURL ) override;
protected:
// Window overridables
virtual void GetFocus() override;
// TitledDockingWindow overridables
virtual void onLayoutDone() override;
private:
VclPtr<ModuleTaskPane> m_aTaskPane;
TaskPaneController m_aPaneController;
};
} // namespace sfx2
#endif // INCLUDED_SFX2_TASKPANE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
