1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_tree_XTreeExpansionListener_idl__
24#define __com_sun_star_awt_tree_XTreeExpansionListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30#ifndef __com_sun_star_awt_tree_TreeExpansionEvent_idl__
31#include <com/sun/star/awt/tree/TreeExpansionEvent.idl>
32#endif
33
34#ifndef __com_sun_star_awt_tree_ExpandVetoException_idl__
35#include <com/sun/star/awt/tree/ExpandVetoException.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module awt {  module tree {
41
42//=============================================================================
43
44/** An instance of this interface can get notifications from a <type>TreeControl</type>
45    when nodes are expanded or collapsed.
46
47    @see XTreeControl::addTreeExpansionListener
48    @see XTreeControl::removeTreeExpansionListener
49 */
50published interface XTreeExpansionListener: com::sun::star::lang::XEventListener
51{
52    /** Invoked when a node with children on demand is about to be expanded.
53
54        <p>This event is invoked befor the <method>treeExpanding()</method>
55        event.</p>
56    */
57    void requestChildNodes( [in] TreeExpansionEvent Event );
58
59    /** Invoked whenever a node in the tree is about to be expanded.
60
61        @throws ExpandVetoException
62            to notify the calling <type>XTreeControl</type> that expanding
63            <member>TreeExpansionEvent::Node</member> should faild.
64    */
65    void treeExpanding( [in] TreeExpansionEvent Event )
66        raises ( ExpandVetoException );
67
68    /** Invoked whenever a node in the tree is about to be collapsed.
69
70        @throws ExpandVetoException
71            to notify the calling <type>XTreeControl</type> that collapsing
72            <member>TreeExpansionEvent::Node</member> should faild.
73    */
74    void treeCollapsing( [in] TreeExpansionEvent Event )
75        raises ( ExpandVetoException );
76
77    /** Called whenever a node in the tree has been succesfully expanded. */
78    void treeExpanded( [in] TreeExpansionEvent Event );
79
80    /** Called whenever a node in the tree has been succesfully collapsed. */
81    void treeCollapsed( [in] TreeExpansionEvent Event );
82};
83
84//=============================================================================
85
86}; }; }; }; };
87
88#endif
89