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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SFX_TASKPANE_HXX
#define SFX_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/scoped_ptr.hpp>
#include <boost/optional.hpp>
namespace svt
{
class ToolPanelDeck;
}
//......................................................................................................................
namespace sfx2
{
//......................................................................................................................
//==================================================================================================================
//= ITaskPaneToolPanelAccess
//==================================================================================================================
class SAL_NO_VTABLE ITaskPaneToolPanelAccess
{
public:
virtual void ActivateToolPanel( const ::rtl::OUString& i_rPanelURL ) = 0;
protected:
~ITaskPaneToolPanelAccess() {}
};
//==================================================================================================================
//= TaskPaneWrapper
//==================================================================================================================
class SFX2_DLLPUBLIC TaskPaneWrapper :public SfxChildWindow
,public ITaskPaneToolPanelAccess
{
public:
TaskPaneWrapper(
Window* i_pParent,
sal_uInt16 i_nId,
SfxBindings* i_pBindings,
SfxChildWinInfo* i_pInfo
);
SFX_DECL_CHILDWINDOW( TaskPaneWrapper );
// ITaskPaneToolPanelAccess
virtual void ActivateToolPanel( const ::rtl::OUString& i_rPanelURL );
};
//==================================================================================================================
//= IToolPanelCompare
//==================================================================================================================
class SFX2_DLLPUBLIC SAL_NO_VTABLE IToolPanelCompare
{
public:
/** compares to tool panel URLs
@return
<ul>
<li>-1 if the tool panel described by i_rLHS should precede the one described by i_rRHS</li>
<li>0 if the two panels have no particular relative order</li>
<li>1 if the tool panel described by i_rLHS should succeed the one described by i_rRHS</li>
*/
virtual short compareToolPanelsURLs(
const ::rtl::OUString& i_rLHS,
const ::rtl::OUString& i_rRHS
) const = 0;
protected:
~IToolPanelCompare() {}
};
//==================================================================================================================
//= 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 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(
Window& i_rParentWindow,
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& i_rDocumentFrame
);
/** 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.
@param i_rCompare
a comparator for tool panel URLs, which allows controlling the order in which the panels are
added to the tool panel deck.
*/
ModuleTaskPane(
Window& i_rParentWindow,
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& i_rDocumentFrame,
const IToolPanelCompare& i_rCompare
);
~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 ::rtl::OUString& i_rResourceURL );
/** returns the resource URL of the panel at the specified position
*/
::rtl::OUString
GetPanelResourceURL( const size_t i_nPanelPos ) const;
/// 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();
virtual void GetFocus();
private:
::boost::scoped_ptr< ModuleTaskPane_Impl > m_pImpl;
};
//==================================================================================================================
//= 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 ::rtl::OUString& i_rPanelURL );
private:
::boost::scoped_ptr< TaskPaneController_Impl > m_pImpl;
};
//==================================================================================================================
//= TaskPaneDockingWindow
//==================================================================================================================
class TaskPaneDockingWindow :public TitledDockingWindow
,public ITaskPaneToolPanelAccess
{
public:
TaskPaneDockingWindow( SfxBindings* i_pBindings, TaskPaneWrapper& i_rWrapper,
Window* i_pParent, WinBits i_nBits );
// ITaskPaneToolPanelAccess
virtual void ActivateToolPanel( const ::rtl::OUString& i_rPanelURL );
protected:
// Window overridables
virtual void GetFocus();
// TitledDockingWindow overridables
virtual void onLayoutDone();
private:
ModuleTaskPane m_aTaskPane;
TaskPaneController m_aPaneController;
};
//......................................................................................................................
} // namespace sfx2
//......................................................................................................................
#endif // SFX_TASKPANE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
