xref: /aoo42x/main/offapi/com/sun/star/configuration/PropertyHierarchy.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_configuration_PropertyHierarchy_idl__
#define __com_sun_star_configuration_PropertyHierarchy_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
#include <com/sun/star/beans/XMultiPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_XHierarchicalPropertySet_idl__
#include <com/sun/star/beans/XHierarchicalPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_XMultiHierarchicalPropertySet_idl__
#include <com/sun/star/beans/XMultiHierarchicalPropertySet.idl>
#endif

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

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

//=============================================================================
/** provides access to and information about properties and subproperties
 of an implementation.

 <p>Properties in a property set may be full-fledged objects that have
 properties themselves (and so on recursively), thereby forming a hierarchy
 of properties. This service describes such a hierarchy, and allows
 direct access even to subproperties.
 </p>

 @see com::sun::star::beans::XProperty
 Properties of an implementation that are objects themselves will often
 implement <type scope="com::sun::star::beans">XProperty</type> to allow
 direct access to information about the object.
 If such objects have properties of their own, they should fully implement
 <type>PropertyHierarchy</type> again.
*/
published service PropertyHierarchy
{
/** provides access to and information about the immediate properties of an implementation.
*/
	interface com::sun::star::beans::XPropertySet;

/** provides access to and information about the immediate properties
 of an implementation.

 <p>This interface allows retrieving or setting multiple properties at once.
 Accesses are guaranteed to occur as single atomic operations even if
 multiple threads are accessing the object simultaneously.
 </p>
*/
	interface com::sun::star::beans::XMultiPropertySet;

/** provides access to and information about the whole hierarchy
 of properties and subproperties of an implementation.
*/
	interface com::sun::star::beans::XHierarchicalPropertySet;

/** provides access to and information about the whole hierarchy
 of properties and subproperties of an implementation.

 <p>This interface allows retrieving or setting multiple properties at once.
 Accesses are guaranteed to occur as single atomic operations even if
 multiple threads are accessing the object simultaneously.
 </p>
*/
	interface com::sun::star::beans::XMultiHierarchicalPropertySet;

};

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

}; }; }; };

#endif