offapi/com/sun/star/office/XAnnotationAccess.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: XGalleryItem.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_office_XAnnotationAccess_idl__
  32 #define __com_sun_star_office_XAnnotationAccess_idl__
  33
  34 #ifndef __com_sun_star_office_XAnnotationEnumeration_idl__
  35 #include <com/sun/star/office/XAnnotationEnumeration.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/office/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_office_XAnnotation_idl__
  43 #include <com/sun/star/office/XAnnotation.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module office {
  49
  50 //=============================================================================
  51
  52 /** This interface gives access to the annotation for a document content.
  53  */
  54 interface XAnnotationAccess
  55 {
  56     /** creates a new annotation and inserts it into the document content.
  57     */
  58     XAnnotation createAndInsertAnnotation();
  59
  60     /** removes the annotation from this document content.
  61     */
  62     void removeAnnotation( [in] XAnnotation annotation ) raises ( com::sun::star::lang::IllegalArgumentException );
  63
  64     /** @returns
  65             a new enumeration object for this annotation container.
  66             It returns NULL if there are no objects in this container.
  67      */
  68     XAnnotationEnumeration createAnnotationEnumeration();
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif