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
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24
  25 /** manages a text table.
  26
  27     @see com::sun::star::text::TextTable
  28     @see com::sun::star::text::Cell
  29  */
  30 published interface XTextTable: com::sun::star::text::XTextContent
  31 {
  32
  33     /** determines the numbers of rows and columns of the text table.
  34
  35         <p> This method must be called after the object is created and
  36             before the object is insert or attached elsewhere.
  37         </p>
  38      */
  39     void initialize( [in] long nRows,
  40              [in] long nColumns );
  41
  42
  43     /** @returns
  44             the access object for the text table rows.
  45
  46         @see com::sun::star::table::XTableRows
  47      */
  48     com::sun::star::table::XTableRows getRows();
  49
  50
  51     /** @returns
  52             the access object for the text table columns.
  53
  54         @see com::sun::star::table::XTableColumns
  55      */
  56     com::sun::star::table::XTableColumns getColumns();
  57
  58
  59     /** @returns
  60             the com::sun::star::table::XCell interface of the cell with the specified name.
  61
  62         @param aCellName
  63             is a concatenation of the alphanumeric column name and the
  64             index of the row.
  65
  66             <p>Example: The cell in the 4th column and third row has the name "D3".
  67
  68             <p>In cells that are split, the naming convention is more complex.
  69             In this case the name is a concatenation of the former cell name
  70             (i.e. "D3") and the number of the new column and row index inside
  71             of the original table cell separated by dots. This is done
  72             recursively.
  73
  74             <p>Example: If the cell "D3" is horizontally split, it now contains
  75             the cells "D3.1.1" and "D3.1.2"
  76
  77         @see com::sun::star::table::Cell
  78         @see com::sun::star::table::XCell
  79      */
  80     com::sun::star::table::XCell getCellByName( [in] string aCellName );
  81
  82
  83     /** @returns
  84             the names of all cells of this text table.
  85      */
  86     sequence<string> getCellNames();
  87
  88
  89     /** creates a text table cursor and returns the
  90         XTextTableCursor interface.
  91
  92         <p>Initially the cursor is positioned in the cell with the specified name.
  93         </p>
  94
  95         @see com::sun::star::text::TextTableCursor
  96      */
  97     com::sun::star::text::XTextTableCursor createCursorByCellName( [in] string aCellName );
  98
  99 };
 100
 101
 102 }; }; }; };
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */