1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_tree_XTreeEditListener_idl__
28#define __com_sun_star_awt_tree_XTreeEditListener_idl__
29
30#ifndef __com_sun_star_awt_tree_XTreeNode_idl__
31#include <com/sun/star/awt/tree/XTreeNode.idl>
32#endif
33
34#ifndef __com_sun_star_lang_XEventListener_idl__
35#include <com/sun/star/lang/XEventListener.idl>
36#endif
37
38#ifndef __com_sun_star_util_VetoException_idl__
39#include <com/sun/star/util/VetoException.idl>
40#endif
41
42//=============================================================================
43
44module com {  module sun {  module star {  module awt {  module tree {
45
46//=============================================================================
47
48/** You can implement this interface and register with <method scope="XTreeControl">addTreeEditListener</method>
49    to get notifcaitons when editing of a node starts and ends.
50
51    <p>You have to set the <member>TreeControlModel::Editable</member> property to
52    <TRUE/> before a tree supports editing.</p>
53 */
54published interface XTreeEditListener : ::com::sun::star::lang::XEventListener
55{
56    /** This method is called from the <type>TreeControl</type> implementation when editing of
57        <var>Node</var> is requested by calling <member>XTreeControl::startEditingAtNode()</member>.
58
59        @param Node
60            the <type>XTreeNode</type> for that an edit request was fired by calling
61            <method scope="XTreeControl">startEditingAtNode</method>
62
63        @throws VetoException
64            if thrown the editing will not start.
65    */
66    void nodeEditing( [in] XTreeNode Node )
67        raises ( ::com::sun::star::util::VetoException );
68
69    /** This method is called from the <type>TreeControl</type> implementation when editing
70        of <var>Node</var> is finished and was not canceled.
71
72        <p>Implementations that register a <type>XTreeEditListener</type> must update the
73        display value at the Node.</p>
74
75        @param Node
76            the <type>XTreeNode</type> for that an edit request was fired by calling
77            <method scope="XTreeControl">startEditingAtNode</method>
78
79        @param NewText
80            the text that was entered by the user.
81    */
82    void nodeEdited( [in] XTreeNode Node, [in] string NewText );
83};
84
85//=============================================================================
86
87}; }; }; }; };
88
89#endif
90