AOO410/main/offapi/com/sun/star/configuration/HierarchyElement.idl

/**************************************************************
 * 
 * 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_HierarchyElement_idl__
#define __com_sun_star_configuration_HierarchyElement_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_container_XHierarchicalName_idl__
#include <com/sun/star/container/XHierarchicalName.idl>
#endif

#ifndef __com_sun_star_beans_XProperty_idl__
#include <com/sun/star/beans/XProperty.idl>
#endif

#ifndef __com_sun_star_beans_XPropertyWithState_idl__
#include <com/sun/star/beans/XPropertyWithState.idl>
#endif

#ifndef __com_sun_star_container_XChild_idl__
#include <com/sun/star/container/XChild.idl>
#endif

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

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

//=============================================================================
/** provides information about an element within a hierarchy.

 <p>The local name and the full hierarchical name can be retrieved.
 Attributes detailing the role of the element can be queried.
 The state of the element (regarding defaults) can be accessed.
 </p>
	
 <p>Implementations of this service usually also implement
 service <type>HierarchyAccess</type>, which concerns the complementary role
 of providing access to subelements of the hierarchy.
 </p>
*/
published service HierarchyElement
{
/** provides the complete hierarchical name of this element
 within the hierarchy tree.
*/
	interface com::sun::star::container::XHierarchicalName;

/** provides the local name of this element within its parent. 

 <p><em>Renaming an element is generally not supported.</em></p>
*/
	interface com::sun::star::container::XNamed;

/** provides a property descriptor for this element.[optional]

 <p>This interface may be missing, if the hierarchy supports no traits that are
 described by <type scope="com::sun::star::beans">PropertyAttribute</type>
 values.
 </p>

 <p>If the parent of this object implements 
 <type scope="com::sun::star::beans">XPropertySetInfo</type>, then this returns
 the same <type scope="com::sun::star::beans">Property</type> as the
 <type scope="com::sun::star::beans">XPropertySetInfo</type> of the parent.
 </p>
*/
	[optional] interface com::sun::star::beans::XProperty;

/** provides access to the default state of this element. [optional]

 <p>This interface may be missing, if the hierarchy supports access to
 a default state and values only for simple values or not at all.
 </p>

 <p>If the parent of this object implements 
 <type scope="com::sun::star::beans">XPropertyState</type>, then members
 of this interface have the same effect as corresponding members of the parent.
 </p>

 <p>If an implementation is part of a <em>read-only</em> view of the hierarchy,
 attempts to change property states will fail.
 </p>
*/
	[optional] interface com::sun::star::beans::XPropertyWithState;

/** provides access to the parent of this element [optional]. 

 <p>This interface may be missing if this object is not obtained 
 as a child or descendant of another tree node, for example, directly from a factory or provider.
 </p>

 <p><member scope="com::sun::star::container">XChild::getParent()</member>
 returns NULL, if this object is currently not contained in another node.
 </p>

 <p><em>Setting a different parent is, generally, not supported.</em></p>
*/
	[optional] interface com::sun::star::container::XChild;

};

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

}; }; }; }; 

#endif