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
|
/* -*- 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 SC_FAPIHELPER_HXX
#define SC_FAPIHELPER_HXX
#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XMultiPropertySet.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <tools/color.hxx>
#include <comphelper/types.hxx>
#include "ftools.hxx"
#include "scdllapi.h"
namespace com { namespace sun { namespace star {
namespace lang { class XMultiServiceFactory; }
} } }
namespace comphelper { class IDocPasswordVerifier; }
// Static helper functions ====================================================
class SfxMedium;
class SfxObjectShell;
/** Static API helper functions. */
class ScfApiHelper
{
public:
typedef ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > XInterfaceRef;
typedef ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > XServiceFactoryRef;
typedef ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > UnoAnySequence;
public:
/** Converts a tools color to a UNO color value. */
inline static sal_Int32 ConvertToApiColor( const Color& rColor )
{ return static_cast< sal_Int32 >( rColor.GetColor() ); }
/** Converts a UNO color value to a tools color. */
inline static Color ConvertFromApiColor( sal_Int32 nApiColor )
{ return Color( static_cast< ColorData >( nApiColor ) ); }
/** Converts a non-empty vector into a UNO sequence containing elements of the same type. */
template< typename Type >
static ::com::sun::star::uno::Sequence< Type >
VectorToSequence( const ::std::vector< Type >& rVector );
/** Returns the service name provided via the XServiceName interface, or an empty string on error. */
static ::rtl::OUString GetServiceName( XInterfaceRef xInt );
/** Returns the multi service factory from a document shell. */
static XServiceFactoryRef GetServiceFactory( SfxObjectShell* pShell );
/** Creates an instance from the passed service name, using the passed service factory. */
static XInterfaceRef CreateInstance(
XServiceFactoryRef xFactory,
const ::rtl::OUString& rServiceName );
/** Creates an instance from the passed service name, using the service factory of the passed object. */
static XInterfaceRef CreateInstance(
SfxObjectShell* pShell,
const ::rtl::OUString& rServiceName );
/** Creates an instance from the passed service name, using the process service factory. */
static XInterfaceRef CreateInstance( const ::rtl::OUString& rServiceName );
/** Opens a password dialog and returns the encryption data.
@return The encryption data or an empty sequence on 'Cancel' or any error. */
static ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > QueryEncryptionDataForMedium( SfxMedium& rMedium,
::comphelper::IDocPasswordVerifier& rVerifier,
const ::std::vector< ::rtl::OUString >* pDefaultPasswords = 0 );
};
template< typename Type >
::com::sun::star::uno::Sequence< Type > ScfApiHelper::VectorToSequence( const ::std::vector< Type >& rVector )
{
OSL_ENSURE( !rVector.empty(), "ScfApiHelper::VectorToSequence - vector is empty" );
return ::com::sun::star::uno::Sequence< Type >( &rVector.front(), static_cast< sal_Int32 >( rVector.size() ) );
}
// Property sets ==============================================================
/** A wrapper for a UNO property set.
This class provides functions to silently get and set properties (without
exceptions, without the need to check validity of the UNO property set).
An instance is constructed with the reference to a UNO property set or any
other interface (the constructor will query for the XPropertySet interface
then). The reference to the property set will be kept as long as the
instance of this class is alive.
The functions GetProperties() and SetProperties() try to handle all passed
values at once, using the XMultiPropertySet interface. If the
implementation does not support the XMultiPropertySet interface, all
properties are handled separately in a loop.
*/
class ScfPropertySet
{
public:
typedef ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet > XPropertySetRef;
typedef ::com::sun::star::uno::Reference<
::com::sun::star::beans::XMultiPropertySet > XMultiPropSetRef;
typedef ::com::sun::star::uno::Any UnoAny;
typedef ::com::sun::star::uno::Sequence< UnoAny > UnoAnySequence;
typedef ::com::sun::star::uno::Sequence< ::rtl::OUString > OUStringSequence;
public:
inline explicit ScfPropertySet() {}
/** Constructs a property set wrapper with the passed UNO property set. */
inline explicit ScfPropertySet( XPropertySetRef xPropSet ) { Set( xPropSet ); }
/** Constructs a property set wrapper after querying the XPropertySet interface. */
template< typename InterfaceType >
inline explicit ScfPropertySet( ::com::sun::star::uno::Reference< InterfaceType > xInterface ) { Set( xInterface ); }
~ScfPropertySet();
/** Sets the passed UNO property set and releases the old UNO property set. */
void Set( XPropertySetRef xPropSet );
/** Queries the passed interface for an XPropertySet and releases the old UNO property set. */
template< typename InterfaceType >
inline void Set( ::com::sun::star::uno::Reference< InterfaceType > xInterface )
{ Set( XPropertySetRef( xInterface, ::com::sun::star::uno::UNO_QUERY ) ); }
/** Returns true, if the contained XPropertySet interface is valid. */
inline bool Is() const { return mxPropSet.is(); }
/** Returns the contained XPropertySet interface. */
inline XPropertySetRef GetApiPropertySet() const { return mxPropSet; }
/** Returns the service name provided via the XServiceName interface, or an empty string on error. */
::rtl::OUString GetServiceName() const;
// Get properties ---------------------------------------------------------
/** Returns true, if the property set contains the specified property. */
bool HasProperty( const ::rtl::OUString& rPropName ) const;
/** Gets the specified property from the property set.
@return true, if the Any could be filled with the property value. */
bool GetAnyProperty( UnoAny& rValue, const ::rtl::OUString& rPropName ) const;
/** Gets the specified property from the property set.
@return true, if the passed variable could be filled with the property value. */
template< typename Type >
inline bool GetProperty( Type& rValue, const ::rtl::OUString& rPropName ) const
{ UnoAny aAny; return GetAnyProperty( aAny, rPropName ) && (aAny >>= rValue); }
/** Gets the specified Boolean property from the property set.
@return true = property contains true; false = property contains false or error occurred. */
bool GetBoolProperty( const ::rtl::OUString& rPropName ) const;
/** Gets the specified Boolean property from the property set.
@return true, if the passed Boolean variable could be filled with the property value. */
bool GetStringProperty( String& rValue, const ::rtl::OUString& rPropName ) const;
/** Gets the specified color property from the property set.
@return true, if the passed color variable could be filled with the property value. */
bool GetColorProperty( Color& rColor, const ::rtl::OUString& rPropName ) const;
/** Gets the specified properties from the property set. Tries to use the XMultiPropertySet interface.
@param rPropNames The property names. MUST be ordered alphabetically.
@param rValues The related property values. */
void GetProperties( UnoAnySequence& rValues, const OUStringSequence& rPropNames ) const;
// Set properties ---------------------------------------------------------
/** Puts the passed Any into the property set. */
void SetAnyProperty( const ::rtl::OUString& rPropName, const UnoAny& rValue );
/** Puts the passed value into the property set. */
template< typename Type >
inline void SetProperty( const ::rtl::OUString& rPropName, const Type& rValue )
{ SetAnyProperty( rPropName, ::com::sun::star::uno::makeAny( rValue ) ); }
/** Puts the passed Boolean value into the property set. */
inline void SetBoolProperty( const ::rtl::OUString& rPropName, bool bValue )
{ SetAnyProperty( rPropName, ::comphelper::makeBoolAny( bValue ) ); }
/** Puts the passed string into the property set. */
inline void SetStringProperty( const ::rtl::OUString& rPropName, const String& rValue )
{ SetProperty( rPropName, ::rtl::OUString( rValue ) ); }
/** Puts the passed color into the property set. */
inline void SetColorProperty( const ::rtl::OUString& rPropName, const Color& rColor )
{ SetProperty( rPropName, ScfApiHelper::ConvertToApiColor( rColor ) ); }
/** Puts the passed properties into the property set. Tries to use the XMultiPropertySet interface.
@param rPropNames The property names. MUST be ordered alphabetically.
@param rValues The related property values. */
void SetProperties( const OUStringSequence& rPropNames, const UnoAnySequence& rValues );
// ------------------------------------------------------------------------
private:
XPropertySetRef mxPropSet; /// The mandatory property set interface.
XMultiPropSetRef mxMultiPropSet; /// The optional multi property set interface.
};
// ----------------------------------------------------------------------------
/** Generic helper class for reading from and writing to property sets.
Usage:
1) Call the constructor with a null-terminated array of ASCII strings.
2a) Read properties from a property set: Call the ReadFromPropertySet()
function, then get the properties with the ReadValue() functions or the
operator>> stream operator. The properties are returned in order of the
array of property names passed in the constructor.
2b) Write properties to a property set: Call InitializeWrite() to start a
new cycle. Set the values with the WriteValue() functions or the
operator<< stream operator. The order of the properties is equal to the
array of property names passed in the constructor. Finally, call the
WriteToPropertySet() function.
*/
class ScfPropSetHelper
{
public:
typedef ::com::sun::star::uno::Any UnoAny;
public:
/** @param ppPropNames A null-terminated array of ASCII property names. */
explicit ScfPropSetHelper( const sal_Char* const* ppcPropNames );
// read properties --------------------------------------------------------
/** Reads all values from the passed property set. */
void ReadFromPropertySet( const ScfPropertySet& rPropSet );
/** Reads the next value from the value sequence. */
template< typename Type >
bool ReadValue( Type& rValue );
/** Reads an Any from the value sequence. */
bool ReadValue( UnoAny& rAny );
/** Reads a tools string from the value sequence. */
bool ReadValue( String& rString );
/** Reads a color value from the value sequence. */
bool ReadValue( Color& rColor );
/** Reads a C++ boolean value from the value sequence. */
bool ReadValue( bool& rbValue );
// write properties -------------------------------------------------------
/** Must be called before reading or storing property values in the helper. */
void InitializeWrite( bool bClearAllAnys = false );
/** Writes the next value to the value sequence. */
template< typename Type >
void WriteValue( const Type& rValue );
/** Writes an Any to the value sequence. */
void WriteValue( const UnoAny& rAny );
/** Writes a tools string to the value sequence. */
inline void WriteValue( const String& rString )
{ WriteValue( ::rtl::OUString( rString ) ); }
/** Writes a color value to the value sequence. */
inline void WriteValue( const Color& rColor )
{ WriteValue( ScfApiHelper::ConvertToApiColor( rColor ) ); }
/** Writes a C++ boolean value to the value sequence. */
void WriteValue( const bool& rbValue );
/** Writes all values to the passed property set. */
void WriteToPropertySet( ScfPropertySet& rPropSet ) const;
// ------------------------------------------------------------------------
private:
/** Returns a pointer to the next Any to be written to. */
UnoAny* GetNextAny();
private:
typedef ::com::sun::star::uno::Sequence< ::rtl::OUString > OUStringSequence;
typedef ::com::sun::star::uno::Sequence< UnoAny > UnoAnySequence;
OUStringSequence maNameSeq; /// Sequence of property names.
UnoAnySequence maValueSeq; /// Sequence of property values.
ScfInt32Vec maNameOrder; /// Maps initial order to alphabetical order.
size_t mnNextIdx; /// Counter for next Any to be processed.
};
// ----------------------------------------------------------------------------
template< typename Type >
bool ScfPropSetHelper::ReadValue( Type& rValue )
{
UnoAny* pAny = GetNextAny();
return pAny && (*pAny >>= rValue);
}
template< typename Type >
void ScfPropSetHelper::WriteValue( const Type& rValue )
{
UnoAny* pAny = GetNextAny();
if( pAny )
*pAny <<= rValue;
}
template< typename Type >
ScfPropSetHelper& operator>>( ScfPropSetHelper& rPropSetHelper, Type& rValue )
{
rPropSetHelper.ReadValue( rValue );
return rPropSetHelper;
}
template< typename Type >
ScfPropSetHelper& operator<<( ScfPropSetHelper& rPropSetHelper, const Type& rValue )
{
rPropSetHelper.WriteValue( rValue );
return rPropSetHelper;
}
// ============================================================================
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
