offapi/com/sun/star/sheet/XSheetAnnotations.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: XSheetAnnotations.idl,v $
  10  * $Revision: 1.9 $
  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_sheet_XSheetAnnotations_idl__
  32 #define __com_sun_star_sheet_XSheetAnnotations_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellAddress_idl__
  39 #include <com/sun/star/table/CellAddress.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides methods to access cell annotations via index and to
  49     insert and remove annotations.
  50
  51     @see com::sun::star::sheet::CellAnnotation
  52     @see com::sun::star::sheet::SheetCell
  53  */
  54 published interface XSheetAnnotations: com::sun::star::container::XIndexAccess
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** creates a new annotation.
  59
  60         <p>This method creates a new annotation object, attaches it to the
  61         specified cell and inserts it into the collection.</p>
  62
  63         @param aPosition
  64             contains the address of the cell thta will contain the
  65             annotation.
  66
  67         @param aText
  68             contains the annotation text.
  69      */
  70     void insertNew(
  71             [in] com::sun::star::table::CellAddress aPosition,
  72             [in] string aText );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** removes a cell annotation from the collection.
  77
  78         <p>This method removes the annotation from its cell and from the
  79         collection.</p>
  80
  81         @param nIndex
  82             is the index of the annotation in the collection.
  83      */
  84     void removeByIndex( [in] long nIndex );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif
  93