152 lines
4.3 KiB
Text
152 lines
4.3 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
|
|
|
|
module com { module sun { module star { module text {
|
|
|
|
|
|
/** The TextTableCursor provide methods to navigate through the table structure, to merge and split cells
|
|
|
|
@see com::sun::star::text::TextTable
|
|
@see com::sun::star::text::TextTableCursor
|
|
@see com::sun::star::text::Cell
|
|
@see com::sun::star::text::XTextTable
|
|
*/
|
|
published interface XTextTableCursor: com::sun::star::uno::XInterface
|
|
{
|
|
|
|
/** @returns
|
|
the name of the cell range that is selected by this cursor.
|
|
<p>The name is the cell name of the top left table cell of the range
|
|
concatenated by ":" with the table cell name of the bottom left table cell of the cell range.
|
|
If the range consists of one table cell only then the name of that table cell is returned.
|
|
</p>
|
|
@see com::sun:star::text::CellRange
|
|
*/
|
|
string getRangeName();
|
|
|
|
|
|
/** moves the cursor to the cell with the specified name.
|
|
|
|
@param aCellName
|
|
specifies the name of the cell to go to.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
|
|
@see com::sun::star::text::Cell
|
|
*/
|
|
boolean gotoCellByName( [in] string aCellName,
|
|
[in] boolean bExpand );
|
|
|
|
|
|
/** moves the cursor to the left neighbor.
|
|
|
|
@param nCount
|
|
the number of cells to move.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
*/
|
|
boolean goLeft( [in] short nCount,
|
|
[in] boolean bExpand );
|
|
|
|
|
|
/** moves the cursor to the right neighbor.
|
|
|
|
@param nCount
|
|
the number of cells to move.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
*/
|
|
boolean goRight( [in] short nCount,
|
|
[in] boolean bExpand );
|
|
|
|
|
|
/** moves the cursor to the top neighbor.
|
|
|
|
@param nCount
|
|
the number of cells to move.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
*/
|
|
boolean goUp( [in] short nCount,
|
|
[in] boolean bExpand );
|
|
|
|
|
|
/** moves the cursor to the bottom neighbor cell.
|
|
|
|
@param nCount
|
|
the number of cells to move.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
*/
|
|
boolean goDown( [in] short nCount,
|
|
[in] boolean bExpand );
|
|
|
|
|
|
/** moves the cursor to the top left cell of the table.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
*/
|
|
void gotoStart( [in] boolean bExpand );
|
|
|
|
|
|
/** moves the cursor to the bottom right cell of the table.
|
|
|
|
@param bExpand
|
|
determines whether the selection is to be expanded.
|
|
*/
|
|
void gotoEnd( [in] boolean bExpand );
|
|
|
|
|
|
/** merges the selected range of cells.
|
|
|
|
@see com::sun::star::CellRange
|
|
*/
|
|
boolean mergeRange();
|
|
|
|
|
|
/** splits the range of cells.
|
|
|
|
@param nCount
|
|
specifies the number of new cells that will be created
|
|
for each cell contained in the range.
|
|
|
|
@param bHorizontal
|
|
`TRUE` if the range should be split vertically.
|
|
Otherwise it will be split horizontally.
|
|
|
|
@see com::sun::star::Cell
|
|
@see com::sun::star::CellRange
|
|
*/
|
|
boolean splitRange( [in] short nCount,
|
|
[in] boolean bHorizontal );
|
|
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|