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_XMutableTreeDataModel_idl__
28#define __com_sun_star_awt_tree_XMutableTreeDataModel_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_tree_XMutableTreeNode_idl__
35#include <com/sun/star/awt/tree/XMutableTreeNode.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module awt {  module tree {
41
42//=============================================================================
43
44/** This is the editable version of the <type>XTreeDataModel</type>.
45
46    <p>Note that only <type>XTreeNode</type> created from the same instance with <member>createNode</member>
47    are valids nodes for this instance.</p>
48 */
49published interface XMutableTreeDataModel : XTreeDataModel
50{
51    /** creates a new tree node with the given value and given settings.
52
53        @param DisplayValue
54            should be convertable to a string and is used by the <type>XTreeControl</type>
55            as a textual represenation of the created node.
56
57        @param ChildrenOnDemand
58            if <TRUE/> is used as a parameter, the created node will be treated as a non-leaf
59            node by the <type>XTreeControl</type>, even when it has no child nodes.
60
61        @returns
62            a new <type>XMutableTreeNode</type> that can be used for this model.
63
64        @see XTreeNode::getDisplayValue()
65        @see XTreeNode::hasChildrenOnDemand()
66    */
67    XMutableTreeNode createNode( [in] any DisplayValue, [in] boolean ChildrenOnDemand );
68
69    /** changes the root node of this model to <var>RootNode</var>.
70
71        @param RootNode
72            the <type>XMutableTreeNode</type> that becomes the new root node of this model.
73
74        @throws ::com::sun::star::lang::IllegalArgumentException
75            if <var>RootNode</var> is not a valid node of this <type>XTreeDataModel</type>.
76    */
77    void setRoot( [in] XMutableTreeNode RootNode )
78        raises( ::com::sun::star::lang::IllegalArgumentException );
79};
80
81//=============================================================================
82
83}; }; }; }; };
84
85#endif
86