/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#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 TreeControl
    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 before the treeExpanding()
        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 XTreeControl that expanding
            TreeExpansionEvent::Node 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 XTreeControl that collapsing
            TreeExpansionEvent::Node 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
