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
|
/* -*- 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 .
*/
#pragma once
// helper classes
#include <cppuhelper/propshlp.hxx>
// interfaces and types
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/beans/XMultiPropertyStates.hpp>
#include <com/sun/star/style/XStyleSupplier.hpp>
#include "charttoolsdllapi.hxx"
#include <map>
namespace property
{
class OOO_DLLPUBLIC_CHARTTOOLS OPropertySet :
public ::cppu::OBroadcastHelper,
// includes beans::XPropertySet, XMultiPropertySet and XFastPropertySet
public ::cppu::OPropertySetHelper,
// includes uno::XWeak (and XInterface, esp. ref-counting)
public css::lang::XTypeProvider,
public css::beans::XPropertyState,
public css::beans::XMultiPropertyStates,
public css::style::XStyleSupplier
{
public:
OPropertySet( ::osl::Mutex & rMutex );
virtual ~OPropertySet();
protected:
explicit OPropertySet( const OPropertySet & rOther, ::osl::Mutex & rMutex );
void SetNewValuesExplicitlyEvenIfTheyEqualDefault();
/** implement this method to provide default values for all properties
supporting defaults. If a property does not have a default value, you
may throw an UnknownPropertyException.
We pass the any by reference because this code is very hot and doing
it this way is cheaper than the two step process of constructing a new
any and then assigning to via a return value.
@throws css::beans::UnknownPropertyException
@throws css::uno::RuntimeException
*/
virtual void GetDefaultValue( sal_Int32 nHandle, css::uno::Any& rAny ) const = 0;
/** The InfoHelper table contains all property names and types of
this object.
@return the object that provides information for the
PropertySetInfo
@see ::cppu::OPropertySetHelper
*/
virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper() override = 0;
/** Try to convert the value <code>rValue</code> to the type required by the
property associated with <code>nHandle</code>.
Override this method to take influence in modification of properties.
If the conversion changed , </sal_True> is returned and the converted value
is in <code>rConvertedValue</code>. The former value is contained in
<code>rOldValue</code>.
After this call returns successfully, the vetoable listeners are
notified.
@throws IllegalArgumentException, if the conversion was not successful,
or if there is no corresponding property to the given handle.
@param rConvertedValue the converted value. Only set if return is true.
@param rOldValue the old value. Only set if return is true.
@param nHandle the handle of the property.
@return true, if the conversion was successful and converted value
differs from the old value.
@see ::cppu::OPropertySetHelper
*/
virtual sal_Bool SAL_CALL convertFastPropertyValue
( css::uno::Any & rConvertedValue,
css::uno::Any & rOldValue,
sal_Int32 nHandle,
const css::uno::Any& rValue ) override;
/** The same as setFastPropertyValue; nHandle is always valid.
The changes must not be broadcasted in this method.
@attention
Although you are permitted to throw any UNO exception, only the following
are valid for usage:
-- css::beans::UnknownPropertyException
-- css::beans::PropertyVetoException
-- css::lang::IllegalArgumentException
-- css::lang::WrappedTargetException
-- css::uno::RuntimeException
@param nHandle handle
@param rValue value
@see ::cppu::OPropertySetHelper
*/
virtual void SAL_CALL setFastPropertyValue_NoBroadcast
( sal_Int32 nHandle,
const css::uno::Any& rValue ) override;
/**
The same as getFastPropertyValue, but return the value through rValue and
nHandle is always valid.
@see ::cppu::OPropertySetHelper
*/
virtual void SAL_CALL getFastPropertyValue
( css::uno::Any& rValue,
sal_Int32 nHandle ) const override;
/// make original interface function visible again
using ::com::sun::star::beans::XFastPropertySet::getFastPropertyValue;
/** implement this method in derived classes to get called when properties
change.
*/
virtual void firePropertyChangeEvent();
public:
// Interfaces
// ____ XInterface ____
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
// ____ XTypeProvider ____
virtual css::uno::Sequence< css::uno::Type > SAL_CALL
getTypes() override;
virtual css::uno::Sequence< sal_Int8 > SAL_CALL
getImplementationId() override;
// ____ XPropertyState ____
virtual css::beans::PropertyState SAL_CALL
getPropertyState( const OUString& PropertyName ) override;
virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL
getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
virtual void SAL_CALL
setPropertyToDefault( const OUString& PropertyName ) override;
virtual css::uno::Any SAL_CALL
getPropertyDefault( const OUString& aPropertyName ) override;
// ____ XMultiPropertyStates ____
// Note: getPropertyStates() is already implemented in XPropertyState with the
// same signature
virtual void SAL_CALL
setAllPropertiesToDefault() override;
virtual void SAL_CALL
setPropertiesToDefault( const css::uno::Sequence< OUString >& aPropertyNames ) override;
virtual css::uno::Sequence< css::uno::Any > SAL_CALL
getPropertyDefaults( const css::uno::Sequence< OUString >& aPropertyNames ) override;
// ____ XStyleSupplier ____
virtual css::uno::Reference< css::style::XStyle > SAL_CALL getStyle() override;
virtual void SAL_CALL setStyle( const css::uno::Reference< css::style::XStyle >& xStyle ) override;
// ____ XMultiPropertySet ____
virtual void SAL_CALL setPropertyValues(
const css::uno::Sequence< OUString >& PropertyNames,
const css::uno::Sequence< css::uno::Any >& Values ) override;
// ____ XFastPropertySet ____
virtual void SAL_CALL setFastPropertyValue( sal_Int32 nHandle, const css::uno::Any& rValue ) override;
// Note: it is assumed that the base class implements setPropertyValue by
// using setFastPropertyValue
private:
/** supports states DIRECT_VALUE and DEFAULT_VALUE
*/
css::beans::PropertyState
GetPropertyStateByHandle( sal_Int32 nHandle ) const;
css::uno::Sequence< css::beans::PropertyState >
GetPropertyStatesByHandle( const std::vector< sal_Int32 > & aHandles ) const;
void SetPropertyToDefault( sal_Int32 nHandle );
void SetPropertiesToDefault( const std::vector< sal_Int32 > & aHandles );
void SetAllPropertiesToDefault();
/** @param rValue is set to the value for the property given in nHandle. If
the property is not set, the style chain is searched for any
instance set there. If there was no value found either in the
property set itself or any of its styles, rValue remains
unchanged and false is returned.
@return false if the property is default, true otherwise.
*/
bool GetPropertyValueByHandle(
css::uno::Any & rValue,
sal_Int32 nHandle ) const;
void SetPropertyValueByHandle( sal_Int32 nHandle,
const css::uno::Any & rValue );
bool SetStyle( const css::uno::Reference< css::style::XStyle > & xStyle );
/// reference to mutex of class deriving from here
::osl::Mutex & m_rMutex;
bool m_bSetNewValuesExplicitlyEvenIfTheyEqualDefault;
typedef std::map< sal_Int32, css::uno::Any > tPropertyMap;
tPropertyMap m_aProperties;
css::uno::Reference< css::style::XStyle > m_xStyle;
};
} // namespace property
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
