offapi/com/sun/star/table/XTableRows.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTableRows.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_table_XTableRows_idl__
  32 #define __com_sun_star_table_XTableRows_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module table {
  41
  42 //=============================================================================
  43
  44 /** provides methods to access rows via index and to insert and remove rows.
  45
  46     @see com::sun::star::table::TableRows
  47  */
  48 published interface XTableRows: com::sun::star::container::XIndexAccess
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** inserts new rows.
  53
  54         <p>When the index or combination of index and count is out
  55         of bounds an exception will be thrown.</p>
  56
  57         @param nIndex
  58             is the index the first inserted row will have.
  59
  60         @param nCount
  61             is the number of rows to insert.
  62      */
  63     void insertByIndex( [in] long nIndex, [in] long nCount );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** deletes rows.
  68
  69         <p>When the index or combination of index and count is out
  70         of bounds an exception will be thrown.</p>
  71
  72         @param nIndex
  73             is the index of the first row to delete.
  74
  75         @param nCount
  76             is the number of rows to delete.
  77      */
  78     void removeByIndex( [in] long nIndex, [in] long nCount );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif
  87