offapi/com/sun/star/ucb/ContentEvent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ContentEvent.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_ContentEvent_idl__
  31 #define __com_sun_star_ucb_ContentEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41  published interface XContent;
  42  published interface XContentIdentifier;
  43
  44 //=============================================================================
  45 /** A structure for content events.
  46 */
  47 published struct ContentEvent: com::sun::star::lang::EventObject
  48 {
  49     //-------------------------------------------------------------------------
  50     /** The action.
  51
  52         <p>The value can be one of the <type>ContentAction</type> constants.
  53     */
  54     long Action;
  55
  56     //-------------------------------------------------------------------------
  57     /** The content to that the action is related (e.g., the content that was
  58         just physically destroyed, the content that was just inserted into a
  59         folder content).
  60
  61         <p>This member must be filled as follows:
  62
  63         <table border=1>
  64         <tr align=left>
  65             <td><member>ContentAction::INSERTED</member></td>
  66             <td>The content inserted into a folder</td>
  67         </tr>
  68         <tr align=left>
  69             <td><member>ContentAction::REMOVED</member></td>
  70             <td>The content removed from a folder</td>
  71         </tr>
  72         <tr align=left>
  73             <td><member>ContentAction::DELETED</member></td>
  74             <td>The deleted content</td>
  75         </tr>
  76         <tr align=left>
  77             <td><member>ContentAction::EXCHANGED</member></td>
  78             <td>The exchanged content (that already has the new content id)</td>
  79         </tr>
  80         </table>
  81     */
  82     XContent Content;
  83
  84     //-------------------------------------------------------------------------
  85     /** A content identifier, which must be filled according to the action
  86         notified (e.g., the id of the folder content into which another content
  87         was inserted).
  88
  89         <p>This member must be filled as follows:
  90
  91         <table border=1>
  92         <tr align=left>
  93             <td><member>ContentAction::INSERTED</member></td>
  94             <td>Id of the folder the content was inserted into</td>
  95         </tr>
  96         <tr align=left>
  97             <td><member>ContentAction::REMOVED</member></td>
  98             <td>Id of the folder the content was removed from</td>
  99         </tr>
 100         <tr align=left>
 101             <td><member>ContentAction::DELETED</member></td>
 102             <td>Id of the deleted content</td>
 103         </tr>
 104         <tr align=left>
 105             <td><member>ContentAction::EXCHANGED</member></td>
 106             <td>Previous(!) id of the exchanged content</td>
 107         </tr>
 108         </table>
 109     */
 110     XContentIdentifier Id;
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 #endif