offapi/com/sun/star/office/XAnnotationAccess.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
  20 #ifndef __com_sun_star_office_XAnnotationAccess_idl__
  21 #define __com_sun_star_office_XAnnotationAccess_idl__
  22
  23 #include <com/sun/star/office/XAnnotationEnumeration.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/office/XAnnotation.idl>
  26
  27
  28 module com {  module sun {  module star {  module office {
  29
  30
  31 /** This interface gives access to the annotation for a document content.
  32  */
  33 interface XAnnotationAccess
  34 {
  35     /** creates a new annotation and inserts it into the document content.
  36     */
  37     XAnnotation createAndInsertAnnotation();
  38
  39     /** removes the annotation from this document content.
  40     */
  41     void removeAnnotation( [in] XAnnotation annotation ) raises ( com::sun::star::lang::IllegalArgumentException );
  42
  43     /** @returns
  44             a new enumeration object for this annotation container.
  45             It returns NULL if there are no objects in this container.
  46      */
  47     XAnnotationEnumeration createAnnotationEnumeration();
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */