offapi/com/sun/star/text/XTextTableCursor.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 /** The TextTableCursor provide methods to navigate through the table structure, to merge and split cells
  26
  27     @see com::sun::star::text::TextTable
  28     @see com::sun::star::text::TextTableCursor
  29     @see com::sun::star::text::Cell
  30     @see com::sun::star::text::XTextTable
  31  */
  32 published interface XTextTableCursor: com::sun::star::uno::XInterface
  33 {
  34
  35     /** @returns
  36                 the name of the cell range that is selected by this cursor.
  37                 <p>The name is the cell name of the top left table cell of the range
  38                  concatenated by ":" with the table cell name of the bottom left table cell of the cell range.
  39                 If the range consists of one table cell only then the name of that table cell is returned.
  40              </p>
  41         @see com::sun:star::text::CellRange
  42      */
  43     string getRangeName();
  44
  45
  46     /** moves the cursor to the cell with the specified name.
  47
  48         @param aCellName
  49             specifies the name of the cell to go to.
  50
  51         @param bExpand
  52             determines whether the selection is to be expanded.
  53
  54         @see com::sun::star::text::Cell
  55      */
  56     boolean gotoCellByName( [in] string aCellName,
  57              [in] boolean bExpand );
  58
  59
  60     /** moves the cursor to the left neighbor.
  61
  62         @param nCount
  63             the number of cells to move.
  64
  65         @param bExpand
  66             determines whether the selection is to be expanded.
  67      */
  68     boolean goLeft( [in] short nCount,
  69              [in] boolean bExpand );
  70
  71
  72     /** moves the cursor to the right neighbor.
  73
  74         @param nCount
  75             the number of cells to move.
  76
  77         @param bExpand
  78             determines whether the selection is to be expanded.
  79      */
  80     boolean goRight( [in] short nCount,
  81              [in] boolean bExpand );
  82
  83
  84     /** moves the cursor to the top neighbor.
  85
  86         @param nCount
  87             the number of cells to move.
  88
  89         @param bExpand
  90             determines whether the selection is to be expanded.
  91      */
  92     boolean goUp( [in] short nCount,
  93              [in] boolean bExpand );
  94
  95
  96     /** moves the cursor to the bottom neighbor cell.
  97
  98         @param nCount
  99             the number of cells to move.
 100
 101         @param bExpand
 102             determines whether the selection is to be expanded.
 103      */
 104     boolean goDown( [in] short nCount,
 105              [in] boolean bExpand );
 106
 107
 108     /** moves the cursor to the top left cell of the table.
 109
 110         @param bExpand
 111             determines whether the selection is to be expanded.
 112      */
 113     void gotoStart( [in] boolean bExpand );
 114
 115
 116     /** moves the cursor to the bottom right cell of the table.
 117
 118         @param bExpand
 119             determines whether the selection is to be expanded.
 120      */
 121     void gotoEnd( [in] boolean bExpand );
 122
 123
 124     /** merges the selected range of cells.
 125
 126         @see com::sun::star::CellRange
 127      */
 128     boolean mergeRange();
 129
 130
 131     /** splits the range of cells.
 132
 133         @param nCount
 134             specifies the number of new cells that will be created
 135             for each cell contained in the range.
 136
 137         @param bHorizontal
 138             `TRUE` if the range should be split vertically.
 139             Otherwise it will be split horizontally.
 140
 141         @see com::sun::star::Cell
 142         @see com::sun::star::CellRange
 143      */
 144     boolean splitRange( [in] short nCount,
 145              [in] boolean bHorizontal );
 146
 147 };
 148
 149
 150 }; }; }; };
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */