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