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

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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