merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / sheet / XSheetAnnotation.idl
blob7ee8450f2a356197a2c8b8a965fee60ca7484c2c
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XSheetAnnotation.idl,v $
10 * $Revision: 1.9 $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef __com_sun_star_sheet_XSheetAnnotation_idl__
32 #define __com_sun_star_sheet_XSheetAnnotation_idl__
34 #ifndef __com_sun_star_uno_XInterface_idl__
35 #include <com/sun/star/uno/XInterface.idl>
36 #endif
38 #ifndef __com_sun_star_table_CellAddress_idl__
39 #include <com/sun/star/table/CellAddress.idl>
40 #endif
42 //=============================================================================
44 module com { module sun { module star { module sheet {
46 //=============================================================================
48 /** provides methods to query data of the annotation and to show and
49 hide it.
51 @see com::sun::star::sheet::CellAnnotation
53 published interface XSheetAnnotation: com::sun::star::uno::XInterface
55 //-------------------------------------------------------------------------
57 /** returns the position of cell in the spreadsheet document that
58 contains this annotation.
60 com::sun::star::table::CellAddress getPosition();
62 //-------------------------------------------------------------------------
64 /** returns the name of the user who last changed the annotation.
66 string getAuthor();
68 //-------------------------------------------------------------------------
70 /** returns a formatted string representing the date when the
71 annotation was last changed.
73 string getDate();
75 //-------------------------------------------------------------------------
77 /** returns, whether the annotation is permanently visible.
79 boolean getIsVisible();
81 //-------------------------------------------------------------------------
83 /** specifies whether the annotation is permanently visible.
85 void setIsVisible( [in] boolean bIsVisible );
89 //=============================================================================
91 }; }; }; };
93 #endif