xref: /aoo41x/main/offapi/com/sun/star/sheet/XSheetAnnotations.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__
#define __com_sun_star_sheet_XSheetAnnotations_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides methods to access cell annotations via index and to
	insert and remove annotations.

	@see com::sun::star::sheet::CellAnnotation
	@see com::sun::star::sheet::SheetCell
 */
published interface XSheetAnnotations: com::sun::star::container::XIndexAccess
{
	//-------------------------------------------------------------------------

	/** creates a new annotation.

		<p>This method creates a new annotation object, attaches it to the
		specified cell and inserts it into the collection.</p>

		@param aPosition
			contains the address of the cell thta will contain the
			annotation.

		@param aText
			contains the annotation text.
	 */
	void insertNew(
			[in] com::sun::star::table::CellAddress aPosition,
			[in] string aText );

	//-------------------------------------------------------------------------

	/** removes a cell annotation from the collection.

		<p>This method removes the annotation from its cell and from the
		collection.</p>

		@param nIndex
			is the index of the annotation in the collection.
	 */
	void removeByIndex( [in] long nIndex );

};

//=============================================================================

}; }; }; };

#endif