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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_ContentEvent_idl__
  20 #define __com_sun_star_ucb_ContentEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27  published interface XContent;
  28  published interface XContentIdentifier;
  29
  30 /** A structure for content events.
  31 */
  32 published struct ContentEvent: com::sun::star::lang::EventObject
  33 {
  34     /** The action.
  35
  36         <p>The value can be one of the ContentAction constants.
  37     */
  38     long Action;
  39
  40     /** The content to that the action is related (e.g., the content that was
  41         just physically destroyed, the content that was just inserted into a
  42         folder content).
  43
  44         <p>This member must be filled as follows:
  45
  46         <table border=1>
  47         <tr align=left>
  48             <td>ContentAction::INSERTED</td>
  49             <td>The content inserted into a folder</td>
  50         </tr>
  51         <tr align=left>
  52             <td>ContentAction::REMOVED</td>
  53             <td>The content removed from a folder</td>
  54         </tr>
  55         <tr align=left>
  56             <td>ContentAction::DELETED</td>
  57             <td>The deleted content</td>
  58         </tr>
  59         <tr align=left>
  60             <td>ContentAction::EXCHANGED</td>
  61             <td>The exchanged content (that already has the new content id)</td>
  62         </tr>
  63         </table>
  64     */
  65     XContent Content;
  66
  67     /** A content identifier, which must be filled according to the action
  68         notified (e.g., the id of the folder content into which another content
  69         was inserted).
  70
  71         <p>This member must be filled as follows:
  72
  73         <table border=1>
  74         <tr align=left>
  75             <td>ContentAction::INSERTED</td>
  76             <td>Id of the folder the content was inserted into</td>
  77         </tr>
  78         <tr align=left>
  79             <td>ContentAction::REMOVED</td>
  80             <td>Id of the folder the content was removed from</td>
  81         </tr>
  82         <tr align=left>
  83             <td>ContentAction::DELETED</td>
  84             <td>Id of the deleted content</td>
  85         </tr>
  86         <tr align=left>
  87             <td>ContentAction::EXCHANGED</td>
  88             <td>Previous(!) id of the exchanged content</td>
  89         </tr>
  90         </table>
  91     */
  92     XContentIdentifier Id;
  93 };
  94
  95
  96 }; }; }; };
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */