summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/configuration/backend/CopyImporter.idl
blob: 68bfae8e7ddb061c9efb7fa7f0dc22d54800cd0e (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
/* -*- 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 __com_sun_star_configuration_backend_CopyImporter_idl__
#define __com_sun_star_configuration_backend_CopyImporter_idl__

#include <com/sun/star/configuration/backend/Importer.idl>
#include <com/sun/star/lang/XInitialization.idl>


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


/**
    imports data into a configuration layer by copying over existing data.


    @since OOo 1.1.2
*/
published service CopyImporter
{

    /** allows importing configuration data into a backend.

        <p> In this implementation, the changes are copied over any
            XLayer data that already exists in the Backend,
            replacing it completely.
        </p>
      */
    service Importer ;


    /** allows initializing the implementation with settings that control
        its behavior .

        <p> This interface, which is optional in Importer
            is mandatory in this service and supports the following arguments
            which must be provided as
            com::sun::star::beans::NamedValue:
        <dl>
            <dt><code>Overwrite</code> : `boolean`</dt>
            <dd>If `FALSE`, specifies that the data should be applied
                only if the existing layer is empty.
            </dd>
        </dl>
        </p>
      */
    interface com::sun::star::lang::XInitialization ;

} ;


} ; } ; } ; } ; } ;

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */