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_XSheetAnnotations_idl__
25#define __com_sun_star_sheet_XSheetAnnotations_idl__
26
27#ifndef __com_sun_star_container_XIndexAccess_idl__
28#include <com/sun/star/container/XIndexAccess.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 access cell annotations via index and to
42	insert and remove annotations.
43
44	@see com::sun::star::sheet::CellAnnotation
45	@see com::sun::star::sheet::SheetCell
46 */
47published interface XSheetAnnotations: com::sun::star::container::XIndexAccess
48{
49	//-------------------------------------------------------------------------
50
51	/** creates a new annotation.
52
53		<p>This method creates a new annotation object, attaches it to the
54		specified cell and inserts it into the collection.</p>
55
56		@param aPosition
57			contains the address of the cell that will contain the
58			annotation.
59
60		@param aText
61			contains the annotation text.
62	 */
63	void insertNew(
64			[in] com::sun::star::table::CellAddress aPosition,
65			[in] string aText );
66
67	//-------------------------------------------------------------------------
68
69	/** removes a cell annotation from the collection.
70
71		<p>This method removes the annotation from its cell and from the
72		collection.</p>
73
74		@param nIndex
75			is the index of the annotation in the collection.
76	 */
77	void removeByIndex( [in] long nIndex );
78
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86
87