offapi/com/sun/star/table/XTable.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: XTable.idl,v $
  10  * $Revision: 1.3 $
  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_XTable_idl__
  32 #define __com_sun_star_table_XTable_idl__
  33
  34 #ifndef __com_sun_star_lang_XComponent_idl__
  35 #include <com/sun/star/lang/XComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_XCellRange_idl__
  39 #include <com/sun/star/table/XCellRange.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_XColumnRowRange_idl__
  43 #include <com/sun/star/table/XColumnRowRange.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_table_XCellCursor_idl__
  47 #include <com/sun/star/table/XCellCursor.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_util_XModifiable_idl__
  51 #include <com/sun/star/util/XModifiable.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_beans_XMultiPropertySet_idl__
  55 #include <com/sun/star/beans/XMultiPropertySet.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_beans_XPropertySet_idl__
  59 #include <com/sun/star/beans/XPropertySet.idl>
  60 #endif
  61
  62 #ifndef __com_sun_star_beans_XFastPropertySet_idl__
  63 #include <com/sun/star/beans/XFastPropertySet.idl>
  64 #endif
  65
  66 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  67 #include <com/sun/star/lang/IllegalArgumentException.idl>
  68 #endif
  69
  70 //=============================================================================
  71
  72 module com {  module sun {  module star {  module table {
  73
  74 //=============================================================================
  75
  76 /**
  77 */
  78 interface XTable
  79 {
  80
  81     interface com::sun::star::lang::XComponent;
  82
  83     //-------------------------------------------------------------------------
  84
  85     interface com::sun::star::table::XCellRange;
  86
  87     //-------------------------------------------------------------------------
  88
  89     interface com::sun::star::table::XColumnRowRange;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** interface to make the modify state of the table accessible.
  94         <p>Additionally, it makes it possible to register listener objects, which
  95         get notification whenever the content of the table changes.
  96     */
  97     interface ::com::sun::star::util::XModifiable;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /* interface ::com::sun::star::beans::XMultiPropertySet; */
 102
 103     //-------------------------------------------------------------------------
 104
 105     interface ::com::sun::star::beans::XPropertySet;
 106
 107     //-------------------------------------------------------------------------
 108
 109     interface ::com::sun::star::beans::XFastPropertySet;
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** creates a cell cursor including the whole table
 114
 115         @see com::sun::star::table::CellCursor
 116      */
 117     com::sun::star::table::XCellCursor createCursor();
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** creates a cell cursor to travel in the given range context.
 122
 123         @param aRange
 124             the cell range for the cursor.
 125
 126         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
 127             if the given reference is empty or not a range from this table.
 128
 129         @see com::sun::star::table::CellCursor
 130      */
 131     com::sun::star::table::XCellCursor createCursorByRange( [in] com::sun::star::table::XCellRange Range )
 132         raises ( com::sun::star::lang::IllegalArgumentException );
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** stores the current row count of this table */
 137     [readonly, attribute] long RowCount;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** stores the current column count of this table */
 142     [readonly, attribute] long ColumnCount;
 143 };
 144
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 #endif
 150