diff options
Diffstat (limited to 'offapi/com/sun/star/awt/tree')
| -rw-r--r-- | offapi/com/sun/star/awt/tree/ExpandVetoException.idl | 53 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl | 50 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/MutableTreeNode.idl | 48 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/TreeControl.idl | 95 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/TreeControlModel.idl | 106 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl | 63 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/TreeExpansionEvent.idl | 54 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl | 80 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XMutableTreeNode.idl | 115 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeControl.idl | 284 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeDataModel.idl | 81 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl | 91 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeEditListener.idl | 81 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl | 85 | ||||
| -rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeNode.idl | 100 |
15 files changed, 0 insertions, 1386 deletions
diff --git a/offapi/com/sun/star/awt/tree/ExpandVetoException.idl b/offapi/com/sun/star/awt/tree/ExpandVetoException.idl deleted file mode 100644 index 70c2b5dd0..000000000 --- a/offapi/com/sun/star/awt/tree/ExpandVetoException.idl +++ /dev/null @@ -1,53 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_ExpandVetoException_idl__ -#define __com_sun_star_awt_tree_ExpandVetoException_idl__ - -#include <com/sun/star/util/VetoException.idl> -#include <com/sun/star/awt/tree/TreeExpansionEvent.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** Exception used to stop an expand/collapse from happening. - @see XTreeExpansionListener - @see XTreeControl - */ -published exception ExpandVetoException : com::sun::star::util::VetoException -{ - /** The event that the exception was created for. */ - TreeExpansionEvent Event; -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl b/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl deleted file mode 100644 index ad8bff90a..000000000 --- a/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl +++ /dev/null @@ -1,50 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_MutableTreeDataModel_idl__ -#define __com_sun_star_awt_tree_MutableTreeDataModel_idl__ - -#include <com/sun/star/awt/tree/XMutableTreeDataModel.idl> -#include <com/sun/star/awt/tree/XMutableTreeNode.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** If you do not want to implement the <type>XTreeDataModel</type> yourself, use this service. - This implementation uses <type>MutableTreeNode</type> for its nodes. - */ -published service MutableTreeDataModel : XMutableTreeDataModel -{ -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/MutableTreeNode.idl b/offapi/com/sun/star/awt/tree/MutableTreeNode.idl deleted file mode 100644 index ebd818893..000000000 --- a/offapi/com/sun/star/awt/tree/MutableTreeNode.idl +++ /dev/null @@ -1,48 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_MutableTreeNode_idl__ -#define __com_sun_star_awt_tree_MutableTreeNode_idl__ - -#include <com/sun/star/awt/tree/XMutableTreeNode.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** Represents an editable tree node as used by the <type>MutableTreeDataModel</type> - */ -service MutableTreeNode : XMutableTreeNode -{ -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/TreeControl.idl b/offapi/com/sun/star/awt/tree/TreeControl.idl deleted file mode 100644 index 8ac2cd0d9..000000000 --- a/offapi/com/sun/star/awt/tree/TreeControl.idl +++ /dev/null @@ -1,95 +0,0 @@ -/************************************************************************ - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_TreeControl_idl__ -#define __com_sun_star_awt_tree_TreeControl_idl__ - -#include <com/sun/star/awt/tree/XTreeControl.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** A control that displays a set of hierarchical data as an outline. - - <p> - <h4>The Data Model</h4> - <p>A specific node in a tree is identified by a <type>XTreeNode</type>. - A leaf node is a node without any children and that returns <FALSE/> when calling <member>XTreeNode::hasChildrenOnDemand()</member>. - An expanded node is a non-leaf node that will displays its children when all its ancestors are expanded. - A collapsed node is one which hides them. - A node is visible when all parent nodes are expanded and the node itself is in the display area. - </p> - - <p>The nodes are retrieved from a <type>XTreeDataModel</type>. - You can implement it yourself or use the <type>MutableTreeDataModel</type> - which uses <type>XMutableTreeNode</type> and <type>XMutableTreeDataModel</type> - for a simple and mutable data model. - - <p>The data model must be set at the <member>TreeControlModel::TreeDataModel</member> property.</p> - - <h4>Selection</h4> - <p>If you are interested in knowing when the selection changes implement a - <type scope="com::sun::star::view">XSelectionChangeListener</type> and add the instance with the method - <member scope="::com::sun::star::view">XSelectionSupplier::addSelectionChangeListener()</member>. - You than will be notified for any selection change. - </p> - - <p> - If you are interested in detecting either double-click events or when a user clicks on a node, - regardless of whether or not it was selected, you can get the <type scope="com::sun::star::awt">XWindow</type> - and add yourself as a <type scope="com::sun::star::awt">XMouseClickHandler</type>. You can use the - method <member>XTreeControl::getNodeForLocation()</member> to retrieve the node that was under the - mouse at the time the event was fired. - </p> - - <h4>Adding child nodes on demand</h4> - <p>If you want to add child nodes to your tree on demand you can do the following. - <ul> - <li>Make sure the parent node returns <TRUE/> for <member>XTreeNode::hasChildrenOnDemand()</member> either - by implementing <type>XTreeNode</type> yourself or if you use the <type>MutableTreeDataModel</type>, - use <member>XMutableTreeNode::setHasChildrenOnDemand()</member>.</li> - <li>Implement a <type>XTreeExpansionListener</type> and add the instance with the method - <member>XTreeControl::addTreeExpansionListener()</member>.</li> - </ul> - Now you get called when the node will become expanded or collapsed. - So on <member>XTreeExpansionListener::treeExpanding()</member> you can - check the <type>TreeExpansionEvent</type> if the parent node with children on demand is going to - be expanded and in that case add the missing child nodes. You can also veto the expansion or - collapsing of a parent node by using the <type>ExpandVetoException</type>. - </p> - */ -service TreeControl: XTreeControl -{ -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/TreeControlModel.idl b/offapi/com/sun/star/awt/tree/TreeControlModel.idl deleted file mode 100644 index be04fdb8a..000000000 --- a/offapi/com/sun/star/awt/tree/TreeControlModel.idl +++ /dev/null @@ -1,106 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_TreeControlModel_idl__ -#define __com_sun_star_awt_tree_TreeControlModel_idl__ - -#include <com/sun/star/awt/tree/XTreeDataModel.idl> -#include <com/sun/star/awt/UnoControlModel.idl> -#include <com/sun/star/view/SelectionType.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** specifies the standard model of a <type>TreeControl</type>. - */ -service TreeControlModel -{ - /** specifies the standard model of an <type scope="com::sun::star::awt">UnoControl</type>. */ - service ::com::sun::star::awt::UnoControlModel; - - /** Specifies the selection mode that is enabled for this tree. - <p>The default value is <member scope="com::sun::star::view">SelectionType::NONE</member></p> - */ - [property] ::com::sun::star::view::SelectionType SelectionType; - - /** Specifies the <type>XTreeDataModel</type> that is providing the hierarchical data. - - <p>You can implement your own instance of <type>XTreeDataModel</type> or use - the <type>MutableTreeDataModel</type>. - */ - [property] XTreeDataModel DataModel; - - /** Specifies if the root node of the tree is displayed. - <p>If <var>RootDisplayed</var> is set to <FALSE/>, the root node of a model is no longer - a valid node for the <type>XTreeControl</type> and can't be used with any method of - <type>XTreeControl</type>. - <p>The default value is <TRUE/></p> - */ - [property] boolean RootDisplayed; - - /** Specifies whether the node handles should be displayed. - <p>The handles are doted lines that visualize the tree like hierarchy<p> - <p>The default value is <TRUE/></p> - */ - [property] boolean ShowsHandles; - - /** Specifies whether the node handles should also be displayed at root level. - <p>The default value is <TRUE/></p> - */ - [property] boolean ShowsRootHandles; - - /** Specifies the height of each row, in pixels. - <p>If the specified value is less than or equal to zero, the row height is the maximum height - of all rows.</p> - <p>The default value is 0</p> - */ - [property] long RowHeight; - - /** Specifies whether the nodes of the tree are editable. - <p>The default value is <FALSE/></p> - - @see XTreeControl::startEditingAtNode() - @see XTreeEditListener - */ - [property] boolean Editable; - - /** Specifies what happens when editing is interrupted by selecting another node in the tree, - a change in the tree's data, or by some other means. - <p>Setting this property to <TRUE/> causes the changes to be automatically saved when editing - is interrupted. <FALSE/> means that editing is canceled and changes are lost - <p>The default value is <FALSE/></p> - */ - [property] boolean InvokesStopNodeEditing; -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl b/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl deleted file mode 100644 index d26730191..000000000 --- a/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl +++ /dev/null @@ -1,63 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_TreeDataModelEvent_idl__ -#define __com_sun_star_awt_tree_TreeDataModelEvent_idl__ - -#include <com/sun/star/lang/EventObject.idl> -#include <com/sun/star/awt/tree/XTreeNode.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** An event used by a <type>XTreeDataModel</type> to notify changes in the data - model to the <type>XTreeControl</type>. - You usually need to fill this event only if you implement the <type>XTreeDataModel</type> - yourself. - - @see XTreeDataModel - @see XTreeControl - @see XTreeDataModelListener - */ -published struct TreeDataModelEvent : ::com::sun::star::lang::EventObject -{ - /** contains the changed, added or removed nodes. - <p> All nodes must have <member>ParentNode</member> as parent. */ - sequence< XTreeNode > Nodes; - - /** holds the parent node for changed, added or removed nodes. - <p> If this is null, <member>Nodes</member> must contain only the root node */ - XTreeNode ParentNode; -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/TreeExpansionEvent.idl b/offapi/com/sun/star/awt/tree/TreeExpansionEvent.idl deleted file mode 100644 index c30a531ab..000000000 --- a/offapi/com/sun/star/awt/tree/TreeExpansionEvent.idl +++ /dev/null @@ -1,54 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_TreeExpansionEvent_idl__ -#define __com_sun_star_awt_tree_TreeExpansionEvent_idl__ - -#include <com/sun/star/lang/EventObject.idl> -#include <com/sun/star/awt/tree/XTreeNode.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** This event tells you what node is currently expanding or collapsing. - - @see XTreeExpansionListener - @see XTreeControl - */ -published struct TreeExpansionEvent : ::com::sun::star::lang::EventObject -{ - /* The node that has been expanded/collapsed.*/ - com::sun::star::awt::tree::XTreeNode Node; -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl deleted file mode 100644 index 0651234b5..000000000 --- a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl +++ /dev/null @@ -1,80 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#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 <type>XTreeDataModel</type>. - - <p>Note that only <type>XTreeNode</type> created from the same instance with <member>createNode</member> - are valid nodes for this instance.</p> - */ -published 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 <type>XTreeControl</type> - 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 <type>XTreeControl</type>, even when it has no child nodes. - - @returns - a new <type>XMutableTreeNode</type> 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 <type>XMutableTreeNode</type> 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 <type>XTreeDataModel</type>. - */ - void setRoot( [in] XMutableTreeNode RootNode ) - raises( ::com::sun::star::lang::IllegalArgumentException ); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl deleted file mode 100644 index 065f52b79..000000000 --- a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl +++ /dev/null @@ -1,115 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#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 <type>MutableTreeDataModel</type> - */ -published 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 <type>XTreeDataModel</type>. - */ - 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. - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>ChildNode</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - - @throws ::com::sun::star::lang::IndexOutOfBoundsException - if <var>Index</var> is less than 0 or greater then <member>XTreeNode::getChildCount()</member>. - */ - 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 then <member>XTreeNode::getChildCount()</member>. - */ - 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, <member>XTreeControl::DefaultExpandedGraphicURL</member> 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, <member>XTreeControl::DefaultCollapsedGraphicURL</member> is used. - */ - void setCollapsedGraphicURL( [in] string URL ); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XTreeControl.idl b/offapi/com/sun/star/awt/tree/XTreeControl.idl deleted file mode 100644 index 57ae438d6..000000000 --- a/offapi/com/sun/star/awt/tree/XTreeControl.idl +++ /dev/null @@ -1,284 +0,0 @@ -/************************************************************************ - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_XTreeControl_idl__ -#define __com_sun_star_awt_tree_XTreeControl_idl__ - -#include <com/sun/star/awt/XControl.idl> -#include <com/sun/star/awt/tree/XTreeExpansionListener.idl> -#include <com/sun/star/view/XMultiSelectionSupplier.idl> -#include <com/sun/star/awt/tree/XTreeEditListener.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** An interface to a control that displays a set of hierarchical data as an outline. - - @see TreeControl - */ -published interface XTreeControl -{ - /** This interfaces provides access to the selection of tree nodes for this control. - - <p>valid selection values for this interface are - <type>XTreeNode</type> or sequence<<type>XTreeNode</type>>.</p> - - <method scope="::com::sun::star::view">XSelectionSupplier::getSelection()</method> - returns an empty any for no selection, an any with <type>XTreeNode</type> for - a single selection and a sequence<<type>XTreeNode</type>> for a multiselection. - */ - interface ::com::sun::star::view::XMultiSelectionSupplier; - - // ---------------------------- - // expanding/collapsing/visible - // ---------------------------- - - /** Returns <TRUE/> if <var>Node</var> is currently expanded. - - @param Node - the <type>XTreeNode</type> specifying the node to check. - - @returns - <FALSE/> if <var>Node</var> or at least one of its parent nodes are collapsed, - <TRUE/> if <var>Node</var> and all of its parent nodes are expanded. - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - */ - boolean isNodeExpanded( [in] XTreeNode Node ) - raises( ::com::sun::star::lang::IllegalArgumentException ); - - /** Returns <TRUE/> if <var>Node</var> is currently collapsed. - - @param Node - the <type>XTreeNode</type> specifying the node to check - - @returns - <TRUE/> if <var>Node</var> or at least one of its parent nodes are collapsed, - <FALSE/> if <var>Node</var> and all of its parent nodes are expanded - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - */ - boolean isNodeCollapsed( [in] XTreeNode Node ) - raises( ::com::sun::star::lang::IllegalArgumentException ); - - /** Ensures that <var>Node</var> is currently visible. - <p>This includes expanding all parent nodes and scroll the control so this - node is visible in the controls display area.</p> - - @param Node - the <type>XTreeNode</type> specifying the node to make visible. - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - - @throws ExpandVetoException - if <var>Node</var>can't be made visible since at least one of the parent nodes are - collapsed and expanding failed because at least one of the registered - <type>XTreeExpansionListener</type> raised a <type>ExpandVetoException</type>. - */ - void makeNodeVisible( [in] XTreeNode Node ) - raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); - - /** Returns <TRUE/> if <var>Node</var> is currently visible. - <p>Visible means it is either the root or all of its parents are expanded.</p> - - @returns - <TRUE/> if <var>Node</var> is visible, otherwise <FALSE/> - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - */ - boolean isNodeVisible( [in] XTreeNode Node ) - raises( com::sun::star::lang::IllegalArgumentException ); - - /** Ensures that <var>Node</var> is expanded and visible. - <p>If <var>Node</var> is a leaf node, this will have no effect.</p> - - @param Node - the <type>XTreeNode</type> identifying a node. - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - - @throws ExpandVetoException - if expanding <var>Node</var> failed because at least one of the registered - <type>XTreeExpansionListener</type> raised a <type>ExpandVetoException</type>. - */ - void expandNode( [in] XTreeNode Node ) - raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); - - /** Ensures that <var>Node</var> is collapsed. - - @param Node - the <type>XTreeNode</type> identifying a node - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - - @throws ExpandVetoException - if collapsing <var>Node</var> failed because at least one of the registered - <type>XTreeExpansionListener</type> raised a <type>ExpandVetoException</type>. - */ - void collapseNode( [in] XTreeNode Node ) - raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); - - /** Adds a listener for <type>TreeExpansion</type> events. - - @param Listener - a <type>XTreeExpansionListener</type> that will be notified when a tree - node is expanded or collapsed. - */ - void addTreeExpansionListener( [in] XTreeExpansionListener Listener ); - - /** Removes a listener for <type>TreeExpansion</type> events. - - @param Listener - the <type>XTreeExpansionListener</type> to remove. - */ - void removeTreeExpansionListener( [in] XTreeExpansionListener Listener ); - - /** If the given URL points to a loadable graphic, the graphic is rendered - before expanded non leaf nodes. - - <p>This can be overridden for individual nodes by <member>XTreeNode::getExpandedGraphicURL()</member></p> - */ - [attribute] string DefaultExpandedGraphicURL; - - /** If the given URL points to a loadable graphic, the graphic is rendered - before collapsed non leaf nodes. - - <p>This can be overridden for individual nodes by <member>XTreeNode::getCollapsedGraphicURL()</member></p> - */ - [attribute] string DefaultCollapsedGraphicURL; - - // ------------ - // tree geometry - // ------------ - - /** Returns the node at the specified location. - - @param x - an integer giving the number of pixels horizontally from the left edge of the controls display area - @param y - an integer giving the number of pixels vertically from the top edge of the controls display area - @returns - the <type>XTreeNode</type> for the node at that location, or 0 if there is no node at the given position - */ - XTreeNode getNodeForLocation( [in] long x, [in] long y ); - - /** Returns the node that is closest to x,y. - <p>If no nodes are currently viewable, or there is no model, returns null, - otherwise it always returns a valid node. To test if the node is exactly - at x, y, use <member>getNodeForLocation()</member>. - - @param x - an integer giving the number of pixels horizontally from the left edge of the controls display area - @para y - an integer giving the number of pixels vertically from the top edge of the controls display area - @returns - the <type>XTreeNode</type> for the node closest to that location, null if nothing is viewable or there is no model - */ - XTreeNode getClosestNodeForLocation( [in] long x, [in] long y ); - - /** returns the rectangle occupied by the visual representation of the given node - - @param Node - the node whose geometry should be obtained - @throws ::com::sun::star::lang::IllegalArgumentException - if the given node is <NULL/>, or does not belong to the tree's data model - */ - ::com::sun::star::awt::Rectangle - getNodeRect( [in] XTreeNode Node ) - raises( ::com::sun::star::lang::IllegalArgumentException ); - - // ------------ - // tree editing - // ------------ - - /** Returns <TRUE/> if one of tree's nodes is being currently edited. - <p>The node that is being edited can be obtained using <method scope="com::sun::star::view">XSelectionSupplier::getSelection()</method>. - - @returns - <TRUE/> if the user is currently editing a node - */ - boolean isEditing(); - - /** Ends the current editing session. - <p>All registered <type>XTreeEditListener</type> are notified if an editing session was in progress</p> - <p>Has no effect if the tree isn't being edited.</p> - - @returns - <TRUE/> if editing was in progress and is now stopped, <FALSE/> if editing was not in progress - */ - boolean stopEditing(); - - /** Cancels the current editing session. - <p>Has no effect if the tree isn't being edited.</p> - */ - void cancelEditing(); - - /** Selects <var>Node</var> and initiates editing. - - <p>If <member>TreeControlModel::Editable</member> is <FALSE/> or if there are no - registered <type>XTreeEditListener</type>, this call has no effect.</p> - - <p>Calling this method also ensures that <var>Node</var> will become visible.</p> - - @param Node - the <type>XTreeNode</type> identifying a node. - - @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. - */ - void startEditingAtNode( [in] XTreeNode Node ) - raises( ::com::sun::star::lang::IllegalArgumentException ); - - /** Adds a <type>XTreeEditListener</type>. - - @param xListener - a <type>XTreeEditListener</type> that will be notified - before and after a tree node is edited. - */ - void addTreeEditListener( [in] XTreeEditListener Listener ); - - /** Removes a <type>XTreeEditListener</type>. - - @param xListener - the <type>XTreeEditListener</type> to remove - */ - void removeTreeEditListener( [in] XTreeEditListener Listener ); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XTreeDataModel.idl b/offapi/com/sun/star/awt/tree/XTreeDataModel.idl deleted file mode 100644 index b79b9718f..000000000 --- a/offapi/com/sun/star/awt/tree/XTreeDataModel.idl +++ /dev/null @@ -1,81 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_XTreeDataModel_idl__ -#define __com_sun_star_awt_tree_XTreeDataModel_idl__ - -#include <com/sun/star/awt/tree/XTreeDataModelListener.idl> -#include <com/sun/star/lang/IllegalArgumentException.idl> -#include <com/sun/star/lang/XComponent.idl> -#include <com/sun/star/awt/tree/XTreeNode.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** An instance of this interface is used by the <type>TreeControl</type> to - retrieve the hierarchical outline data that is displayed in the actual control. - - <p>If you implement your own <type>XTreeDataModel</type> you need to notify registered - <type>XTreeDataModelListener</type> if your model changes after the control is created. - If this is not done correctly the <type>TreeControl</type> will not update the data properly.</p> - - If you do not need your own model implementation, you can also use the <type>MutableTreeDataModel</type>. -*/ -published interface XTreeDataModel : ::com::sun::star::lang::XComponent -{ - /** Returns the root of the tree. - <p>Returns null only if the tree has no nodes. - - @returns - the root of the tree - */ - XTreeNode getRoot(); - - /** Adds a listener for the <type>TreeDataModelEvent</type> posted after the tree changes. - - @param Listener - the listener to add. - */ - void addTreeDataModelListener( [in] XTreeDataModelListener Listener ); - - - /** Removes a listener previously added with <method>addTreeDataModelListener()</method>. - - @param Listener - the listener to remove. - */ - void removeTreeDataModelListener( [in] XTreeDataModelListener Listener ); - -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl deleted file mode 100644 index 3858e37ec..000000000 --- a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl +++ /dev/null @@ -1,91 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_XTreeDataModelListener_idl__ -#define __com_sun_star_awt_tree_XTreeDataModelListener_idl__ - -#include <com/sun/star/lang/XEventListener.idl> - -#include <com/sun/star/awt/tree/TreeDataModelEvent.idl> - - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** An instance of this interface is used by the <type>TreeControl</type> to - get notifications about data model changes. - - <p>Usually you must not implement this interface yourself as it is already handled - by the <type>TreeControl</type>, but you must notify it correctly if - you implement the <type>XTreeDataModel</type> yourself</p>. - */ -published interface XTreeDataModelListener: com::sun::star::lang::XEventListener -{ - /** Invoked after a node (or a set of siblings) has changed in some way. - The node(s) have not changed locations in the tree or altered their - children arrays, but other attributes have changed and may affect - presentation. - - Example: the name of a file has changed, but it is in the same location in the file system. - - To indicate the root has changed, <member>TreeDataModelEvent::Nodes</member> will contain - the root node and <member>TreeDataModelEvent::ParentNode</member> will be empty. - */ - void treeNodesChanged( [in] TreeDataModelEvent Event ); - - /** Invoked after nodes have been inserted into the tree. - - Use <member>TreeDataModelEvent::ParentNode</member> to get the parent of the new node(s). - <member>TreeDataModelEvent::Nodes</member> contains the new node(s). - */ - void treeNodesInserted( [in] TreeDataModelEvent Event ); - - /** Invoked after nodes have been removed from the tree. - <p>Note that if a subtree is removed from the tree, - this method may only be invoked once for the root of the removed subtree, - not once for each individual set of siblings removed. - - Use <member>TreeDataModelEvent::ParentNode</member> to get the former parent of the deleted node(s). - <member>TreeDataModelEvent::Nodes</member> contains the removed node(s). - */ - void treeNodesRemoved( [in] TreeDataModelEvent Event ); - - /** Invoked after the tree has drastically changed structure from a given node down. - - Use <member>TreeDataModelEvent::ParentNode</member> to get the node which - structure has changed. <member>TreeDataModelEvent::Nodes</member> is empty. - */ - void treeStructureChanged( [in] TreeDataModelEvent Event ); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl deleted file mode 100644 index 89bbd5f0d..000000000 --- a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl +++ /dev/null @@ -1,81 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_XTreeEditListener_idl__ -#define __com_sun_star_awt_tree_XTreeEditListener_idl__ - -#include <com/sun/star/awt/tree/XTreeNode.idl> -#include <com/sun/star/lang/XEventListener.idl> -#include <com/sun/star/util/VetoException.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** You can implement this interface and register with <method scope="XTreeControl">addTreeEditListener</method> - to get notifications when editing of a node starts and ends. - - <p>You have to set the <member>TreeControlModel::Editable</member> property to - <TRUE/> before a tree supports editing.</p> - */ -published interface XTreeEditListener : ::com::sun::star::lang::XEventListener -{ - /** This method is called from the <type>TreeControl</type> implementation when editing of - <var>Node</var> is requested by calling <member>XTreeControl::startEditingAtNode()</member>. - - @param Node - the <type>XTreeNode</type> for that an edit request was fired by calling - <method scope="XTreeControl">startEditingAtNode</method> - - @throws VetoException - if thrown the editing will not start. - */ - void nodeEditing( [in] XTreeNode Node ) - raises ( ::com::sun::star::util::VetoException ); - - /** This method is called from the <type>TreeControl</type> implementation when editing - of <var>Node</var> is finished and was not canceled. - - <p>Implementations that register a <type>XTreeEditListener</type> must update the - display value at the Node.</p> - - @param Node - the <type>XTreeNode</type> for that an edit request was fired by calling - <method scope="XTreeControl">startEditingAtNode</method> - - @param NewText - the text that was entered by the user. - */ - void nodeEdited( [in] XTreeNode Node, [in] string NewText ); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl deleted file mode 100644 index 95e578773..000000000 --- a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl +++ /dev/null @@ -1,85 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_XTreeExpansionListener_idl__ -#define __com_sun_star_awt_tree_XTreeExpansionListener_idl__ - -#include <com/sun/star/lang/XEventListener.idl> - -#include <com/sun/star/awt/tree/TreeExpansionEvent.idl> -#include <com/sun/star/awt/tree/ExpandVetoException.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** An instance of this interface can get notifications from a <type>TreeControl</type> - when nodes are expanded or collapsed. - - @see XTreeControl::addTreeExpansionListener - @see XTreeControl::removeTreeExpansionListener - */ -published interface XTreeExpansionListener: com::sun::star::lang::XEventListener -{ - /** Invoked when a node with children on demand is about to be expanded. - - <p>This event is invoked before the <method>treeExpanding()</method> - event.</p> - */ - void requestChildNodes( [in] TreeExpansionEvent Event ); - - /** Invoked whenever a node in the tree is about to be expanded. - - @throws ExpandVetoException - to notify the calling <type>XTreeControl</type> that expanding - <member>TreeExpansionEvent::Node</member> should fail. - */ - void treeExpanding( [in] TreeExpansionEvent Event ) - raises ( ExpandVetoException ); - - /** Invoked whenever a node in the tree is about to be collapsed. - - @throws ExpandVetoException - to notify the calling <type>XTreeControl</type> that collapsing - <member>TreeExpansionEvent::Node</member> should fail. - */ - void treeCollapsing( [in] TreeExpansionEvent Event ) - raises ( ExpandVetoException ); - - /** Called whenever a node in the tree has been successfully expanded. */ - void treeExpanded( [in] TreeExpansionEvent Event ); - - /** Called whenever a node in the tree has been successfully collapsed. */ - void treeCollapsed( [in] TreeExpansionEvent Event ); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/tree/XTreeNode.idl b/offapi/com/sun/star/awt/tree/XTreeNode.idl deleted file mode 100644 index 2afa185b1..000000000 --- a/offapi/com/sun/star/awt/tree/XTreeNode.idl +++ /dev/null @@ -1,100 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_awt_tree_XTreeNode_idl__ -#define __com_sun_star_awt_tree_XTreeNode_idl__ - -#include <com/sun/star/container/XEnumerationAccess.idl> -#include <com/sun/star/lang/IndexOutOfBoundsException.idl> - -//============================================================================= - -module com { module sun { module star { module awt { module tree { - -//============================================================================= - -/** An instance implementing this interface represents the model data for an entry in a - <type>XTreeDataModel</type>. - <p>The <type>TreeControl</type> uses this interface to retrieve the model - information needed to display a hierarchical outline</p> - <p>Each XTreeNode in a <type>XTreeDataModel</type> must be unique. - */ -published interface XTreeNode -{ - /** Returns the child tree node at <var>Index</var>. - - @throws ::com::sun::star::lang::IndexOutOfBoundsException - if <var>Index</var> is less than 0 or equal or greater then <member>getChildCount</member>. - */ - XTreeNode getChildAt( [in] long Index ) - raises( com::sun::star::lang::IndexOutOfBoundsException ); - - /** Returns the number of child nodes. */ - long getChildCount(); - - /** Returns the parent node of this node. */ - XTreeNode getParent(); - - /** Returns the index of <var>Node</Node> in this instances children. - @returns - The child index of <var>Node</Node> , or -1 if <var>Node</Node> is no child of this instance. - */ - long getIndex( [in] XTreeNode Node); - - /** Returns <TRUE/> if the children of this node are created on demand. - <p>A <type>TreeControl</type> will handle a node that returns <TRUE/> always - like a node that has child nodes, even if <member>getChildCount</member> - returns 0.</p> - - @see TreeExpansionListener; - */ - boolean hasChildrenOnDemand(); - - /** If not empty, the textual representation of this any is used as the text part of this node. - */ - any getDisplayValue(); - - /** 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. - */ - string getNodeGraphicURL(); - - /** The URL for a graphic that is rendered to visualize expanded non leaf nodes. - <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultExpandedGraphicURL</member> is used. - */ - string getExpandedGraphicURL(); - - /** The URL for a graphic that is rendered to visualize collapsed non leaf nodes. - <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultCollapsedGraphicURL</member> is used. - */ - string getCollapsedGraphicURL(); -}; - -//============================================================================= - -}; }; }; }; }; - -#endif |