offapi/com/sun/star/sheet/CellAnnotation.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_CellAnnotation_idl__
  21 #define __com_sun_star_sheet_CellAnnotation_idl__
  22
  23 #include <com/sun/star/sheet/XSheetAnnotation.idl>
  24 #include <com/sun/star/sheet/XSheetAnnotationShapeSupplier.idl>
  25 #include <com/sun/star/container/XChild.idl>
  26 #include <com/sun/star/text/XSimpleText.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** represents a cell annotation object attached to a spreadsheet cell.
  33
  34     @see com::sun::star::sheet::SheetCell
  35  */
  36 published service CellAnnotation
  37 {
  38
  39     /** provides methods to query data of the annotation
  40         and to show and hide it.
  41      */
  42     interface com::sun::star::sheet::XSheetAnnotation;
  43
  44
  45     /** provides access to the parent of this object.
  46
  47         <p>The parent of a cell annotation is the cell that contains it.</p>
  48      */
  49     interface com::sun::star::container::XChild;
  50
  51
  52     /** provides access to the text contents of the annotation.
  53      */
  54     interface com::sun::star::text::XSimpleText;
  55
  56
  57     [optional] interface com::sun::star::sheet::XSheetAnnotationShapeSupplier;
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */