xref: /aoo41x/main/offapi/com/sun/star/ucb/ContentEvent.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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