offapi/com/sun/star/table/XTableColumns.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: XTableColumns.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_XTableColumns_idl__
  32 #define __com_sun_star_table_XTableColumns_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 columns via index and to insert and remove
  45     columns.
  46
  47     @see com::sun::star::table::TableColumns
  48  */
  49 published interface XTableColumns: com::sun::star::container::XIndexAccess
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** inserts new columns.
  54
  55         <p>When the index or combination of index and count is out
  56         of bounds an exception will be thrown.</p>
  57
  58         @param nIndex
  59             is the index the first inserted column will have.
  60
  61         @param nCount
  62             is the number of columns to insert.
  63      */
  64     void insertByIndex( [in] long nIndex, [in] long nCount );
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** deletes columns.
  69
  70         <p>When the index or combination of index and count is out
  71         of bounds an exception will be thrown.</p>
  72
  73         @param nIndex
  74             is the index of the first column to delete.
  75
  76         @param nCount
  77             is the number of columns to delete.
  78      */
  79     void removeByIndex( [in] long nIndex, [in] long nCount );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif
  88