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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTextTableCursor.idl,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_XTextTableCursor_idl__
  31 #define __com_sun_star_text_XTextTableCursor_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 /** The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells
  45
  46     @see com::sun::star::text::TextTable
  47     @see com::sun::star::text::TextTableCursor
  48     @see com::sun::star::text::Cell
  49     @see com::sun::star::text::XTextTable
  50  */
  51 published interface XTextTableCursor: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** @returns
  56                 the name of the cell range that is selected by this cursor.
  57                 <p>The name is the cell name of the top left table cell of the range
  58                  contatenated by ':' with the table cell name of the bottom left table cell of the cell range.
  59                 If the range consists of one table cell only then the name of that table cell is returned.
  60              </p>
  61         @see com::sun:star::text::CellRange
  62      */
  63     string getRangeName();
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** moves the cursor to the cell with the specified name.
  68
  69         @param aCellName
  70             specifies the name of the cell to go to.
  71
  72         @param bExpand
  73             determines wether the selection is to be expanded.
  74
  75         @see com::sun::star::text::Cell
  76      */
  77     boolean gotoCellByName( [in] string aCellName,
  78              [in] boolean bExpand );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** moves the cursor to the left neighbor.
  83
  84         @param nCount
  85             the number of cells to move.
  86
  87         @param bExpand
  88             determines wether the selection is to be expanded.
  89      */
  90     boolean goLeft( [in] short nCount,
  91              [in] boolean bExpand );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** moves the cursor to the right neighbor.
  96
  97         @param nCount
  98             the number of cells to move.
  99
 100         @param bExpand
 101             determines wether the selection is to be expanded.
 102      */
 103     boolean goRight( [in] short nCount,
 104              [in] boolean bExpand );
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** moves the cursor to the top neighbor.
 109
 110         @param nCount
 111             the number of cells to move.
 112
 113         @param bExpand
 114             determines wether the selection is to be expanded.
 115      */
 116     boolean goUp( [in] short nCount,
 117              [in] boolean bExpand );
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** moves the cursor to the bottom neighbor cell.
 122
 123         @param nCount
 124             the number of cells to move.
 125
 126         @param bExpand
 127             determines wether the selection is to be expanded.
 128      */
 129     boolean goDown( [in] short nCount,
 130              [in] boolean bExpand );
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** moves the cursor to the top left cell of the table.
 135
 136         @param bExpand
 137             determines wether the selection is to be expanded.
 138      */
 139     void gotoStart( [in] boolean bExpand );
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** moves the cursor to the bottom right cell of the table.
 144
 145         @param bExpand
 146             determines wether the selection is to be expanded.
 147      */
 148     void gotoEnd( [in] boolean bExpand );
 149
 150     //-------------------------------------------------------------------------
 151
 152     /** merges the selected range of cells.
 153
 154         @see com:sun::star::CellRange
 155      */
 156     boolean mergeRange();
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** splits the range of cells.
 161
 162         @param nCount
 163             specifies the number of new cells that will be created
 164             for each cell contained in the range.
 165
 166         @param bHorizontal
 167             <true/> if the range should be split vertically.
 168             Otherwise it will be split horizontally.
 169
 170         @see com:sun::star::Cell
 171         @see com:sun::star::CellRange
 172      */
 173     boolean splitRange( [in] short nCount,
 174              [in] boolean bHorizontal );
 175
 176 };
 177
 178 //=============================================================================
 179
 180 }; }; }; };
 181
 182 #endif