diff options
Diffstat (limited to 'offapi/com/sun/star/awt/tree/XMutableTreeNode.idl')
-rw-r--r-- | offapi/com/sun/star/awt/tree/XMutableTreeNode.idl | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl new file mode 100644 index 000000000..72529350a --- /dev/null +++ b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl @@ -0,0 +1,109 @@ +/* -*- 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_XMutableTreeNode_idl__ +#define __com_sun_star_awt_tree_XMutableTreeNode_idl__ + +#include <com/sun/star/awt/tree/XTreeNode.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> + + +module com { module sun { module star { module awt { module tree { + + +/** Represents a mutable tree node as used by the MutableTreeDataModel + */ +interface XMutableTreeNode : XTreeNode +{ + /** appends <var>ChildNode</var> to this instance. + + @throws ::com::sun::star::lang::IllegalArgumentException + if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel. + */ + void appendChild( [in] XMutableTreeNode ChildNode ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** inserts <var>ChildNode</var> to this instance at the given index. + + @param Index + the index where the node will be inserted to this instance. + + @param ChildNode + the node to insert. + + @throws ::com::sun::star::lang::IllegalArgumentException + if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <var>Index</var> is less than 0 or greater than XTreeNode::getChildCount(). + */ + void insertChildByIndex( [in] long Index, [in] XMutableTreeNode ChildNode ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::lang::IndexOutOfBoundsException ); + + /** removes the node from this instance at the specified index. + + @param Index + the index of the node to be removed from this instance. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <var>Index</var> is less than 0 or greater than XTreeNode::getChildCount(). + */ + void removeChildByIndex( [in] long Index ) + raises( com::sun::star::lang::IndexOutOfBoundsException ); + + /** Changes if the children of this node are created on demand. + + @see XTreeNode::hasChildrenOnDemand() + */ + void setHasChildrenOnDemand( [in] boolean ChildrenOnDemand ); + + /** sets the display value of this node */ + void setDisplayValue( [in] any Value ); + + /** Stores an implementation dependent value. + + <p>You can use this attribute to store data for this node that + is independent of the display value</p> + */ + [attribute] any DataValue; + + /** The URL for a graphic that is rendered before the text part of this node. + <p>If this URL is empty, no graphic is rendered. + */ + void setNodeGraphicURL( [in] string URL ); + + /** The URL for a graphic that is rendered to visualize expanded non leaf nodes. + <p>If <var>URL</var> is empty, XTreeControl::DefaultExpandedGraphicURL is used. + */ + void setExpandedGraphicURL( [in] string URL ); + + /** The URL for a graphic that is rendered to visualize collapsed non leaf nodes. + <p>If <var>URL</var> is empty, XTreeControl::DefaultCollapsedGraphicURL is used. + */ + void setCollapsedGraphicURL( [in] string URL ); +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |