1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_tree_XTreeDataModel_idl__
24#define __com_sun_star_awt_tree_XTreeDataModel_idl__
25
26#ifndef __com_sun_star_awt_tree_XTreeDataModelListener_idl__
27#include <com/sun/star/awt/tree/XTreeDataModelListener.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_XComponent_idl__
35#include <com/sun/star/lang/XComponent.idl>
36#endif
37
38#ifndef __com_sun_star_awt_tree_XTreeNode_idl__
39#include <com/sun/star/awt/tree/XTreeNode.idl>
40#endif
41
42//=============================================================================
43
44module com {  module sun {  module star {  module awt {  module tree {
45
46//=============================================================================
47
48/** An instance of this interface is used by the <type>TreeControl</type> to
49    retrieve the hierarchical outline data that is displayed in the actual control.
50
51    <p>If you implement your own <type>XTreeDataModel</type> you need to notify registered
52    <type>XTreeDataModelListener</type> if your model changes after the control is created.
53    If this is not done correctly the <type>TreeControl</type> will not update the data properly.</p>
54
55    If you do not need your own model implementation, you can also use the <type>MutableTreeDataModel</type>.
56*/
57published interface XTreeDataModel : ::com::sun::star::lang::XComponent
58{
59    /** Returns the root of the tree.
60        <p>Returns null only if the tree has no nodes.
61
62        @returns
63            the root of the tree
64    */
65    XTreeNode getRoot();
66
67    /** Adds a listener for the <type>TreeDataModelEvent</type> posted after the tree changes.
68
69        @param Listener
70            the listener to add.
71    */
72    void addTreeDataModelListener( [in] XTreeDataModelListener Listener );
73
74
75    /** Removes a listener previously added with <method>addTreeDataModelListener()</method>.
76
77        @param Listener
78            the listener to remove.
79    */
80    void removeTreeDataModelListener( [in] XTreeDataModelListener Listener );
81
82};
83
84//=============================================================================
85
86}; }; }; }; };
87
88#endif
89