offapi/com/sun/star/sheet/CellAnnotation.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: CellAnnotation.idl,v $
  10  * $Revision: 1.8 $
  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_CellAnnotation_idl__
  32 #define __com_sun_star_sheet_CellAnnotation_idl__
  33
  34 #ifndef __com_sun_star_sheet_XSheetAnnotation_idl__
  35 #include <com/sun/star/sheet/XSheetAnnotation.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XSheetAnnotationShapeSupplier_idl__
  39 #include <com/sun/star/sheet/XSheetAnnotationShapeSupplier.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_XChild_idl__
  43 #include <com/sun/star/container/XChild.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_text_XSimpleText_idl__
  47 #include <com/sun/star/text/XSimpleText.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** represents a cell annotation object attached to a spreadsheet cell.
  57
  58     @see com::sun::star::sheet::SheetCell
  59  */
  60 published service CellAnnotation
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** provides methods to query data of the annotation
  65         and to show and hide it.
  66      */
  67     interface com::sun::star::sheet::XSheetAnnotation;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** provides access to the parent of this object.
  72
  73         <p>The parent of a cell annotation is the cell that contains it.</p>
  74      */
  75     interface com::sun::star::container::XChild;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** provides access to the text contents of the annotation.
  80      */
  81     interface com::sun::star::text::XSimpleText;
  82
  83     //-------------------------------------------------------------------------
  84
  85     [optional] interface com::sun::star::sheet::XSheetAnnotationShapeSupplier;
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94