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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/* -*- 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_SD_SOURCE_UI_INC_TOOLBARMANAGER_HXX
#define INCLUDED_SD_SOURCE_UI_INC_TOOLBARMANAGER_HXX
#include "ShellFactory.hxx"
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <memory>
class SdrView;
namespace sd { class ViewShell; }
namespace sd::tools { class EventMultiplexer; }
namespace sd {
class ViewShellBase;
class ViewShellManager;
/** Manage the set of visible tool bars (and object bars). Usually they
belong to the current view in the center pane.
Tool bars are managed in groups. Each group can be set, reset, or
modified independently of the others. This allows for instance to
replace the toolbars associated with the current function independently
from those associated with the main view.
The ToolBarManager has two high level methods which contain the
knowledge about which tool bars to show in a specific context.
When the view in the center pane changes then MainViewShellChanged()
sets up the tool bars for the new view. On changes of the selection the
SelectionHasChanged() method shows the tool bars for the new context.
The update of the actually visible tool bars to the set currently
required by the main view shell and its functions is divided into two
parts, PreUpdate() and PostUpdate(). This are to be called before
respectively after the update of the view shell stack. The reason for
this is to save time by not updating tool bars that will not be visible
in a short time on a view shell switch.
*/
class ToolBarManager
: public std::enable_shared_from_this<ToolBarManager>
{
public:
/** Use this method instead of the constructor to create new objects of
this class.
*/
static std::shared_ptr<ToolBarManager> Create (
ViewShellBase& rBase,
const std::shared_ptr<tools::EventMultiplexer>& rpMultiplexer,
const std::shared_ptr<ViewShellManager>& rpViewShellManager);
~ToolBarManager();
/** Call this method prior to the destructor to prevent the
ToolBarManager from accessing the ViewShellManager or the
XLayoutManager when those are possibly not well and alive anymore
(like during the destruction of the ViewShellBase.)
*/
void Shutdown();
/** When the view in the center pane changes then this method sets up
the initial set of tool bars for the new view.
The ToolBarManager listens for view switching itself and then calls
MainViewShellChanged(). Calling this method from the outside should
not be necessary.
@param nShellType
The type of the new main view shell.
*/
void MainViewShellChanged ();
void MainViewShellChanged (const ViewShell& rMainViewShell);
/** Call this method when the selection has changed to update the more
temporary tool bars (those in the ToolBarGroup::Function group.)
*/
void SelectionHasChanged (
const ViewShell& rViewShell,
const SdrView& rView);
/** The set of tool bars that are handled by this manager class.
*/
const static OUString msToolBar; // Draw_Toolbox_Sd, 23011
const static OUString msOptionsToolBar; // Draw_Options_Toolbox, 23020
const static OUString msCommonTaskToolBar; // Draw_CommonTask_Toolbox, 23021
const static OUString msViewerToolBar; // Draw_Viewer_Toolbox, 23023
const static OUString msSlideSorterToolBar; // Slide_Toolbox, 23012
const static OUString msSlideSorterObjectBar; // Slide_Obj_Toolbox, 23014
const static OUString msOutlineToolBar; // Outline_Toolbox, 23017
const static OUString msMasterViewToolBar; // SID_MASTERPAGE, 27053
const static OUString msDrawingObjectToolBar; // Draw_Obj_Toolbox, 23013
const static OUString msGluePointsToolBar; // Gluepoints_Toolbox, 23019
const static OUString msTextObjectBar; // Draw_Text_Toolbox_Sd, 23016
const static OUString msBezierObjectBar; // Bezier_Toolbox_Sd, 23015
const static OUString msGraphicObjectBar; // Draw_Graf_Toolbox, 23030
const static OUString msMediaObjectBar; // Draw_Media_Toolbox, 23031
const static OUString msTableObjectBar; // Draw_Table_Toolbox, 23018
/** The set of tool bar groups.
*/
enum class ToolBarGroup {
Permanent,
Function,
CommonTask,
MasterMode,
LAST = MasterMode
};
/** Reset the set of visible object bars in the specified group. Tool
bars in other groups are not affected.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
@param eGroup
Only the tool bars in this group are rest.
*/
void ResetToolBars (ToolBarGroup eGroup);
/** Reset all tool bars, regardless of the group they belong to.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
*/
void ResetAllToolBars();
/** Add the tool bar with the given name to the specified group of tool
bars.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
@param eGroup
The new tool bar is added to this group.
@param rsToolBarName
The base name of the tool bar. A proper prefix (like
private:resource/toolbar/) is added. The name may be one of the
ones defined above. Other names are allowed as well.
*/
void AddToolBar (
ToolBarGroup eGroup,
const OUString& rsToolBarName);
/** Add the tool bar shell to the shell stack. This method basically
forwards the call to the ViewShellManager.
For some tool bar shells additional tool bars are made visible.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
@param eGroup
The group is used for the actual tool bars.
@param nToolBarId
Id of the tool bar shell.
*/
void AddToolBarShell (
ToolBarGroup eGroup,
ShellId nToolBarId);
/** Remove the tool bar with the given name from the specified group.
If the tool bar is not visible then nothing happens.
If the tool bar is a member of another group then nothing happens
either.
*/
void RemoveToolBar (
ToolBarGroup eGroup,
const OUString& rsToolBarName);
/** This is basically a shortcut for ResetToolBars(),AddToolBar(). The
main difference is, that all sub shells of the specified parent
shell are deactivated as well.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
@param eGroup
The new tool bar is added to this group.
@param rsToolBarName
The base name of the tool bar. A proper prefix (like
private:resource/toolbar/) is added. The name may be one of the
ones defined above. Other names are allowed as well.
*/
void SetToolBar (
ToolBarGroup eGroup,
const OUString& rsToolBarName);
/** This is basically a shortcut for ResetToolBars(),AddToolBar(). The
main difference is, that all sub shells of the specified parent
shell are deactivated as well.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
@param rParentShell
When this shell is not the main view then the method returns
immediately.
@param eGroup
The group is currently not used.
@param nToolBarId
Id of the tool bar shell.
*/
void SetToolBarShell (
ToolBarGroup eGroup,
ShellId nToolBarId);
void PreUpdate();
/** Request an update of the active tool bars. The update is made
asynchronously.
*/
void RequestUpdate();
/** This is a hint for the ToolBarManager to improve the performance
when it updates its tool bars when its own lock is released. Taking
control of the release of the update lock of the ViewShellManager
avoids some shell stack modifications and tool bar updates.
*/
void LockViewShellManager();
/** Use this class to prevent the visible tool bars from being updated
(and thus causing repaints and GUI rearrangements) when several tool
bar operations are made in a row.
*/
class UpdateLock { public:
UpdateLock(const std::shared_ptr<ToolBarManager>& rpManager)
: mpManager(rpManager) { mpManager->LockUpdate(); }
~UpdateLock() COVERITY_NOEXCEPT_FALSE { mpManager->UnlockUpdate(); }
private:
std::shared_ptr<ToolBarManager> mpManager;
};
friend class UpdateLock;
void ToolBarsDestroyed();
private:
class Implementation;
std::unique_ptr<Implementation> mpImpl;
/** The ViewShellBase is used to get the XLayoutManager and to determine
the plug in mode.
*/
ToolBarManager();
void LockUpdate();
void UnlockUpdate();
};
} // end of namespace sd
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
