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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545 | /* -*- 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 "cellbindinghelper.hxx"
#include <com/sun/star/form/binding/XBindableValue.hpp>
#include <com/sun/star/form/binding/XListEntrySink.hpp>
#include <com/sun/star/form/FormComponentType.hpp>
#include <com/sun/star/form/XGridColumnFactory.hpp>
#include <com/sun/star/container/XChild.hpp>
#include <com/sun/star/drawing/XDrawPageSupplier.hpp>
#include <com/sun/star/form/XFormsSupplier.hpp>
#include <com/sun/star/form/XForm.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <com/sun/star/sheet/XSpreadsheet.hpp>
#include <unotools/transliterationwrapper.hxx>
#include <osl/diagnose.h>
#include <tools/diagnose_ex.h>
#include "formstrings.hxx"
#include <algorithm>
namespace pcr
{
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::frame;
using namespace ::com::sun::star::sheet;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::drawing;
using namespace ::com::sun::star::table;
using namespace ::com::sun::star::form;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::i18n;
using namespace ::com::sun::star::form::binding;
namespace
{
struct StringCompare
{
private:
OUString m_sReference;
public:
explicit StringCompare( const OUString& _rReference ) : m_sReference( _rReference ) { }
bool operator()( const OUString& _rCompare )
{
return ( _rCompare == m_sReference );
}
};
}
CellBindingHelper::CellBindingHelper( const Reference< XPropertySet >& _rxControlModel, const Reference< XModel >& _rxContextDocument )
:m_xControlModel( _rxControlModel )
{
OSL_ENSURE( m_xControlModel.is(), "CellBindingHelper::CellBindingHelper: invalid control model!" );
m_xDocument.set(_rxContextDocument, css::uno::UNO_QUERY);
OSL_ENSURE( m_xDocument.is(), "CellBindingHelper::CellBindingHelper: This is no spreadsheet document!" );
OSL_ENSURE( isSpreadsheetDocumentWhichSupplies( SERVICE_ADDRESS_CONVERSION ),
"CellBindingHelper::CellBindingHelper: the document cannot convert address representations!" );
}
bool CellBindingHelper::isSpreadsheetDocument( const Reference< XModel >& _rxContextDocument )
{
return Reference< XSpreadsheetDocument >::query( _rxContextDocument ).is();
}
sal_Int16 CellBindingHelper::getControlSheetIndex( Reference< XSpreadsheet >& _out_rxSheet ) const
{
sal_Int16 nSheetIndex = -1;
// every sheet has a draw page, and every draw page has a forms collection.
// Our control, OTOH, belongs to a forms collection. Match these...
try
{
// for determining the draw page, we need the forms collection which
// the object belongs to. This is the first object up the hierarchy which is
// *no* XForm (and, well, no XGridColumnFactory)
Reference< XChild > xCheck( m_xControlModel, UNO_QUERY );
Reference< XForm > xParentAsForm; if ( xCheck.is() ) xParentAsForm.set(xCheck->getParent(), css::uno::UNO_QUERY);
Reference< XGridColumnFactory > xParentAsGrid; if ( xCheck.is() ) xParentAsGrid.set(xCheck->getParent(), css::uno::UNO_QUERY);
while ( ( xParentAsForm.is() || xParentAsGrid.is() ) && xCheck.is() )
{
xCheck.set(xCheck->getParent(), css::uno::UNO_QUERY);
xParentAsForm.set(xCheck.is() ? xCheck->getParent() : Reference< XForm >(), css::uno::UNO_QUERY);
xParentAsGrid.set(xCheck.is() ? xCheck->getParent() : Reference< XGridColumnFactory >(), css::uno::UNO_QUERY);
}
Reference< XInterface > xFormsCollection( xCheck.is() ? xCheck->getParent() : Reference< XInterface >() );
// now iterate through the sheets
Reference< XIndexAccess > xSheets( m_xDocument->getSheets(), UNO_QUERY );
if ( xSheets.is() && xFormsCollection.is() )
{
for ( sal_Int32 i = 0; i < xSheets->getCount(); ++i )
{
Reference< XDrawPageSupplier > xSuppPage( xSheets->getByIndex( i ), UNO_QUERY_THROW );
Reference< XFormsSupplier > xSuppForms( xSuppPage->getDrawPage(), UNO_QUERY_THROW );
if ( xSuppForms->getForms() == xFormsCollection )
{ // found it
nSheetIndex = static_cast<sal_Int16>(i);
_out_rxSheet.set( xSuppPage, UNO_QUERY_THROW );
break;
}
}
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
return nSheetIndex;
}
bool CellBindingHelper::convertStringAddress( const OUString& _rAddressDescription, CellAddress& /* [out] */ _rAddress ) const
{
Any aAddress;
return doConvertAddressRepresentations(
PROPERTY_UI_REPRESENTATION,
makeAny( _rAddressDescription ),
PROPERTY_ADDRESS,
aAddress,
false
)
&& ( aAddress >>= _rAddress );
}
bool CellBindingHelper::doConvertAddressRepresentations( const OUString& _rInputProperty, const Any& _rInputValue,
const OUString& _rOutputProperty, Any& _rOutputValue, bool _bIsRange ) const
{
bool bSuccess = false;
Reference< XPropertySet > xConverter(
createDocumentDependentInstance(
_bIsRange ? OUString(SERVICE_RANGEADDRESS_CONVERSION) : OUString(SERVICE_ADDRESS_CONVERSION),
OUString(),
Any()
),
UNO_QUERY
);
OSL_ENSURE( xConverter.is(), "CellBindingHelper::doConvertAddressRepresentations: could not get a converter service!" );
if ( xConverter.is() )
{
try
{
Reference< XSpreadsheet > xSheet;
xConverter->setPropertyValue( PROPERTY_REFERENCE_SHEET, makeAny( static_cast<sal_Int32>(getControlSheetIndex( xSheet )) ) );
xConverter->setPropertyValue( _rInputProperty, _rInputValue );
_rOutputValue = xConverter->getPropertyValue( _rOutputProperty );
bSuccess = true;
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingHelper::doConvertAddressRepresentations" );
}
}
return bSuccess;
}
bool CellBindingHelper::convertStringAddress( const OUString& _rAddressDescription,
CellRangeAddress& /* [out] */ _rAddress ) const
{
Any aAddress;
return doConvertAddressRepresentations(
PROPERTY_UI_REPRESENTATION,
makeAny( _rAddressDescription ),
PROPERTY_ADDRESS,
aAddress,
true
)
&& ( aAddress >>= _rAddress );
}
Reference< XValueBinding > CellBindingHelper::createCellBindingFromAddress( const CellAddress& _rAddress, bool _bSupportIntegerExchange ) const
{
Reference< XValueBinding > xBinding( createDocumentDependentInstance(
_bSupportIntegerExchange ? OUString(SERVICE_SHEET_CELL_INT_BINDING) : OUString(SERVICE_SHEET_CELL_BINDING),
PROPERTY_BOUND_CELL,
makeAny( _rAddress )
), UNO_QUERY );
return xBinding;
}
Reference< XValueBinding > CellBindingHelper::createCellBindingFromStringAddress( const OUString& _rAddress, bool _bSupportIntegerExchange ) const
{
Reference< XValueBinding > xBinding;
if ( !m_xDocument.is() )
// very bad ...
return xBinding;
// get the UNO representation of the address
CellAddress aAddress;
if ( _rAddress.isEmpty() || !convertStringAddress( _rAddress, aAddress ) )
return xBinding;
return createCellBindingFromAddress( aAddress, _bSupportIntegerExchange );
}
Reference< XListEntrySource > CellBindingHelper::createCellListSourceFromStringAddress( const OUString& _rAddress ) const
{
Reference< XListEntrySource > xSource;
CellRangeAddress aRangeAddress;
if ( _rAddress.isEmpty() || !convertStringAddress( _rAddress, aRangeAddress ) )
return xSource;
// create a range object for this address
xSource.set(createDocumentDependentInstance(
SERVICE_SHEET_CELLRANGE_LISTSOURCE,
PROPERTY_LIST_CELL_RANGE,
makeAny( aRangeAddress )
), css::uno::UNO_QUERY);
return xSource;
}
Reference< XInterface > CellBindingHelper::createDocumentDependentInstance( const OUString& _rService, const OUString& _rArgumentName,
const Any& _rArgumentValue ) const
{
Reference< XInterface > xReturn;
Reference< XMultiServiceFactory > xDocumentFactory( m_xDocument, UNO_QUERY );
OSL_ENSURE( xDocumentFactory.is(), "CellBindingHelper::createDocumentDependentInstance: no document service factory!" );
if ( xDocumentFactory.is() )
{
try
{
if ( !_rArgumentName.isEmpty() )
{
NamedValue aArg;
aArg.Name = _rArgumentName;
aArg.Value = _rArgumentValue;
Sequence< Any > aArgs( 1 );
aArgs[ 0 ] <<= aArg;
xReturn = xDocumentFactory->createInstanceWithArguments( _rService, aArgs );
}
else
{
xReturn = xDocumentFactory->createInstance( _rService );
}
}
catch ( const Exception& )
{
OSL_FAIL( "CellBindingHelper::createDocumentDependentInstance: could not create the binding at the document!" );
}
}
return xReturn;
}
bool CellBindingHelper::getAddressFromCellBinding(
const Reference< XValueBinding >& _rxBinding, CellAddress& _rAddress ) const
{
OSL_PRECOND( !_rxBinding.is() || isCellBinding( _rxBinding ), "CellBindingHelper::getAddressFromCellBinding: this is no cell binding!" );
bool bReturn = false;
if ( !m_xDocument.is() )
// very bad ...
return bReturn;
try
{
Reference< XPropertySet > xBindingProps( _rxBinding, UNO_QUERY );
OSL_ENSURE( xBindingProps.is() || !_rxBinding.is(), "CellBindingHelper::getAddressFromCellBinding: no property set for the binding!" );
if ( xBindingProps.is() )
{
bReturn = ( xBindingProps->getPropertyValue( PROPERTY_BOUND_CELL ) >>= _rAddress );
}
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingHelper::getAddressFromCellBinding" );
}
return bReturn;
}
OUString CellBindingHelper::getStringAddressFromCellBinding( const Reference< XValueBinding >& _rxBinding ) const
{
CellAddress aAddress;
OUString sAddress;
if ( getAddressFromCellBinding( _rxBinding, aAddress ) )
{
Any aStringAddress;
doConvertAddressRepresentations( PROPERTY_ADDRESS, makeAny( aAddress ),
PROPERTY_UI_REPRESENTATION, aStringAddress, false );
aStringAddress >>= sAddress;
}
return sAddress;
}
OUString CellBindingHelper::getStringAddressFromCellListSource( const Reference< XListEntrySource >& _rxSource ) const
{
OSL_PRECOND( !_rxSource.is() || isCellRangeListSource( _rxSource ), "CellBindingHelper::getStringAddressFromCellListSource: this is no cell list source!" );
OUString sAddress;
if ( !m_xDocument.is() )
// very bad ...
return sAddress;
try
{
Reference< XPropertySet > xSourceProps( _rxSource, UNO_QUERY );
OSL_ENSURE( xSourceProps.is() || !_rxSource.is(), "CellBindingHelper::getStringAddressFromCellListSource: no property set for the list source!" );
if ( xSourceProps.is() )
{
CellRangeAddress aRangeAddress;
xSourceProps->getPropertyValue( PROPERTY_LIST_CELL_RANGE ) >>= aRangeAddress;
Any aStringAddress;
doConvertAddressRepresentations( PROPERTY_ADDRESS, makeAny( aRangeAddress ),
PROPERTY_UI_REPRESENTATION, aStringAddress, true );
aStringAddress >>= sAddress;
}
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingHelper::getStringAddressFromCellListSource" );
}
return sAddress;
}
bool CellBindingHelper::isSpreadsheetDocumentWhichSupplies( const OUString& _rService ) const
{
bool bYesItIs = false;
Reference< XServiceInfo > xSI( m_xDocument, UNO_QUERY );
if ( xSI.is() && xSI->supportsService( SERVICE_SPREADSHEET_DOCUMENT ) )
{
Reference< XMultiServiceFactory > xDocumentFactory( m_xDocument, UNO_QUERY );
OSL_ENSURE( xDocumentFactory.is(), "CellBindingHelper::isSpreadsheetDocumentWhichSupplies: spreadsheet document, but no factory?" );
Sequence< OUString > aAvailableServices;
if ( xDocumentFactory.is() )
aAvailableServices = xDocumentFactory->getAvailableServiceNames( );
bYesItIs = std::any_of(
aAvailableServices.begin(),
aAvailableServices.end(),
StringCompare( _rService )
);
}
return bYesItIs;
}
bool CellBindingHelper::isListCellRangeAllowed( ) const
{
bool bAllow( false );
Reference< XListEntrySink > xSink( m_xControlModel, UNO_QUERY );
if ( xSink.is() )
{
bAllow = isSpreadsheetDocumentWhichSupplies( SERVICE_SHEET_CELLRANGE_LISTSOURCE );
}
return bAllow;
}
bool CellBindingHelper::isCellIntegerBindingAllowed( ) const<--- The function 'isCellIntegerBindingAllowed' is never used.
{
bool bAllow( true );
// first, we only offer this for controls which allow bindings in general
Reference< XBindableValue > xBindable( m_xControlModel, UNO_QUERY );
if ( !xBindable.is() )
bAllow = false;
// then, we must live in a spreadsheet document which can provide the special
// service needed for exchanging integer values
if ( bAllow )
bAllow = isSpreadsheetDocumentWhichSupplies( SERVICE_SHEET_CELL_INT_BINDING );
// then, we only offer this for list boxes
if ( bAllow )
{
try
{
sal_Int16 nClassId = FormComponentType::CONTROL;
m_xControlModel->getPropertyValue( PROPERTY_CLASSID ) >>= nClassId;
if ( FormComponentType::LISTBOX != nClassId )
bAllow = false;
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingHelper::isCellIntegerBindingAllowed" );
// are there really control models which survive isCellBindingAllowed, but don't have a ClassId
// property?
bAllow = false;
}
}
return bAllow;
}
bool CellBindingHelper::isCellBindingAllowed( ) const
{
bool bAllow( false );
Reference< XBindableValue > xBindable( m_xControlModel, UNO_QUERY );
if ( xBindable.is() )
{
// the control can potentially be bound to an external value
// Does it live within a Calc document, and is able to supply CellBindings?
bAllow = isSpreadsheetDocumentWhichSupplies( SERVICE_SHEET_CELL_BINDING );
}
// disallow for some types
// TODO: shouldn't the XBindableValue supply a list of supported types, and we can distinguish
// using this list? The current behavior below is somewhat hackish...
if ( bAllow )
{
try
{
sal_Int16 nClassId = FormComponentType::CONTROL;
m_xControlModel->getPropertyValue( PROPERTY_CLASSID ) >>= nClassId;
if ( ( FormComponentType::DATEFIELD == nClassId ) || ( FormComponentType::TIMEFIELD == nClassId ) )
bAllow = false;
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingHelper::isCellBindingAllowed" );
bAllow = false;
}
}
return bAllow;
}
bool CellBindingHelper::isCellBinding( const Reference< XValueBinding >& _rxBinding )
{
return doesComponentSupport( _rxBinding.get(), SERVICE_SHEET_CELL_BINDING );
}
bool CellBindingHelper::isCellIntegerBinding( const Reference< XValueBinding >& _rxBinding )
{
return doesComponentSupport( _rxBinding.get(), SERVICE_SHEET_CELL_INT_BINDING );
}
bool CellBindingHelper::isCellRangeListSource( const Reference< XListEntrySource >& _rxSource )
{
return doesComponentSupport( _rxSource.get(), SERVICE_SHEET_CELLRANGE_LISTSOURCE );
}
bool CellBindingHelper::doesComponentSupport( const Reference< XInterface >& _rxComponent, const OUString& _rService )
{
Reference< XServiceInfo > xSI( _rxComponent, UNO_QUERY );
bool bDoes = xSI.is() && xSI->supportsService( _rService );
return bDoes;
}
Reference< XValueBinding > CellBindingHelper::getCurrentBinding( ) const
{
Reference< XValueBinding > xBinding;
Reference< XBindableValue > xBindable( m_xControlModel, UNO_QUERY );
if ( xBindable.is() )
xBinding = xBindable->getValueBinding();
return xBinding;
}
Reference< XListEntrySource > CellBindingHelper::getCurrentListSource( ) const
{
Reference< XListEntrySource > xSource;
Reference< XListEntrySink > xSink( m_xControlModel, UNO_QUERY );
if ( xSink.is() )
xSource = xSink->getListEntrySource();
return xSource;
}
void CellBindingHelper::setBinding( const Reference< XValueBinding >& _rxBinding )
{
Reference< XBindableValue > xBindable( m_xControlModel, UNO_QUERY );
OSL_PRECOND( xBindable.is(), "CellBindingHelper::setBinding: the object is not bindable!" );
if ( xBindable.is() )
xBindable->setValueBinding( _rxBinding );
}
void CellBindingHelper::setListSource( const Reference< XListEntrySource >& _rxSource )
{
Reference< XListEntrySink > xSink( m_xControlModel, UNO_QUERY );
OSL_PRECOND( xSink.is(), "CellBindingHelper::setListSource: the object is no list entry sink!" );
if ( xSink.is() )
xSink->setListEntrySource( _rxSource );
}
} // namespace pcr
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|