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