summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/DefaultProvider.idl
blob: 73a0b3504cb9d18d45a6bbf77946257c871b913b (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
/*************************************************************************
 *
 * 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: DefaultProvider.idl,v $
 * $Revision: 1.9 $
 *
 * 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 __com_sun_star_configuration_DefaultProvider_idl__
#define __com_sun_star_configuration_DefaultProvider_idl__

#ifndef __com_sun_star_configuration_ConfigurationProvider_idl__
#include <com/sun/star/configuration/ConfigurationProvider.idl>
#endif

#ifndef __com_sun_star_util_XRefreshable_idl__
#include <com/sun/star/util/XRefreshable.idl>
#endif

#ifndef __com_sun_star_util_XFlushable_idl__
#include <com/sun/star/util/XFlushable.idl>
#endif

#ifndef __com_sun_star_lang_XLocalizable_idl__
#include <com/sun/star/lang/XLocalizable.idl>
#endif


//=============================================================================

module com { module sun { module star { module configuration {

//=============================================================================

/**
    is a <type>ConfigurationProvider</type>, that is
    the default <type>ConfigurationProvider</type> for its
    <type scope="com::sun::star::uno">XComponentContext</type>.

    <p>This object is accessible as singleton within the context</p>.

    @since OOo 1.1.2
*/
published service DefaultProvider
{
    //-------------------------------------------------------------------------

    /** characterizes the functionality.
      */
    service ConfigurationProvider ;

    /**Provides refresh capabilities, data can be refreshed from the backend(s) into
       the in-memory cache.
    */
    [optional] interface com::sun::star::util::XRefreshable;

    /** Enables the data to be flushed from the in-memory cache to the backend(s).
     */
    [optional] interface com::sun::star::util::XFlushable;

    /** Enable setting/getting locale for Provider

        @since OOo 2.0.0
     */

    [optional] interface com::sun::star::lang::XLocalizable;

    /** Property to enable/disable asynchronous write-back from in-memory cache to backend(s)

        @since OOo 2.0.0
     */

    [optional,property] boolean EnableAsync;

    //-------------------------------------------------------------------------
} ;

//=============================================================================

} ; } ; } ; } ;

#endif