summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/configuration/backend/Schema.idl
blob: 58bad6f0019a8057f22dd82b716336a39a311b02 (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_Schema_idl__
#define __com_sun_star_configuration_backend_Schema_idl__

#include <com/sun/star/configuration/backend/XSchema.idl>


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


/**
  provides read only access to a configuration component schema.

  <p>A component is a set of hierarchically organized and semantically
  related configuration settings, e.g StarWriter settings.
  </p>
  <p>A component schema contains two separate sections, one which
  describes the templates to be used in the dynamic containers (sets) of
  the component and one which describes the component's data structure.
  </p>

  @see com::sun::star::configuration::backend::Layer
        Service providing access to individual
        configuration data for an entity.

  @since OOo 1.1.2
  */
published service Schema
{

    /**
      handles access to the schema data for a component.
      <p>The data can be read either in its entirety (templates and component
      description) or each of its parts can be accessed.
      </p>
      */
    interface XSchema ;


    /**
      The URL of the layer data.

      @since OOo 2.0
      */
    [property,optional,readonly] string URL ;

} ;


} ; } ; } ; } ; } ;

#endif

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