1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextTable_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_XTextTable_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextContent_idl__ 27cdf0e10cSrcweir#include <com/sun/star/text/XTextContent.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_table_XTableRows_idl__ 31cdf0e10cSrcweir#include <com/sun/star/table/XTableRows.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_table_XTableColumns_idl__ 35cdf0e10cSrcweir#include <com/sun/star/table/XTableColumns.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_table_XCell_idl__ 39cdf0e10cSrcweir#include <com/sun/star/table/XCell.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextTableCursor_idl__ 43cdf0e10cSrcweir#include <com/sun/star/text/XTextTableCursor.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweir module com { module sun { module star { module text { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir/** manages a text table. 54cdf0e10cSrcweir 55cdf0e10cSrcweir @see com::sun::star::text::TextTable 56cdf0e10cSrcweir @see com::sun::star::text::Cell 57cdf0e10cSrcweir */ 58cdf0e10cSrcweirpublished interface XTextTable: com::sun::star::text::XTextContent 59cdf0e10cSrcweir{ 60cdf0e10cSrcweir //------------------------------------------------------------------------- 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** determines the numbers of rows and columns of the text table. 63cdf0e10cSrcweir 64cdf0e10cSrcweir <p> This method must be called after the object is created and 65cdf0e10cSrcweir before the object is insert or attached elsewhere. 66cdf0e10cSrcweir </p> 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir void initialize( [in] long nRows, 69cdf0e10cSrcweir [in] long nColumns ); 70cdf0e10cSrcweir 71cdf0e10cSrcweir //------------------------------------------------------------------------- 72cdf0e10cSrcweir 73cdf0e10cSrcweir /** @returns 74cdf0e10cSrcweir the access object for the text table rows. 75cdf0e10cSrcweir 76cdf0e10cSrcweir @see com::sun::star::table::XTableRows 77cdf0e10cSrcweir */ 78cdf0e10cSrcweir com::sun::star::table::XTableRows getRows(); 79cdf0e10cSrcweir 80cdf0e10cSrcweir //------------------------------------------------------------------------- 81cdf0e10cSrcweir 82cdf0e10cSrcweir /** @returns 83cdf0e10cSrcweir the access object for the text table columns. 84cdf0e10cSrcweir 85cdf0e10cSrcweir @see com::sun::star::table::XTableColumns 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir com::sun::star::table::XTableColumns getColumns(); 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir 91cdf0e10cSrcweir /** @returns 92cdf0e10cSrcweir the <type scope="com::sun::star::table">XCell</type> interface of the cell with the specified name. 93cdf0e10cSrcweir 94cdf0e10cSrcweir @param aCellName 95cdf0e10cSrcweir is a concatenation of the alphanumeric column name and the 96cdf0e10cSrcweir index of the row. 97cdf0e10cSrcweir 98cdf0e10cSrcweir <p>Example: The cell in the 4th column and third row has the name "D3". 99cdf0e10cSrcweir 100cdf0e10cSrcweir <p>In cells that are split, the naming convention is more complex. 101cdf0e10cSrcweir In this case the name is a concatenation of the former cell name 102cdf0e10cSrcweir (i.e. "D3") and the number of the new column and row index inside 103cdf0e10cSrcweir of the original table cell separated by dots. This is done 104cdf0e10cSrcweir recursively. 105cdf0e10cSrcweir 106cdf0e10cSrcweir <p>Example: If the cell "D3" is horizontally split, it now contains 107cdf0e10cSrcweir the cells "D3.1.1" and "D3.1.2" 108cdf0e10cSrcweir 109cdf0e10cSrcweir @see com::sun::star::table::Cell 110cdf0e10cSrcweir @see com::sun::star::table::XCell 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir com::sun::star::table::XCell getCellByName( [in] string aCellName ); 113cdf0e10cSrcweir 114cdf0e10cSrcweir //------------------------------------------------------------------------- 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** @returns 117cdf0e10cSrcweir the names of all cells of this text table. 118cdf0e10cSrcweir */ 119cdf0e10cSrcweir sequence<string> getCellNames(); 120cdf0e10cSrcweir 121cdf0e10cSrcweir //------------------------------------------------------------------------- 122cdf0e10cSrcweir 123cdf0e10cSrcweir /** creates a text table cursor and returns the 124cdf0e10cSrcweir <type>XTextTableCursor</type> interface. 125cdf0e10cSrcweir 126cdf0e10cSrcweir <p>Initially the cursor is positioned in the cell with the specified name. 127cdf0e10cSrcweir </p> 128cdf0e10cSrcweir 129cdf0e10cSrcweir @see com::sun::star::text::TextTableCursor 130cdf0e10cSrcweir */ 131cdf0e10cSrcweir com::sun::star::text::XTextTableCursor createCursorByCellName( [in] string aCellName ); 132cdf0e10cSrcweir 133cdf0e10cSrcweir}; 134cdf0e10cSrcweir 135cdf0e10cSrcweir//============================================================================= 136cdf0e10cSrcweir 137cdf0e10cSrcweir}; }; }; }; 138cdf0e10cSrcweir 139cdf0e10cSrcweir#endif 140