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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
/* -*- 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 "celllistsource.hxx"
#include <tools/debug.hxx>
#include <com/sun/star/text/XTextRange.hpp>
#include <com/sun/star/sheet/XCellRangeAddressable.hpp>
#include <com/sun/star/util/XModifyBroadcaster.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <cppuhelper/supportsservice.hxx>
namespace calc
{
#define PROP_HANDLE_RANGE_ADDRESS 1
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::table;
using namespace ::com::sun::star::text;
using namespace ::com::sun::star::sheet;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::form::binding;
OCellListSource::OCellListSource( const Reference< XSpreadsheetDocument >& _rxDocument )
:OCellListSource_Base( m_aMutex )
,OCellListSource_PBase( OCellListSource_Base::rBHelper )
,m_xDocument( _rxDocument )
,m_aListEntryListeners( m_aMutex )
,m_bInitialized( false )
{
OSL_PRECOND( m_xDocument.is(), "OCellListSource::OCellListSource: invalid document!" );
// register our property at the base class
registerPropertyNoMember(
"CellRange",
PROP_HANDLE_RANGE_ADDRESS,
PropertyAttribute::BOUND | PropertyAttribute::READONLY,
cppu::UnoType<CellRangeAddress>::get(),
css::uno::Any(CellRangeAddress())
);
}
OCellListSource::~OCellListSource( )
{
if ( !OCellListSource_Base::rBHelper.bDisposed )
{
acquire(); // prevent duplicate dtor
dispose();
}
}
IMPLEMENT_FORWARD_XINTERFACE2( OCellListSource, OCellListSource_Base, OCellListSource_PBase )
IMPLEMENT_FORWARD_XTYPEPROVIDER2( OCellListSource, OCellListSource_Base, OCellListSource_PBase )
void SAL_CALL OCellListSource::disposing()
{
::osl::MutexGuard aGuard( m_aMutex );
Reference<XModifyBroadcaster> xBroadcaster( m_xRange, UNO_QUERY );
if ( xBroadcaster.is() )
{
xBroadcaster->removeModifyListener( this );
}
EventObject aDisposeEvent( *this );
m_aListEntryListeners.disposeAndClear( aDisposeEvent );
WeakAggComponentImplHelperBase::disposing();
// TODO: clean up here whatever you need to clean up (e.g. revoking listeners etc.)
}
Reference< XPropertySetInfo > SAL_CALL OCellListSource::getPropertySetInfo( )
{
return createPropertySetInfo( getInfoHelper() ) ;
}
::cppu::IPropertyArrayHelper& SAL_CALL OCellListSource::getInfoHelper()
{
return *OCellListSource_PABase::getArrayHelper();
}
::cppu::IPropertyArrayHelper* OCellListSource::createArrayHelper( ) const
{
Sequence< Property > aProps;
describeProperties( aProps );
return new ::cppu::OPropertyArrayHelper(aProps);
}
void SAL_CALL OCellListSource::getFastPropertyValue( Any& _rValue, sal_Int32 _nHandle ) const
{
OSL_ENSURE( _nHandle == PROP_HANDLE_RANGE_ADDRESS, "OCellListSource::getFastPropertyValue: invalid handle!" );
// we only have this one property ....
(void)_nHandle; // avoid warning in product version
_rValue <<= getRangeAddress( );
}
void OCellListSource::checkDisposed( ) const
{
if ( OCellListSource_Base::rBHelper.bInDispose || OCellListSource_Base::rBHelper.bDisposed )
throw DisposedException();
// TODO: is it worth having an error message here?
}
void OCellListSource::checkInitialized()
{
if ( !m_bInitialized )
throw RuntimeException();
// TODO: error message
}
OUString SAL_CALL OCellListSource::getImplementationName( )
{
return OUString( "com.sun.star.comp.sheet.OCellListSource" );
}
sal_Bool SAL_CALL OCellListSource::supportsService( const OUString& _rServiceName )
{
return cppu::supportsService(this, _rServiceName);
}
Sequence< OUString > SAL_CALL OCellListSource::getSupportedServiceNames( )
{
return {"com.sun.star.table.CellRangeListSource",
"com.sun.star.form.binding.ListEntrySource"};
}
CellRangeAddress OCellListSource::getRangeAddress( ) const
{
OSL_PRECOND( m_xRange.is(), "OCellListSource::getRangeAddress: invalid range!" );
CellRangeAddress aAddress;
Reference< XCellRangeAddressable > xRangeAddress( m_xRange, UNO_QUERY );
if ( xRangeAddress.is() )
aAddress = xRangeAddress->getRangeAddress( );
return aAddress;
}
OUString OCellListSource::getCellTextContent_noCheck( sal_Int32 _nRangeRelativeRow )
{
OSL_PRECOND( m_xRange.is(), "OCellListSource::getRangeAddress: invalid range!" );
Reference< XTextRange > xCellText;
if ( m_xRange.is() )
xCellText.set(m_xRange->getCellByPosition( 0, _nRangeRelativeRow ), css::uno::UNO_QUERY);
OUString sText;
if ( xCellText.is() )
sText = xCellText->getString();
return sText;
}
sal_Int32 SAL_CALL OCellListSource::getListEntryCount( )
{
::osl::MutexGuard aGuard( m_aMutex );
checkDisposed();
checkInitialized();
CellRangeAddress aAddress( getRangeAddress( ) );
return aAddress.EndRow - aAddress.StartRow + 1;
}
OUString SAL_CALL OCellListSource::getListEntry( sal_Int32 _nPosition )
{
::osl::MutexGuard aGuard( m_aMutex );
checkDisposed();
checkInitialized();
if ( _nPosition >= getListEntryCount() )
throw IndexOutOfBoundsException();
return getCellTextContent_noCheck( _nPosition );
}
Sequence< OUString > SAL_CALL OCellListSource::getAllListEntries( )
{
::osl::MutexGuard aGuard( m_aMutex );
checkDisposed();
checkInitialized();
Sequence< OUString > aAllEntries( getListEntryCount() );
OUString* pAllEntries = aAllEntries.getArray();
for ( sal_Int32 i = 0; i < aAllEntries.getLength(); ++i )
{
*pAllEntries++ = getCellTextContent_noCheck( i );
}
return aAllEntries;
}
void SAL_CALL OCellListSource::addListEntryListener( const Reference< XListEntryListener >& _rxListener )
{
::osl::MutexGuard aGuard( m_aMutex );
checkDisposed();
checkInitialized();
if ( !_rxListener.is() )
throw NullPointerException();
m_aListEntryListeners.addInterface( _rxListener );
}
void SAL_CALL OCellListSource::removeListEntryListener( const Reference< XListEntryListener >& _rxListener )
{
::osl::MutexGuard aGuard( m_aMutex );
checkDisposed();
checkInitialized();
if ( !_rxListener.is() )
throw NullPointerException();
m_aListEntryListeners.removeInterface( _rxListener );
}
void SAL_CALL OCellListSource::modified( const EventObject& /* aEvent */ )
{
notifyModified();
}
void OCellListSource::notifyModified()
{
EventObject aEvent;
aEvent.Source.set(*this);
::comphelper::OInterfaceIteratorHelper2 aIter( m_aListEntryListeners );
while ( aIter.hasMoreElements() )
{
try
{
static_cast< XListEntryListener* >( aIter.next() )->allEntriesChanged( aEvent );
}
catch( const RuntimeException& )
{
// silent this
}
catch( const Exception& )
{
OSL_FAIL( "OCellListSource::notifyModified: caught a (non-runtime) exception!" );
}
}
}
void SAL_CALL OCellListSource::disposing( const EventObject& aEvent )
{
Reference<XInterface> xRangeInt( m_xRange, UNO_QUERY );
if ( xRangeInt == aEvent.Source )
{
// release references to range object
m_xRange.clear();
}
}
void SAL_CALL OCellListSource::initialize( const Sequence< Any >& _rArguments )
{
if ( m_bInitialized )
throw Exception();
// TODO: error message
// get the cell address
CellRangeAddress aRangeAddress;
bool bFoundAddress = false;
const Any* pLoop = _rArguments.getConstArray();
const Any* pLoopEnd = _rArguments.getConstArray() + _rArguments.getLength();
for ( ; ( pLoop != pLoopEnd ) && !bFoundAddress; ++pLoop )
{
NamedValue aValue;
if ( *pLoop >>= aValue )
{
if ( aValue.Name == "CellRange" )
{
if ( aValue.Value >>= aRangeAddress )
bFoundAddress = true;
}
}
}
if ( !bFoundAddress )
// TODO: error message
throw Exception();
// determine the range we're bound to
try
{
if ( m_xDocument.is() )
{
// first the sheets collection
Reference< XIndexAccess > xSheets(m_xDocument->getSheets( ), UNO_QUERY);
OSL_ENSURE( xSheets.is(), "OCellListSource::initialize: could not retrieve the sheets!" );
if ( xSheets.is() )
{
// the concrete sheet
Reference< XCellRange > xSheet(xSheets->getByIndex( aRangeAddress.Sheet ), UNO_QUERY);
OSL_ENSURE( xSheet.is(), "OCellListSource::initialize: NULL sheet, but no exception!" );
// the concrete cell
if ( xSheet.is() )
{
m_xRange.set(xSheet->getCellRangeByPosition(
aRangeAddress.StartColumn, aRangeAddress.StartRow,
aRangeAddress.EndColumn, aRangeAddress.EndRow));
OSL_ENSURE( Reference< XCellRangeAddressable >( m_xRange, UNO_QUERY ).is(), "OCellListSource::initialize: either NULL range, or cell without address access!" );
}
}
}
}
catch( const Exception& )
{
OSL_FAIL( "OCellListSource::initialize: caught an exception while retrieving the cell object!" );
}
if ( !m_xRange.is() )
throw Exception();
// TODO error message
Reference<XModifyBroadcaster> xBroadcaster( m_xRange, UNO_QUERY );
if ( xBroadcaster.is() )
{
xBroadcaster->addModifyListener( this );
}
// TODO: add as XEventListener to the cell range, so we get notified when it dies,
// and can dispose ourself then
// TODO: somehow add as listener so we get notified when the address of the cell range changes
// We need to forward this as change in our CellRange property to our property change listeners
// TODO: somehow add as listener to the cells in the range, so that we get notified
// when their content changes. We need to forward this to our list entry listeners then
// TODO: somehow add as listener so that we get notified of insertions and removals of rows in our
// range. In this case, we need to fire a change in our CellRange property, and additionally
// notify our XListEntryListeners
m_bInitialized = true;
}
} // namespace calc
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
