/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#ifndef __com_sun_star_awt_tree_XMutableTreeDataModel_idl__
#define __com_sun_star_awt_tree_XMutableTreeDataModel_idl__

#include <com/sun/star/awt/tree/XTreeDataModel.idl>
#include <com/sun/star/awt/tree/XMutableTreeNode.idl>


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


/** This is the editable version of the XTreeDataModel.

    <p>Note that only XTreeNode created from the same instance with createNode()
    are valid nodes for this instance.</p>
 */
interface XMutableTreeDataModel : XTreeDataModel
{
    /** creates a new tree node with the given value and given settings.

        @param DisplayValue
            should be convertible to a string and is used by the XTreeControl
            as a textual representation of the created node.

        @param ChildrenOnDemand
            if `TRUE` is used as a parameter, the created node will be treated as a non-leaf
            node by the XTreeControl, even when it has no child nodes.

        @returns
            a new XMutableTreeNode that can be used for this model.

        @see XTreeNode::getDisplayValue()
        @see XTreeNode::hasChildrenOnDemand()
    */
    XMutableTreeNode createNode( [in] any DisplayValue, [in] boolean ChildrenOnDemand );

    /** changes the root node of this model to <var>RootNode</var>.

        @param RootNode
            the XMutableTreeNode that becomes the new root node of this model.

        @throws ::com::sun::star::lang::IllegalArgumentException
            if <var>RootNode</var> is not a valid node of this XTreeDataModel.
    */
    void setRoot( [in] XMutableTreeNode RootNode )
        raises( ::com::sun::star::lang::IllegalArgumentException );
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
