/************************************************************************* * * $RCSfile: XTextTableCursor.idl,v $ * * $Revision: 1.3 $ * * last change: $Author: mi $ $Date: 2000-11-08 12:44:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_text_XTextTableCursor_idl__ #define __com_sun_star_text_XTextTableCursor_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif //============================================================================= module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: interface com::sun::star::text::XTextTableCursor /** The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells */ [ uik(E2281214-33D6-11D1-AABE00A0-249D5590), ident( "XTextTableCursor", 1.0 ) ] interface XTextTableCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::text::XTextTableCursor::getRangeName /** @returns the name of the cell range that is selected by this cursor.

The name is the cell name of the top left table cell of the range contatenated 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.

*/ [const] string getRangeName(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::gotoCellByName /** moves the cursor to the cell with the specified name. */ boolean gotoCellByName( [in] string aCellName, [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::goLeft /** moves the cursor to the left neighbor. */ boolean goLeft( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::goRight /** moves the cursor to the right neighbor. */ boolean goRight( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::goUp /** moves the cursor to the top neighbor. */ boolean goUp( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::goDown /** moves the cursor to the bottom neighbor cell. */ boolean goDown( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::gotoStart /** moves the cursor to the top left cell of the table. */ void gotoStart( [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::gotoEnd /** moves the cursor to the bottom right cell of the table. */ void gotoEnd( [in] boolean bExpand ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::mergeRange /** merges the selected range of cells. */ boolean mergeRange(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XTextTableCursor::splitRange /** splits the range of cells. The count specifies the number of new cells that will be created for each cell contained in the range. */ boolean splitRange( [in] short Count, [in] boolean Horizontal ); }; //============================================================================= }; }; }; }; /*============================================================================= $Log: not supported by cvs2svn $ Revision 1.1.1.1 2000/09/18 23:36:05 hjs initial import Revision 1.5 2000/09/11 11:53:04 mi documentation merged from XML Revision 1.3 2000/03/31 11:53:50 os #74034# Documentation changed Revision 1.2 2000/02/07 11:25:04 mi zu #70728# missing documentation marked Revision 1.1.1.1 1999/11/11 09:48:46 jsc new =============================================================================*/ #endif