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