summaryrefslogtreecommitdiff
path: root/configmgr/source/api2/elementaccess.hxx
blob: 8bf73774a2eafed76da070898008e8f4df2f5d21 (plain)
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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: elementaccess.hxx,v $
 * $Revision: 1.6 $
 *
 * 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 CONFIGMGR_API_ELEMENTACCESS_HXX_
#define CONFIGMGR_API_ELEMENTACCESS_HXX_

#include <com/sun/star/container/XChild.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/configuration/XTemplateInstance.hpp>
#include <com/sun/star/lang/XLocalizable.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/util/XChangesNotifier.hpp>
#include <com/sun/star/util/XChangesBatch.hpp>
#include <cppuhelper/implbase3.hxx>
#include <cppuhelper/implbase5.hxx>
#include <cppuhelper/implbase6.hxx>

namespace configmgr
{
//-----------------------------------------------------------------------------
    namespace css = ::com::sun::star;
    namespace uno = ::com::sun::star::uno;

//-----------------------------------------------------------------------------
    namespace configapi 
    { 
        class NodeAccess; 
        class InnerElement;
        class SetElement;
        class RootElement;
        class UpdateRootElement;
    }
//-----------------------------------------------------------------------------

    /** implements the interfaces supported by a inner node
        within the configuration tree that is a plain node (group member).
        <p> Is an interface adapter around 
            <type scope='configmgr::configapi'>NodeAccess</type> and
            <type scope='configmgr::configapi'>InnerElement</type>.</p>
    */
    class BasicInnerElement : public cppu::WeakImplHelper3< css::container::XChild, css::container::XNamed, css::lang::XServiceInfo >
    {
    protected:
    // Destructors
        virtual ~BasicInnerElement() {}

    public:
    // Interface methods
        // XInterface ('dispose' management) - partial implementation
        virtual void SAL_CALL acquire() throw();
        virtual void SAL_CALL release() throw();

        // XTypeProvider (from implhelper) - partial implementation
        virtual uno::Sequence<sal_Int8> SAL_CALL 
            getImplementationId(  ) 
                throw(uno::RuntimeException);

        // XChild
        virtual uno::Reference< uno::XInterface > SAL_CALL 
            getParent(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL // not supported
            setParent( const uno::Reference< uno::XInterface >& Parent ) 
                throw(css::lang::NoSupportException, css::uno::RuntimeException);

        // XNamed
        virtual rtl::OUString SAL_CALL 
            getName(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL  // not supported (! - missing exception)
            setName( const rtl::OUString& aName ) 
                throw(uno::RuntimeException);

        // XServiceInfo
        virtual rtl::OUString SAL_CALL 
            getImplementationName(  ) 
                throw(uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            supportsService( const rtl::OUString& ServiceName ) 
                throw(uno::RuntimeException);

        virtual uno::Sequence< rtl::OUString > SAL_CALL 
            getSupportedServiceNames(  ) 
                throw(uno::RuntimeException);
    
    protected:
        virtual configapi::InnerElement& getElementClass() = 0;
        virtual configapi::NodeAccess& getNodeAccess() = 0;
    };
//-----------------------------------------------------------------------------

    /** implements the interfaces supported by a node
        within the configuration tree that is a set element (or floating free).
        <p> Is an interface adapter around 
            <type scope='configmgr::configapi'>NodeAccess</type> and
            <type scope='configmgr::configapi'>SetElement</type>.</p>
    */
    class BasicSetElement : public cppu::WeakImplHelper6< css::container::XChild, css::container::XNamed, css::lang::XComponent, css::lang::XServiceInfo, css::configuration::XTemplateInstance, css::lang::XUnoTunnel >
    {
    protected:
    // Destructors
        virtual ~BasicSetElement() {}

    public:
    // Interface methods
        // XInterface ('dispose' management) - partial implementation
        virtual void SAL_CALL acquire() throw();
        virtual void SAL_CALL release() throw();

        // XTypeProvider (from implhelper) - partial implementation
        virtual uno::Sequence<sal_Int8> SAL_CALL 
            getImplementationId(  ) 
                throw(uno::RuntimeException);

        // XChild
        virtual uno::Reference< uno::XInterface > SAL_CALL 
            getParent(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL // currently not supported
            setParent( const uno::Reference< uno::XInterface >& Parent ) 
                throw(css::lang::NoSupportException, css::uno::RuntimeException);

        // XNamed
        virtual rtl::OUString SAL_CALL 
            getName(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL  // generally not supported (! - missing exception)
            setName( const rtl::OUString& aName ) 
                throw(uno::RuntimeException);

        // XComponent
        virtual void SAL_CALL 
            dispose(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            addEventListener( const uno::Reference< css::lang::XEventListener >& xListener ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            removeEventListener( const uno::Reference< css::lang::XEventListener >& aListener ) 
                throw(uno::RuntimeException);

        // XServiceInfo
        virtual rtl::OUString SAL_CALL 
            getImplementationName(  ) 
                throw(uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            supportsService( const rtl::OUString& ServiceName ) 
                throw(uno::RuntimeException);

        virtual uno::Sequence< rtl::OUString > SAL_CALL 
            getSupportedServiceNames(  ) 
                throw(uno::RuntimeException);
    
        // XTemplateInstance
        virtual rtl::OUString SAL_CALL 
            getTemplateName( )
                throw(uno::RuntimeException);

        // XUnoTunnel
        virtual sal_Int64 SAL_CALL 
            getSomething( const uno::Sequence< sal_Int8 >& aIdentifier ) 
                throw(uno::RuntimeException);

    protected:
        virtual configapi::SetElement& getElementClass() = 0;
        virtual configapi::NodeAccess& getNodeAccess() = 0;
    };
//-----------------------------------------------------------------------------

    /** implements the interfaces supported by a node
        within the configuration that is the root of a read-only access
        <p> Is an interface adapter around 
            <type scope='configmgr::configapi'>NodeAccess</type> and
            <type scope='configmgr::configapi'>SetElement</type>.</p>
    */
    class BasicRootElement : public cppu::WeakImplHelper5< css::container::XNamed, css::util::XChangesNotifier, css::lang::XComponent, css::lang::XServiceInfo, css::lang::XLocalizable >
    {
    protected:
    // Destructors
        virtual ~BasicRootElement() {}

    public:
    // Interface methods
        // XInterface ('dispose' management) - partial implementation
        virtual void SAL_CALL acquire() throw();
        virtual void SAL_CALL release() throw();

        // XTypeProvider (from implhelper) - partial implementation
        virtual uno::Sequence<sal_Int8> SAL_CALL 
            getImplementationId(  ) 
                throw(uno::RuntimeException);

        // XNamed
        virtual rtl::OUString SAL_CALL 
            getName(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL  // generally not supported (! - missing exception)
            setName( const rtl::OUString& aName ) 
                throw(uno::RuntimeException);

        // XChangesNotifier
        virtual void SAL_CALL 
            addChangesListener( const uno::Reference< css::util::XChangesListener >& xListener ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            removeChangesListener( const uno::Reference< css::util::XChangesListener >& xListener ) 
                throw(uno::RuntimeException);

        // XComponent
        virtual void SAL_CALL 
            dispose(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            addEventListener( const uno::Reference< css::lang::XEventListener >& xListener ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            removeEventListener( const uno::Reference< css::lang::XEventListener >& aListener ) 
                throw(uno::RuntimeException);

        // XServiceInfo
        virtual rtl::OUString SAL_CALL 
            getImplementationName(  ) 
                throw(uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            supportsService( const rtl::OUString& ServiceName ) 
                throw(uno::RuntimeException);

        virtual uno::Sequence< rtl::OUString > SAL_CALL 
            getSupportedServiceNames(  ) 
                throw(uno::RuntimeException);
    
        // XLocalizable
        virtual css::lang::Locale SAL_CALL 
            getLocale(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL   // maybe not supported (! - missing exception)
            setLocale( const css::lang::Locale& eLocale ) 
                throw(uno::RuntimeException);

    protected:
        virtual configapi::RootElement& getElementClass() = 0;
        virtual configapi::NodeAccess& getNodeAccess() = 0;
    };
//-----------------------------------------------------------------------------

    /** implements the interfaces supported by a node
        within the configuration that is the root of an update access
        <p> Is an interface adapter around 
            <type scope='configmgr::configapi'>NodeAccess</type> and
            <type scope='configmgr::configapi'>SetElement</type>.</p>
    */
    class BasicUpdateElement : public cppu::WeakImplHelper6< css::container::XNamed, css::util::XChangesNotifier, css::lang::XComponent, css::lang::XServiceInfo, css::lang::XLocalizable, css::util::XChangesBatch >
    {
    protected:
    // Destructors
        virtual ~BasicUpdateElement() {}

    public:
    // Interface methods
        // XInterface ('dispose' management) - partial implementation
        virtual void SAL_CALL acquire() throw();
        virtual void SAL_CALL release() throw();

        // XTypeProvider (from implhelper) - partial implementation
        virtual uno::Sequence<sal_Int8> SAL_CALL 
            getImplementationId(  ) 
                throw(uno::RuntimeException);

        // XNamed
        virtual rtl::OUString SAL_CALL 
            getName(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL  // generally not supported (! - missing exception)
            setName( const rtl::OUString& aName ) 
                throw(uno::RuntimeException);

        // XChangesNotifier
        virtual void SAL_CALL 
            addChangesListener( const uno::Reference< css::util::XChangesListener >& xListener ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            removeChangesListener( const uno::Reference< css::util::XChangesListener >& xListener ) 
                throw(uno::RuntimeException);

        // XComponent
        virtual void SAL_CALL 
            dispose(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            addEventListener( const uno::Reference< css::lang::XEventListener >& xListener ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            removeEventListener( const uno::Reference< css::lang::XEventListener >& aListener ) 
                throw(uno::RuntimeException);

        // XServiceInfo
        virtual rtl::OUString SAL_CALL 
            getImplementationName(  ) 
                throw(uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            supportsService( const rtl::OUString& ServiceName ) 
                throw(uno::RuntimeException);

        virtual uno::Sequence< rtl::OUString > SAL_CALL 
            getSupportedServiceNames(  ) 
                throw(uno::RuntimeException);
    
        // XChangesBatch
        virtual void SAL_CALL 
            commitChanges(  ) 
                throw(css::lang::WrappedTargetException, uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            hasPendingChanges(  ) 
                throw(uno::RuntimeException);

        virtual uno::Sequence< css::util::ElementChange > SAL_CALL 
            getPendingChanges(  ) 
                throw(uno::RuntimeException);

        // XLocalizable
        virtual css::lang::Locale SAL_CALL 
            getLocale(  ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL    // maybe not supported (! - missing exception)
            setLocale( const css::lang::Locale& eLocale ) 
                throw(uno::RuntimeException);

    protected:
        virtual configapi::UpdateRootElement& getElementClass() = 0;
        virtual configapi::NodeAccess& getNodeAccess() = 0;
    };
//-----------------------------------------------------------------------------
}
#endif // CONFIGMGR_API_ELEMENTACCESS_HXX_