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
|
/*************************************************************************
*
* $RCSfile: ItemConverter.hxx,v $
*
* $Revision: 1.6 $
*
* last change: $Author: bm $ $Date: 2003-11-04 13:09:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2003 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CHART_ITEMCONVERTER_HXX
#define CHART_ITEMCONVERTER_HXX
#ifndef _UNOTOOLS_EVENTLISTENERADAPTER_HXX_
#include <unotools/eventlisteneradapter.hxx>
#endif
#ifndef _SFXITEMPOOL_HXX
#include <svtools/itempool.hxx>
#endif
#ifndef _SFXITEMSET_HXX
#include <svtools/itemset.hxx>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
class SfxItemPropertyMap;
namespace comphelper
{
/** This class serves for conversion between properties of an XPropertySet and
SfxItems in SfxItemSets.
With this helper classes, you can feed dialogs with XPropertySets and let
those modify by the dialogs.
You must implement GetWhichPairs() such that an SfxItemSet created with
CreateEmptyItemSet() is able to hold all items that may be mapped.
You also have to implement GetItemPropertyName(), in order to return the
property name for a given which-id.
FillSpecialItem and ApplySpecialItem may be used for special handling of
individual item, e.g. if you need member-ids in QueryValue/PutValue
A typical use could be the following:
::comphelper::ChartTypeItemConverter aItemConverter( xPropertySet, GetItemPool() );
SfxItemSet aItemSet = aItemConverter.CreateEmptyItemSet();
aItemConverter.FillItemSet( aItemSet );
bool bChanged = false;
MyDialog aDlg( aItemSet );
if( aDlg.Execute() == RET_OK )
{
const SfxItemSet* pOutItemSet = aDlg.GetOutputItemSet();
if( pOutItemSet )
bChanged = aItemConverter.ApplyItemSet( *pOutItemSet );
}
if( bChanged )
{
[ apply model changes to view ]
}
*/
class ItemConverter :
public ::utl::OEventListenerAdapter
{
public:
/** Construct an item converter that uses the given property set for
reading/writing converted items
*/
ItemConverter(
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet > & rPropertySet ,
SfxItemPool& rItemPool );
virtual ~ItemConverter();
/** applies all properties that can be mapped to items into the given item
set.
Call this method before opening a dialog.
@param rOutItemSet
the SfxItemSet is filled with all items that are a result of a
conversion from a property of the internal XPropertySet.
*/
virtual void FillItemSet( SfxItemSet & rOutItemSet ) const;
/** applies all properties that are results of a conversion from all items
in rItemSet to the internal XPropertySet.
Call this method after a dialog was closed with OK
@return true, if any properties have been changed, false otherwise.
*/
virtual bool ApplyItemSet( const SfxItemSet & rItemSet );
/** creates an empty item set using the given pool or a common pool if empty
(see GetItemPool) and allowing all items given in the ranges returned by
GetWhichPairs.
*/
SfxItemSet CreateEmptyItemSet() const;
/** States whether conversion is still likely to work.
In particular, it is checked if the XPropertySet given in the CTOR is
still valid, i.e. not disposed. It is assumed that the XPropertySet is
valid when the converter is constructed.
This only works if the XPropertySet given in the CTOR supports the
interface ::com::sun::star::lang::XComponent.
*/
bool IsValid() const;
/** Invalidates all items in rDestSet, that are set (state SFX_ITEM_SET) in
both item sets (rDestSet and rSourceSet) and have differing content.
*/
static void InvalidateUnequalItems( SfxItemSet &rDestSet, const SfxItemSet &rSourceSet );
protected:
// ________
/** implement this method to provide an array of which-ranges of the form:
const USHORT aMyPairs[] =
{
from_1, to_1,
from_2, to_2,
...
from_n, to_n,
0
};
*/
virtual const USHORT * GetWhichPairs() const = 0;
/** implement this method to return a Property object for a given which id.
@param rOutName
If true is returned, this contains the property name.
@return true, if the item can be mapped to a property.
*/
virtual bool GetItemPropertyName( USHORT nWhichId, ::rtl::OUString & rOutName ) const = 0;
/** for items that can not be mapped directly to a property.
This method is called from FillItemSet(), if GetItemPropertyName() returns
false.
The default implementation does nothing except showing an assertion
*/
virtual void FillSpecialItem( USHORT nWhichId, SfxItemSet & rOutItemSet ) const
throw( ::com::sun::star::uno::Exception );
/** for items that can not be mapped directly to a property.
This method is called from ApplyItemSet(), if GetItemPropertyName() returns
false.
The default implementation returns just false and shows an assertion
@return true if the item changed a property, false otherwise.
*/
virtual bool ApplySpecialItem( USHORT nWhichId, const SfxItemSet & rItemSet )
throw( ::com::sun::star::uno::Exception );
// ________
/// Returns the pool
SfxItemPool & GetItemPool() const;
/** Returns the XPropertySet that was given in the CTOR and is used to apply
items in ApplyItemSet().
*/
::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet > GetPropertySet() const;
// ____ ::utl::OEventListenerAdapter ____
virtual void _disposing( const ::com::sun::star::lang::EventObject& _rSource );
private:
::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet > m_xPropertySet;
::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySetInfo > m_xPropertySetInfo;
SfxItemPool& m_rItemPool;
bool m_bIsValid;
};
} // namespace comphelper
// CHART_ITEMCONVERTER_HXX
#endif
|
