xref: /trunk/main/offapi/com/sun/star/awt/tree/TreeControlModel.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_awt_tree_TreeControlModel_idl__
#define __com_sun_star_awt_tree_TreeControlModel_idl__

#ifndef __com_sun_star_awt_tree_XTreeDataModel_idl__
#include <com/sun/star/awt/tree/XTreeDataModel.idl>
#endif

#ifndef __com_sun_star_awt_UnoControlModel_idl__
#include <com/sun/star/awt/UnoControlModel.idl>
#endif

#ifndef __com_sun_star_view_SelectionType_idl__
#include <com/sun/star/view/SelectionType.idl>
#endif

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

module com {  module sun {  module star {  module awt { module tree {

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

/** specifies the standard model of a <type>TreeControl</type>.
 */
service TreeControlModel
{
	/** specifies the standard model of an <type scope="com::sun::star::awt">UnoControl</type>. */
	service ::com::sun::star::awt::UnoControlModel;

	/** Specifies the selection mode that is enabled for this tree.
		<p>The default value is <member scope="com::sun::star::view">SelectionType::NONE</member></p>
	*/
	[property] ::com::sun::star::view::SelectionType SelectionType;

	/**	Specifies the <type>XTreeDataModel</type> that is providing the hierarchical data.

		<p>You can implement your own instance of <type>XTreeDataModel</type> or use
		the <type>MutableTreeDataModel</type>.
	*/
	[property] XTreeDataModel DataModel;

	/** Specifies if the root node of the tree is displayed.
		<p>If <var>RootDisplayed</var> is set to <FALSE/>, the root node of a model is no longer
		a valid node for the <type>XTreeControl</type> and can't be used with any method of
		<type>XTreeControl</type>.
		<p>The default value is <TRUE/></p>
	*/
	[property] boolean RootDisplayed;

	/** Specifies whether the node handles should be displayed.
		<p>The handles are doted lines that visualize the tree like hirarchie<p>
		<p>The default value is <TRUE/></p>
	*/
	[property] boolean ShowsHandles;

	/** Specifies whether the node handles should also be displayed at root level.
		<p>The default value is <TRUE/></p>
	*/
	[property] boolean ShowsRootHandles;

	/** Specifies the height of each row, in pixels.
		<p>If the specified value is less than or equal to zero, the row height is the maximum height
		of all rows.</p>
		<p>The default value is 0</p>
	*/
	[property] long RowHeight;

	/** Specifies whether the nodes of the tree are editable.
		<p>The default value is <FALSE/></p>

		@see XTreeControl::startEditingAtNode()
		@see XTreeEditListener
	*/
	[property] boolean Editable;

	/**	Specifies what happens when editing is interrupted by selecting another node in the tree,
		a change in the tree's data, or by some other means.
		<p>Setting this property to <TRUE/> causes the changes to be automatically saved when editing
		is interrupted. <FALSE/> means that editing is canceled and changes are lost
		<p>The default value is <FALSE/></p>
	*/
	[property] boolean InvokesStopNodeEditing;
};

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

}; }; }; }; };

#endif