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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/* -*- 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 .
*/
#include <classes/framecontainer.hxx>
#include <com/sun/star/frame/FrameSearchFlag.hpp>
#include <vcl/svapp.hxx>
#include <comphelper/sequence.hxx>
#include <sal/log.hxx>
namespace framework{
/**-***************************************************************************************************************
@short initialize an empty container
@descr The container will be empty then - special features (e.g. the async quit mechanism) are disabled.
@threadsafe not necessary - it's not a singleton
*****************************************************************************************************************/
FrameContainer::FrameContainer()
/*DEPRECATEME
, m_bAsyncQuit ( sal_False ) // default must be "disabled"!
, m_aAsyncCall ( LINK( this, FrameContainer, implts_asyncQuit ) )
*/
{
}
/**-***************************************************************************************************************
@short deinitialize may a filled container
@descr Special features (if the currently are running) will be disabled and we free all used other resources.
@threadsafe not necessary - it's not a singleton
*****************************************************************************************************************/
FrameContainer::~FrameContainer()
{
// Don't forget to free memory!
m_aContainer.clear();
m_xActiveFrame.clear();
}
/**-***************************************************************************************************************
@short append a new frame to the container
@descr We accept the incoming frame only, if it is a valid reference and doesn't exist already.
@param xFrame
frame, which should be added to this container
Must be a valid reference.
@threadsafe yes
*****************************************************************************************************************/
void FrameContainer::append( const css::uno::Reference< css::frame::XFrame >& xFrame )
{
if (xFrame.is() && ! exist(xFrame))
{
SolarMutexGuard g;
m_aContainer.push_back( xFrame );
}
}
/**-***************************************************************************************************************
@short remove a frame from the container
@descr In case we remove the last frame and our internal special feature (the async quit mechanism)
was enabled by the desktop instance, we start it.
@param xFrame
frame, which should be deleted from this container
Must be a valid reference.
@threadsafe yes
*****************************************************************************************************************/
void FrameContainer::remove( const css::uno::Reference< css::frame::XFrame >& xFrame )
{
SolarMutexGuard g;
TFrameContainer::iterator aSearchedItem = ::std::find( m_aContainer.begin(), m_aContainer.end(), xFrame );
if (aSearchedItem!=m_aContainer.end())
{
m_aContainer.erase( aSearchedItem );
// If removed frame was the current active frame - reset state variable.
if (m_xActiveFrame==xFrame)
m_xActiveFrame.clear();
}
}
/**-***************************************************************************************************************
@short check if the given frame currently exist inside the container
@param xFrame
reference to the queried frame
@return <TRUE/> if frame is part of this container
<FALSE/> otherwise
@threadsafe yes
*****************************************************************************************************************/
bool FrameContainer::exist( const css::uno::Reference< css::frame::XFrame >& xFrame ) const
{
SolarMutexGuard g;
return( ::std::find( m_aContainer.begin(), m_aContainer.end(), xFrame ) != m_aContainer.end() );
}
/**-***************************************************************************************************************
@short delete all existing items of the container
@threadsafe yes
*****************************************************************************************************************/
void FrameContainer::clear()
{
SolarMutexGuard g;
// Clear the container ...
m_aContainer.clear();
// ... and don't forget to reset the active frame.
// It's a reference to a valid container-item.
// But no container item => no active frame!
m_xActiveFrame.clear();
}
/**-***************************************************************************************************************
@short returns count of all current existing frames
@deprecated This value can't be guaranteed for multithreading environments.
So it will be marked as deprecated and should be replaced by "getAllElements()".
@return the count of existing container items
@threadsafe yes
*****************************************************************************************************************/
sal_uInt32 FrameContainer::getCount() const
{
SolarMutexGuard g;
return static_cast<sal_uInt32>(m_aContainer.size());
}
/**-***************************************************************************************************************
@short returns one item of this container
@deprecated This value can't be guaranteed for multithreading environments.
So it will be marked as deprecated and should be replaced by "getAllElements()".
@param nIndex
a value between 0 and (getCount()-1) to address one container item
@return a reference to a frame inside the container, which match with given index
@threadsafe yes
*****************************************************************************************************************/
css::uno::Reference< css::frame::XFrame > FrameContainer::operator[]( sal_uInt32 nIndex ) const
{
css::uno::Reference< css::frame::XFrame > xFrame;
try
{
// Get element form container WITH automatic test of ranges!
// If index not valid, an out_of_range exception is thrown.
SolarMutexGuard g;
xFrame = m_aContainer.at( nIndex );
}
catch( const std::out_of_range& )
{
// The index is not valid for current container-content - we must handle this case!
// We can return the default value ...
SAL_INFO( "fwk", "FrameContainer::operator[]: Exception caught: std::out_of_range" );
}
return xFrame;
}
/**-***************************************************************************************************************
@short returns a snapshot of all currently existing frames inside this container
@descr Should be used to replace the deprecated functions getCount()/operator[]!
@return a list of all frame references inside this container
@threadsafe yes
*****************************************************************************************************************/
css::uno::Sequence< css::uno::Reference< css::frame::XFrame > > FrameContainer::getAllElements() const
{
SolarMutexGuard g;
return comphelper::containerToSequence(m_aContainer);
}
/**-***************************************************************************************************************
@short set the given frame as the new active one inside this container
@descr We accept this frame only, if it's already a part of this container.
@param xFrame
reference to the new active frame
Must be a valid reference and already part of this container.
@threadsafe yes
*****************************************************************************************************************/
void FrameContainer::setActive( const css::uno::Reference< css::frame::XFrame >& xFrame )
{
if ( !xFrame.is() || exist(xFrame) )
{
SolarMutexGuard g;
m_xActiveFrame = xFrame;
}
}
/**-***************************************************************************************************************
@short return the current active frame of this container
@descr Value can be null in case the frame was removed from the container and nobody
from outside decide which of all others should be the new one...
@return a reference to the current active frame
Value can be NULL!
@threadsafe yes
*****************************************************************************************************************/
css::uno::Reference< css::frame::XFrame > FrameContainer::getActive() const
{
SolarMutexGuard g;
return m_xActiveFrame;
}
/**-***************************************************************************************************************
@short implements a simple search based on current container items
@descr It can be used for findFrame() and implements a deep down search.
@param sName
target name, which is searched
@return reference to the found frame or NULL if not.
@threadsafe yes
*****************************************************************************************************************/
css::uno::Reference< css::frame::XFrame > FrameContainer::searchOnAllChildrens( const OUString& sName ) const
{
SolarMutexGuard g;
// Step over all child frames. But if direct child isn't the right one search on his children first - before
// you go to next direct child of this container!
css::uno::Reference< css::frame::XFrame > xSearchedFrame;
for (auto const& container : m_aContainer)
{
if (container->getName()==sName)
{
xSearchedFrame = container;
break;
}
else
{
xSearchedFrame = container->findFrame( sName, css::frame::FrameSearchFlag::CHILDREN );
if (xSearchedFrame.is())
break;
}
}
return xSearchedFrame;
}
/**-***************************************************************************************************************
@short implements a simple search based on current container items
@descr It can be used for findFrame() and search on members of this container only!
@param sName
target name, which is searched
@return reference to the found frame or NULL if not.
@threadsafe yes
*****************************************************************************************************************/
css::uno::Reference< css::frame::XFrame > FrameContainer::searchOnDirectChildrens( const OUString& sName ) const
{
SolarMutexGuard g;
css::uno::Reference< css::frame::XFrame > xSearchedFrame;
for (auto const& container : m_aContainer)
{
if (container->getName()==sName)
{
xSearchedFrame = container;
break;
}
}
return xSearchedFrame;
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
