/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ContentEvent.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 07:16:59 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_ContentEvent_idl__
#define __com_sun_star_ucb_ContentEvent_idl__

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

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

module com { module sun { module star { module ucb {

 published interface XContent;
 published interface XContentIdentifier;

//=============================================================================
/** A structure for content events.
*/
published struct ContentEvent: com::sun::star::lang::EventObject
{
    //-------------------------------------------------------------------------
    /** The action.

        <p>The value can be one of the <type>ContentAction</type> constants.
    */
    long Action;

    //-------------------------------------------------------------------------
    /** The content to that the action is related (e.g., the content that was
        just physically destroyed, the content that was just inserted into a
        folder content).

        <p>This member must be filled as follows:

        <table border=1>
        <tr align=left>
            <td><member>ContentAction::INSERTED</member></td>
            <td>The content inserted into a folder</td>
        </tr>
        <tr align=left>
            <td><member>ContentAction::REMOVED</member></td>
            <td>The content removed from a folder</td>
        </tr>
        <tr align=left>
            <td><member>ContentAction::DELETED</member></td>
            <td>The deleted content</td>
        </tr>
        <tr align=left>
            <td><member>ContentAction::EXCHANGED</member></td>
            <td>The exchanged content (that already has the new content id)</td>
        </tr>
        </table>
    */
    XContent Content;

    //-------------------------------------------------------------------------
    /** A content identifier, which must be filled according to the action
        notified (e.g., the id of the folder content into which another content
        was inserted).

        <p>This member must be filled as follows:

        <table border=1>
        <tr align=left>
            <td><member>ContentAction::INSERTED</member></td>
            <td>Id of the folder the content was inserted into</td>
        </tr>
        <tr align=left>
            <td><member>ContentAction::REMOVED</member></td>
            <td>Id of the folder the content was removed from</td>
        </tr>
        <tr align=left>
            <td><member>ContentAction::DELETED</member></td>
            <td>Id of the deleted content</td>
        </tr>
        <tr align=left>
            <td><member>ContentAction::EXCHANGED</member></td>
            <td>Previous(!) id of the exchanged content</td>
        </tr>
        </table>
    */
    XContentIdentifier Id;
};

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

}; }; }; };

#endif
