summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl
blob: 355ab485f85432843903c08b4a1387128acc40f5 (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
/* -*- 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_XLayerContentDescriber_idl__
#define __com_sun_star_configuration_backend_XLayerContentDescriber_idl__

#include <com/sun/star/configuration/backend/PropertyInfo.idl>
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/configuration/backend/XLayerHandler.idl>
#include <com/sun/star/lang/NullPointerException.idl>
#include <com/sun/star/configuration/backend/MalformedDataException.idl>


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


/**
   describe the contents of a layer to an XLayerHandler object. The contents of
   the layer is contained in the sequence of PropertyInfo structures
   @see PropertyInfo

*/
interface XLayerContentDescriber : ::com::sun::star::uno::XInterface
{

    /**
      describes the contents of the layer to an XLayerHandler.

      @param aHandler
            Handler object that will receive calls
            describing the contents of the layer

      @param aPropertyInfos
             sequence of PropertyInfo structs contained
             all required property information

      @throws com::sun::star::lang::NullPointerException
              if a `NULL` handler is passed.
      @throws com::sun::star::configuration::backend::MalformedDataException
              if the data read from the layer is rejected as invalid by the
              XLayerHandler.
    */
    void describeLayer([in] XLayerHandler aHandler,
                       [in] sequence<PropertyInfo> aPropertyInfos)
        raises (com::sun::star::lang::NullPointerException,
                com::sun::star::lang::WrappedTargetException,
                MalformedDataException) ;

} ;


} ; } ; } ; } ; } ;
#endif

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