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
|
/* -*- 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_OOX_HELPER_PROPERTYSET_HXX
#define INCLUDED_OOX_HELPER_PROPERTYSET_HXX
#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <tools/color.hxx>
namespace com::sun::star {
namespace beans { class XMultiPropertySet; }
namespace beans { class XPropertySet; }
namespace beans { class XPropertySetInfo; }
}
namespace oox {
class PropertyMap;
/** 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
com.sun.star.beans.XPropertySet interface then). The reference to the
property set will be kept as long as the instance of this class is alive.
The functions setProperties() tries to handle all passed values at once,
using the com.sun.star.beans.XMultiPropertySet interface. If the
implementation does not support the XMultiPropertySet interface, all
properties are handled separately in a loop.
*/
class OOX_DLLPUBLIC PropertySet
{
public:
PropertySet() {}
/** Constructs a property set wrapper with the passed UNO property set. */
explicit PropertySet(
const css::uno::Reference< css::beans::XPropertySet >& rxPropSet )
{ set( rxPropSet ); }
/** Constructs a property set wrapper after querying the XPropertySet interface. */
template< typename Type >
explicit PropertySet( const Type& rObject ) { set( rObject ); }
/** Sets the passed UNO property set and releases the old UNO property set. */
void set( const css::uno::Reference< css::beans::XPropertySet >& rxPropSet );
/** Queries the passed object (interface or any) for an XPropertySet and releases the old UNO property set. */
template< typename Type >
void set( const Type& rObject )
{ set( css::uno::Reference< css::beans::XPropertySet >( rObject, css::uno::UNO_QUERY ) ); }
/** Returns true, if the contained XPropertySet interface is valid. */
bool is() const { return mxPropSet.is(); }
/** Returns true, if the specified property is supported by the property set. */
bool hasProperty( sal_Int32 nPropId ) const;
// Get properties ---------------------------------------------------------
/** Gets the specified property from the property set.
@return the property value, or an empty Any, if the property is missing. */
css::uno::Any getAnyProperty( sal_Int32 nPropId ) 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 >
bool getProperty( Type& orValue, sal_Int32 nPropId ) const
{ return getAnyProperty( nPropId ) >>= orValue; }
/** Gets the specified boolean property from the property set.
@return true = property contains true; false = property contains false or error occurred. */
bool getBoolProperty( sal_Int32 nPropId ) const
{ bool bValue = false; return getProperty( bValue, nPropId ) && bValue; }
// Set properties ---------------------------------------------------------
/** Puts the passed any into the property set. */
bool setAnyProperty( sal_Int32 nPropId, const css::uno::Any& rValue );
/** Puts the passed value into the property set. */
template< typename Type >
bool setProperty( sal_Int32 nPropId, const Type& rValue )
{ return setAnyProperty( nPropId, css::uno::Any( rValue ) ); }
bool setProperty( sal_Int32 nPropId, ::Color rValue )
{ return setAnyProperty( nPropId, css::uno::Any( rValue ) ); }
/** 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 css::uno::Sequence< OUString >& rPropNames,
const css::uno::Sequence< css::uno::Any >& rValues );
/** Puts the passed property map into the property set. Tries to use the XMultiPropertySet interface.
@param rPropertyMap The property map. */
void setProperties( const PropertyMap& rPropertyMap );
#ifdef DBG_UTIL
void dump();
#endif
private:
/** Gets the specified property from the property set.
@return true, if the any could be filled with the property value. */
bool implGetPropertyValue( css::uno::Any& orValue, const OUString& rPropName ) const;
/** Puts the passed any into the property set. */
bool implSetPropertyValue( const OUString& rPropName, const css::uno::Any& rValue );
private:
css::uno::Reference< css::beans::XPropertySet >
mxPropSet; ///< The mandatory property set interface.
css::uno::Reference< css::beans::XMultiPropertySet >
mxMultiPropSet; ///< The optional multi property set interface.
css::uno::Reference< css::beans::XPropertySetInfo >
mxPropSetInfo; ///< Property information.
};
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
