diff options
Diffstat (limited to 'offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl')
-rw-r--r-- | offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl new file mode 100644 index 000000000000..8b235ff6db28 --- /dev/null +++ b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * 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__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +#ifndef __com_sun_star_awt_tree_TreeExpansionEvent_idl__ +#include <com/sun/star/awt/tree/TreeExpansionEvent.idl> +#endif + +#ifndef __com_sun_star_awt_tree_ExpandVetoException_idl__ +#include <com/sun/star/awt/tree/ExpandVetoException.idl> +#endif + +//============================================================================= + +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 + */ +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 befor 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 faild. + */ + 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 faild. + */ + void treeCollapsing( [in] TreeExpansionEvent Event ) + raises ( ExpandVetoException ); + + /** Called whenever a node in the tree has been succesfully expanded. */ + void treeExpanded( [in] TreeExpansionEvent Event ); + + /** Called whenever a node in the tree has been succesfully collapsed. */ + void treeCollapsed( [in] TreeExpansionEvent Event ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif |