1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_tree_TreeControlModel_idl__
28#define __com_sun_star_awt_tree_TreeControlModel_idl__
29
30#ifndef __com_sun_star_awt_tree_XTreeDataModel_idl__
31#include <com/sun/star/awt/tree/XTreeDataModel.idl>
32#endif
33
34#ifndef __com_sun_star_awt_UnoControlModel_idl__
35#include <com/sun/star/awt/UnoControlModel.idl>
36#endif
37
38#ifndef __com_sun_star_view_SelectionType_idl__
39#include <com/sun/star/view/SelectionType.idl>
40#endif
41
42//=============================================================================
43
44module com {  module sun {  module star {  module awt { module tree {
45
46//=============================================================================
47
48/** specifies the standard model of a <type>TreeControl</type>.
49 */
50service TreeControlModel
51{
52	/** specifies the standard model of an <type scope="com::sun::star::awt">UnoControl</type>. */
53	service ::com::sun::star::awt::UnoControlModel;
54
55	/** Specifies the selection mode that is enabled for this tree.
56		<p>The default value is <member scope="com::sun::star::view">SelectionType::NONE</member></p>
57	*/
58	[property] ::com::sun::star::view::SelectionType SelectionType;
59
60	/**	Specifies the <type>XTreeDataModel</type> that is providing the hierarchical data.
61
62		<p>You can implement your own instance of <type>XTreeDataModel</type> or use
63		the <type>MutableTreeDataModel</type>.
64	*/
65	[property] XTreeDataModel DataModel;
66
67	/** Specifies if the root node of the tree is displayed.
68		<p>If <var>RootDisplayed</var> is set to <FALSE/>, the root node of a model is no longer
69		a valid node for the <type>XTreeControl</type> and can't be used with any method of
70		<type>XTreeControl</type>.
71		<p>The default value is <TRUE/></p>
72	*/
73	[property] boolean RootDisplayed;
74
75	/** Specifies whether the node handles should be displayed.
76		<p>The handles are doted lines that visualize the tree like hirarchie<p>
77		<p>The default value is <TRUE/></p>
78	*/
79	[property] boolean ShowsHandles;
80
81	/** Specifies whether the node handles should also be displayed at root level.
82		<p>The default value is <TRUE/></p>
83	*/
84	[property] boolean ShowsRootHandles;
85
86	/** Specifies the height of each row, in pixels.
87		<p>If the specified value is less than or equal to zero, the row height is the maximum height
88		of all rows.</p>
89		<p>The default value is 0</p>
90	*/
91	[property] long RowHeight;
92
93	/** Specifies whether the nodes of the tree are editable.
94		<p>The default value is <FALSE/></p>
95
96		@see XTreeControl::startEditingAtNode()
97		@see XTreeEditListener
98	*/
99	[property] boolean Editable;
100
101	/**	Specifies what happens when editing is interrupted by selecting another node in the tree,
102		a change in the tree's data, or by some other means.
103		<p>Setting this property to <TRUE/> causes the changes to be automatically saved when editing
104		is interrupted. <FALSE/> means that editing is canceled and changes are lost
105		<p>The default value is <FALSE/></p>
106	*/
107	[property] boolean InvokesStopNodeEditing;
108};
109
110//=============================================================================
111
112}; }; }; }; };
113
114#endif
115