offapi/com/sun/star/sheet/XSheetAnnotations.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_sheet_XSheetAnnotations_idl__
  21 #define __com_sun_star_sheet_XSheetAnnotations_idl__
  22
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/table/CellAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides methods to access cell annotations via index and to
  31     insert and remove annotations.
  32
  33     @see com::sun::star::sheet::CellAnnotation
  34     @see com::sun::star::sheet::SheetCell
  35  */
  36 published interface XSheetAnnotations: com::sun::star::container::XIndexAccess
  37 {
  38
  39     /** creates a new annotation.
  40
  41         <p>This method creates a new annotation object, attaches it to the
  42         specified cell and inserts it into the collection.</p>
  43
  44         @param aPosition
  45             contains the address of the cell that will contain the
  46             annotation.
  47
  48         @param aText
  49             contains the annotation text.
  50      */
  51     void insertNew(
  52             [in] com::sun::star::table::CellAddress aPosition,
  53             [in] string aText );
  54
  55
  56     /** removes a cell annotation from the collection.
  57
  58         <p>This method removes the annotation from its cell and from the
  59         collection.</p>
  60
  61         @param nIndex
  62             is the index of the annotation in the collection.
  63      */
  64     void removeByIndex( [in] long nIndex );
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */