AOO410/main/offapi/com/sun/star/office/XAnnotationAccess.idl

/**************************************************************
 * 
 * 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_office_XAnnotationAccess_idl__
#define __com_sun_star_office_XAnnotationAccess_idl__

#ifndef __com_sun_star_office_XAnnotationEnumeration_idl__ 
#include <com/sun/star/office/XAnnotationEnumeration.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/office/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_office_XAnnotation_idl__
#include <com/sun/star/office/XAnnotation.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module office {

//=============================================================================

/** This interface gives access to the annotation for a document content.
 */
interface XAnnotationAccess
{    
    /** creates a new annotation and inserts it into the document content.
    */
    XAnnotation createAndInsertAnnotation();

    /** removes the annotation from this document content.
    */
    void removeAnnotation( [in] XAnnotation annotation ) raises ( com::sun::star::lang::IllegalArgumentException );

	/** @returns		 
			a new enumeration object for this annotation container.
			It returns NULL if there are no objects in this container.
	 */
	XAnnotationEnumeration createAnnotationEnumeration(); 
};

//=============================================================================

}; }; }; };

#endif