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