offapi/com/sun/star/text/XTextTable.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: XTextTable.idl,v $
  10  * $Revision: 1.11 $
  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 #ifndef __com_sun_star_text_XTextTable_idl__
  31 #define __com_sun_star_text_XTextTable_idl__
  32
  33 #ifndef __com_sun_star_text_XTextContent_idl__
  34 #include <com/sun/star/text/XTextContent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_table_XTableRows_idl__
  38 #include <com/sun/star/table/XTableRows.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_table_XTableColumns_idl__
  42 #include <com/sun/star/table/XTableColumns.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_table_XCell_idl__
  46 #include <com/sun/star/table/XCell.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_text_XTextTableCursor_idl__
  50 #include <com/sun/star/text/XTextTableCursor.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module text {
  57
  58 //=============================================================================
  59
  60 /** manages a text table.
  61
  62     @see com::sun::star::text::TextTable
  63     @see com::sun::star::text::Cell
  64  */
  65 published interface XTextTable: com::sun::star::text::XTextContent
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** determines the numbers of rows and columns of the text table.
  70
  71         <p> This method must be called after the object is created and
  72             before the object is insert or attached elsewhere.
  73         </p>
  74      */
  75     void initialize( [in] long nRows,
  76              [in] long nColumns );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** @returns
  81             the access object for the text table rows.
  82
  83         @see com::sun::star::table::XTableRows
  84      */
  85     com::sun::star::table::XTableRows getRows();
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** @returns
  90             the access object for the text table columns.
  91
  92         @see com::sun::star::table::XTableColumns
  93      */
  94     com::sun::star::table::XTableColumns getColumns();
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** @returns
  99             the <type scope="com::sun::star::table">XCell</type> interface of the cell with the specified name.
 100
 101         @param aCellName
 102             is a concatenation of the alphanumeric column name and the
 103             index of the row.
 104
 105             <p>Example: The cell in the 4th column and third row has the name "D3".
 106
 107             <p>In cells that are split, the naming convention is more complex.
 108             In this case the name is a concatenation of the former cell name
 109             (i.e. "D3") and the number of the new column and row index inside
 110             of the original table cell separated by dots. This is done
 111             recursively.
 112
 113             <p>Example: If the cell "D3" is horizontally split, it now contains
 114             the cells "D3.1.1" and "D3.1.2"
 115
 116         @see com::sun::star::table::Cell
 117         @see com::sun::star::table::XCell
 118      */
 119     com::sun::star::table::XCell getCellByName( [in] string aCellName );
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** @returns
 124             the names of all cells of this text table.
 125      */
 126     sequence<string> getCellNames();
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** creates a text table cursor and returns the
 131         <type>XTextTableCursor</type> interface.
 132
 133         <p>Initially the cursor is positioned in the cell with the specified name.
 134         </p>
 135
 136         @see com::sun::star::text::TextTableCursor
 137      */
 138     com::sun::star::text::XTextTableCursor createCursorByCellName( [in] string aCellName );
 139
 140 };
 141
 142 //=============================================================================
 143
 144 }; }; }; };
 145
 146 #endif