offapi/com/sun/star/sheet/XSheetAnnotation.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_XSheetAnnotation_idl__
  21 #define __com_sun_star_sheet_XSheetAnnotation_idl__
  22
  23 #include <com/sun/star/uno/XInterface.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 query data of the annotation and to show and
  31     hide it.
  32
  33     @see com::sun::star::sheet::CellAnnotation
  34  */
  35 published interface XSheetAnnotation: com::sun::star::uno::XInterface
  36 {
  37
  38     /** returns the position of cell in the spreadsheet document that
  39         contains this annotation.
  40      */
  41     com::sun::star::table::CellAddress getPosition();
  42
  43
  44     /** returns the name of the user who last changed the annotation.
  45      */
  46     string getAuthor();
  47
  48
  49     /** returns a formatted string representing the date when the
  50         annotation was last changed.
  51      */
  52     string getDate();
  53
  54
  55     /** returns, whether the annotation is permanently visible.
  56      */
  57     boolean getIsVisible();
  58
  59
  60     /** specifies whether the annotation is permanently visible.
  61      */
  62     void setIsVisible( [in] boolean bIsVisible );
  63
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */