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

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