/* -*- 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_ucb_ContentEvent_idl__
#define __com_sun_star_ucb_ContentEvent_idl__

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


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 ContentAction 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>ContentAction::INSERTED</td>
            <td>The content inserted into a folder</td>
        </tr>
        <tr align=left>
            <td>ContentAction::REMOVED</td>
            <td>The content removed from a folder</td>
        </tr>
        <tr align=left>
            <td>ContentAction::DELETED</td>
            <td>The deleted content</td>
        </tr>
        <tr align=left>
            <td>ContentAction::EXCHANGED</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>ContentAction::INSERTED</td>
            <td>Id of the folder the content was inserted into</td>
        </tr>
        <tr align=left>
            <td>ContentAction::REMOVED</td>
            <td>Id of the folder the content was removed from</td>
        </tr>
        <tr align=left>
            <td>ContentAction::DELETED</td>
            <td>Id of the deleted content</td>
        </tr>
        <tr align=left>
            <td>ContentAction::EXCHANGED</td>
            <td>Previous(!) id of the exchanged content</td>
        </tr>
        </table>
    */
    XContentIdentifier Id;
};


}; }; }; };

#endif

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