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_XTreeDataModel_idl__
28#define __com_sun_star_awt_tree_XTreeDataModel_idl__
29
30#ifndef __com_sun_star_awt_tree_XTreeDataModelListener_idl__
31#include <com/sun/star/awt/tree/XTreeDataModelListener.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_XComponent_idl__
39#include <com/sun/star/lang/XComponent.idl>
40#endif
41
42#ifndef __com_sun_star_awt_tree_XTreeNode_idl__
43#include <com/sun/star/awt/tree/XTreeNode.idl>
44#endif
45
46//=============================================================================
47
48module com {  module sun {  module star {  module awt {  module tree {
49
50//=============================================================================
51
52/** An instance of this interface is used by the <type>TreeControl</type> to
53    retrieve the hierarchical outline data that is displayed in the actual control.
54
55    <p>If you implement your own <type>XTreeDataModel</type> you need to notify registered
56    <type>XTreeDataModelListener</type> if your model changes after the control is created.
57    If this is not done correctly the <type>TreeControl</type> will not update the data properly.</p>
58
59    If you do not need your own model implementation, you can also use the <type>MutableTreeDataModel</type>.
60*/
61published interface XTreeDataModel : ::com::sun::star::lang::XComponent
62{
63    /** Returns the root of the tree.
64        <p>Returns null only if the tree has no nodes.
65
66        @returns
67            the root of the tree
68    */
69    XTreeNode getRoot();
70
71    /** Adds a listener for the <type>TreeDataModelEvent</type> posted after the tree changes.
72
73        @param Listener
74            the listener to add.
75    */
76    void addTreeDataModelListener( [in] XTreeDataModelListener Listener );
77
78
79    /** Removes a listener previously added with <method>addTreeDataModelListener()</method>.
80
81        @param Listener
82            the listener to remove.
83    */
84    void removeTreeDataModelListener( [in] XTreeDataModelListener Listener );
85
86};
87
88//=============================================================================
89
90}; }; }; }; };
91
92#endif
93