offapi/com/sun/star/text/XTextTable.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XTextTable_idl__
  20 #define __com_sun_star_text_XTextTable_idl__
  21
  22 #include <com/sun/star/text/XTextContent.idl>
  23
  24 #include <com/sun/star/table/XTableRows.idl>
  25
  26 #include <com/sun/star/table/XTableColumns.idl>
  27
  28 #include <com/sun/star/table/XCell.idl>
  29
  30 #include <com/sun/star/text/XTextTableCursor.idl>
  31
  32
  33
  34  module com {  module sun {  module star {  module text {
  35
  36
  37 /** manages a text table.
  38
  39     @see com::sun::star::text::TextTable
  40     @see com::sun::star::text::Cell
  41  */
  42 published interface XTextTable: com::sun::star::text::XTextContent
  43 {
  44
  45     /** determines the numbers of rows and columns of the text table.
  46
  47         <p> This method must be called after the object is created and
  48             before the object is insert or attached elsewhere.
  49         </p>
  50      */
  51     void initialize( [in] long nRows,
  52              [in] long nColumns );
  53
  54
  55     /** @returns
  56             the access object for the text table rows.
  57
  58         @see com::sun::star::table::XTableRows
  59      */
  60     com::sun::star::table::XTableRows getRows();
  61
  62
  63     /** @returns
  64             the access object for the text table columns.
  65
  66         @see com::sun::star::table::XTableColumns
  67      */
  68     com::sun::star::table::XTableColumns getColumns();
  69
  70
  71     /** @returns
  72             the com::sun::star::table::XCell interface of the cell with the specified name.
  73
  74         @param aCellName
  75             is a concatenation of the alphanumeric column name and the
  76             index of the row.
  77
  78             <p>Example: The cell in the 4th column and third row has the name "D3".
  79
  80             <p>In cells that are split, the naming convention is more complex.
  81             In this case the name is a concatenation of the former cell name
  82             (i.e. "D3") and the number of the new column and row index inside
  83             of the original table cell separated by dots. This is done
  84             recursively.
  85
  86             <p>Example: If the cell "D3" is horizontally split, it now contains
  87             the cells "D3.1.1" and "D3.1.2"
  88
  89         @see com::sun::star::table::Cell
  90         @see com::sun::star::table::XCell
  91      */
  92     com::sun::star::table::XCell getCellByName( [in] string aCellName );
  93
  94
  95     /** @returns
  96             the names of all cells of this text table.
  97      */
  98     sequence<string> getCellNames();
  99
 100
 101     /** creates a text table cursor and returns the
 102         XTextTableCursor interface.
 103
 104         <p>Initially the cursor is positioned in the cell with the specified name.
 105         </p>
 106
 107         @see com::sun::star::text::TextTableCursor
 108      */
 109     com::sun::star::text::XTextTableCursor createCursorByCellName( [in] string aCellName );
 110
 111 };
 112
 113
 114 }; }; }; };
 115
 116 #endif
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */