xref: /aoo42x/main/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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__

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif

#ifndef __com_sun_star_awt_tree_XTreeNode_idl__
#include <com/sun/star/awt/tree/XTreeNode.idl>
#endif

//=============================================================================

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