1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__
25#define __com_sun_star_sheet_XSheetAnnotation_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellAddress_idl__
32#include <com/sun/star/table/CellAddress.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides methods to query data of the annotation and to show and
42	hide it.
43
44	@see com::sun::star::sheet::CellAnnotation
45 */
46published interface XSheetAnnotation: com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49
50	/** returns the position of cell in the spreadsheet document that
51		contains this annotation.
52	 */
53	com::sun::star::table::CellAddress getPosition();
54
55	//-------------------------------------------------------------------------
56
57	/** returns the name of the user who last changed the annotation.
58	 */
59	string getAuthor();
60
61	//-------------------------------------------------------------------------
62
63	/** returns a formatted string representing the date when the
64		annotation was last changed.
65	 */
66	string getDate();
67
68	//-------------------------------------------------------------------------
69
70	/** returns, whether the annotation is permanently visible.
71	 */
72	boolean getIsVisible();
73
74	//-------------------------------------------------------------------------
75
76	/** specifies whether the annotation is permanently visible.
77	 */
78	void setIsVisible( [in] boolean bIsVisible );
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87
88