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

An instance of this interface is used by the TreeControl to retrieve the hierarchical outline data that is displayed in the actual control. More...

import"XTreeDataModel.idl";

Inheritance diagram for XTreeDataModel:
XComponent XInterface XMutableTreeDataModel MutableTreeDataModel

Public Member Functions

XTreeNode getRoot ()
 Returns the root of the tree. More...
 
void addTreeDataModelListener ([in] XTreeDataModelListener Listener)
 Adds a listener for the TreeDataModelEvent posted after the tree changes. More...
 
void removeTreeDataModelListener ([in] XTreeDataModelListener Listener)
 Removes a listener previously added with addTreeDataModelListener(). More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

An instance of this interface is used by the TreeControl to retrieve the hierarchical outline data that is displayed in the actual control.

If you implement your own XTreeDataModel you need to notify registered XTreeDataModelListener if your model changes after the control is created. If this is not done correctly the TreeControl will not update the data properly.

If you do not need your own model implementation, you can also use the MutableTreeDataModel.

Member Function Documentation

void addTreeDataModelListener ( [in] XTreeDataModelListener  Listener)

Adds a listener for the TreeDataModelEvent posted after the tree changes.

Parameters
Listenerthe listener to add.
XTreeNode getRoot ( )

Returns the root of the tree.

Returns null only if the tree has no nodes.

Returns
the root of the tree
void removeTreeDataModelListener ( [in] XTreeDataModelListener  Listener)

Removes a listener previously added with addTreeDataModelListener().

Parameters
Listenerthe listener to remove.

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