LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | Public Attributes | List of all members
XMutableTreeNode Interface Reference

Represents a mutable tree node as used by the MutableTreeDataModel. More...

import"XMutableTreeNode.idl";

Inheritance diagram for XMutableTreeNode:
XTreeNode MutableTreeNode

Public Member Functions

void appendChild ([in] XMutableTreeNode ChildNode) raises ( com::sun::star::lang::IllegalArgumentException )
 appends ChildNode to this instance. More...
 
void insertChildByIndex ([in] long Index, [in] XMutableTreeNode ChildNode) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IndexOutOfBoundsException )
 inserts ChildNode to this instance at the given index. More...
 
void removeChildByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 removes the node from this instance at the specified index. More...
 
void setHasChildrenOnDemand ([in] boolean ChildrenOnDemand)
 Changes if the children of this node are created on demand. More...
 
void setDisplayValue ([in] any Value)
 sets the display value of this node More...
 
void setNodeGraphicURL ([in] string URL)
 The URL for a graphic that is rendered before the text part of this node. More...
 
void setExpandedGraphicURL ([in] string URL)
 The URL for a graphic that is rendered to visualize expanded non leaf nodes. More...
 
void setCollapsedGraphicURL ([in] string URL)
 The URL for a graphic that is rendered to visualize collapsed non leaf nodes. More...
 
- Public Member Functions inherited from XTreeNode
XTreeNode getChildAt ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns the child tree node at Index. More...
 
long getChildCount ()
 Returns the number of child nodes. More...
 
XTreeNode getParent ()
 Returns the parent node of this node. More...
 
long getIndex ([in] XTreeNode Node)
 Returns the index of Node in this instances children. More...
 
boolean hasChildrenOnDemand ()
 Returns TRUE if the children of this node are created on demand. More...
 
any getDisplayValue ()
 If not empty, the textual representation of this any is used as the text part of this node. More...
 
string getNodeGraphicURL ()
 The URL for a graphic that is rendered before the text part of this node. More...
 
string getExpandedGraphicURL ()
 The URL for a graphic that is rendered to visualize expanded non leaf nodes. More...
 
string getCollapsedGraphicURL ()
 The URL for a graphic that is rendered to visualize collapsed non leaf nodes. More...
 

Public Attributes

any DataValue
 Stores an implementation dependent value. More...
 

Detailed Description

Represents a mutable tree node as used by the MutableTreeDataModel.

Member Function Documentation

void appendChild ( [in] XMutableTreeNode  ChildNode)
raises (com::sun::star::lang::IllegalArgumentException
)

appends ChildNode to this instance.

Exceptions
com::sun::star::lang::IllegalArgumentExceptionif ChildNode is not a valid node of the corresponding XTreeDataModel.
void insertChildByIndex ( [in] long  Index,
[in] XMutableTreeNode  ChildNode 
)
raises ( com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::IndexOutOfBoundsException
)

inserts ChildNode to this instance at the given index.

Parameters
Indexthe index where the node will be inserted to this instance.
ChildNodethe node to insert.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif ChildNode is not a valid node of the corresponding XTreeDataModel.
com::sun::star::lang::IndexOutOfBoundsExceptionif Index is less than 0 or greater then XTreeNode::getChildCount().
void removeChildByIndex ( [in] long  Index)
raises (com::sun::star::lang::IndexOutOfBoundsException
)

removes the node from this instance at the specified index.

Parameters
Indexthe index of the node to be removed from this instance.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif Index is less than 0 or greater then XTreeNode::getChildCount().
void setCollapsedGraphicURL ( [in] string  URL)

The URL for a graphic that is rendered to visualize collapsed non leaf nodes.

If URL is empty, XTreeControl::DefaultCollapsedGraphicURL is used.

void setDisplayValue ( [in] any  Value)

sets the display value of this node

void setExpandedGraphicURL ( [in] string  URL)

The URL for a graphic that is rendered to visualize expanded non leaf nodes.

If URL is empty, XTreeControl::DefaultExpandedGraphicURL is used.

void setHasChildrenOnDemand ( [in] boolean  ChildrenOnDemand)

Changes if the children of this node are created on demand.

See also
XTreeNode::hasChildrenOnDemand()
void setNodeGraphicURL ( [in] string  URL)

The URL for a graphic that is rendered before the text part of this node.

If this URL is empty, no graphic is rendered.

Member Data Documentation

any DataValue
attribute

Stores an implementation dependent value.

You can use this attribute to store data for this node that is independent of the display value


The documentation for this interface was generated from the following file: