1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sheet_XSheetAnnotations_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XIndexAccess_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XIndexAccess.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_table_CellAddress_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/table/CellAddress.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sheet { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski/** provides methods to access cell annotations via index and to 42*b1cdbd2cSJim Jagielski insert and remove annotations. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski @see com::sun::star::sheet::CellAnnotation 45*b1cdbd2cSJim Jagielski @see com::sun::star::sheet::SheetCell 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielskipublished interface XSheetAnnotations: com::sun::star::container::XIndexAccess 48*b1cdbd2cSJim Jagielski{ 49*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski /** creates a new annotation. 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski <p>This method creates a new annotation object, attaches it to the 54*b1cdbd2cSJim Jagielski specified cell and inserts it into the collection.</p> 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski @param aPosition 57*b1cdbd2cSJim Jagielski contains the address of the cell thta will contain the 58*b1cdbd2cSJim Jagielski annotation. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @param aText 61*b1cdbd2cSJim Jagielski contains the annotation text. 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski void insertNew( 64*b1cdbd2cSJim Jagielski [in] com::sun::star::table::CellAddress aPosition, 65*b1cdbd2cSJim Jagielski [in] string aText ); 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** removes a cell annotation from the collection. 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski <p>This method removes the annotation from its cell and from the 72*b1cdbd2cSJim Jagielski collection.</p> 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @param nIndex 75*b1cdbd2cSJim Jagielski is the index of the annotation in the collection. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski void removeByIndex( [in] long nIndex ); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski}; 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski//============================================================================= 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski}; }; }; }; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski#endif 86*b1cdbd2cSJim Jagielski 87