offapi/com/sun/star/sheet/XSheetAnnotation.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XSheetAnnotation_idl__
  29 #define __com_sun_star_sheet_XSheetAnnotation_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_table_CellAddress_idl__
  36 #include <com/sun/star/table/CellAddress.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** provides methods to query data of the annotation and to show and
  46     hide it.
  47
  48     @see com::sun::star::sheet::CellAnnotation
  49  */
  50 published interface XSheetAnnotation: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns the position of cell in the spreadsheet document that
  55         contains this annotation.
  56      */
  57     com::sun::star::table::CellAddress getPosition();
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** returns the name of the user who last changed the annotation.
  62      */
  63     string getAuthor();
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** returns a formatted string representing the date when the
  68         annotation was last changed.
  69      */
  70     string getDate();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** returns, whether the annotation is permanently visible.
  75      */
  76     boolean getIsVisible();
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies whether the annotation is permanently visible.
  81      */
  82     void setIsVisible( [in] boolean bIsVisible );
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91