1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XLayerContentDescriber.idl,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
31 #define __com_sun_star_configuration_backend_XLayerContentDescriber_idl__
33 #ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__
34 #include
<com
/sun
/star
/configuration
/backend
/PropertyInfo.idl
>
37 #ifndef __com_sun_star_uno_XInterface_idl__
38 #include
<com
/sun
/star
/uno
/XInterface.idl
>
41 #ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__
42 #include
<com
/sun
/star
/configuration
/backend
/XLayerHandler.idl
>
45 #ifndef __com_sun_star_lang_NullPointerException_idl__
46 #include
<com
/sun
/star
/lang
/NullPointerException.idl
>
49 #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
50 #include
<com
/sun
/star
/configuration
/backend
/MalformedDataException.idl
>
53 //=============================================================================
55 module com
{ module sun
{ module star
{ module configuration
{ module backend
{
57 //=============================================================================
60 describe the contents of a layer to an XLayerHander object. The contents of
61 the layer is contained in the sequence of PropertyInfo structures
65 interface XLayerContentDescriber
: ::com
::sun
::star
::uno
::XInterface
67 //-------------------------------------------------------------------------
70 describes the contents of the layer to an <type>XLayerHandler</type>.
73 Handler object that will receive calls
74 describing the contents of the layer
77 sequence of PropertyInfo structs contained
78 all required property information
80 @throws com::sun::star::lang::NullPointerException
81 if a <NULL/> handler is passed.
82 @throws com::sun::star::configuration::backend::MalformedDataException
83 if the data read from the layer is rejected as invalid by the
84 <type>XLayerHandler</type>.
86 void describeLayer
([in] XLayerHandler aHandler
,
87 [in] sequence
<PropertyInfo
> aPropertyInfos
)
88 raises
(com
::sun
::star
::lang
::NullPointerException
,
89 com
::sun
::star
::lang
::WrappedTargetException
,
90 MalformedDataException
) ;
92 //-------------------------------------------------------------------------
95 //=============================================================================