/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSheetAnnotations.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:16:56 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#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

