1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextCursor_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_text_XTextCursor_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextRange_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/text/XTextRange.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir//============================================================================= 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir module com { module sun { module star { module text { 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================= 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir/** extends a text range by method to modify its position. 42*cdf0e10cSrcweir */ 43*cdf0e10cSrcweirpublished interface XTextCursor: com::sun::star::text::XTextRange 44*cdf0e10cSrcweir{ 45*cdf0e10cSrcweir //------------------------------------------------------------------------- 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir /** sets the end of the position to the start. 48*cdf0e10cSrcweir */ 49*cdf0e10cSrcweir [oneway] void collapseToStart(); 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir //------------------------------------------------------------------------- 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir /** sets the start of the position to the end. 54*cdf0e10cSrcweir */ 55*cdf0e10cSrcweir [oneway] void collapseToEnd(); 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir //------------------------------------------------------------------------- 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir /** determines if the start and end positions are the same. 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir boolean isCollapsed(); 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir //------------------------------------------------------------------------- 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** moves the cursor the specified number of characters to the left. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir @param nCount 68*cdf0e10cSrcweir the number of characters to move. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @param bExpand 71*cdf0e10cSrcweir specifies if the current selection of the cursor should 72*cdf0e10cSrcweir be expanded or not. 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir @returns 75*cdf0e10cSrcweir <TRUE/> if the command was successfully completed. 76*cdf0e10cSrcweir <FALSE/> otherwise. 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir <p>Note: Even if the command was not completed successfully 79*cdf0e10cSrcweir it may be completed partially. E.g. if it was required to move 80*cdf0e10cSrcweir 5 characters but it is only possible to move 3 <FALSE/> will 81*cdf0e10cSrcweir be returned and the cursor moves only those 3 characters.<p> 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir boolean goLeft( [in] short nCount, 84*cdf0e10cSrcweir [in] boolean bExpand ); 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir //------------------------------------------------------------------------- 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir /** moves the cursor the specified number of characters to the right. 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir @param nCount 91*cdf0e10cSrcweir the number of characters to move. 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir @param bExpand 94*cdf0e10cSrcweir specifies if the current selection of the cursor should 95*cdf0e10cSrcweir be expanded or not. 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir @returns 98*cdf0e10cSrcweir <TRUE/> if the command was successfully completed. 99*cdf0e10cSrcweir <FALSE/> otherwise. 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir <p>Note: Even if the command was not completed successfully 102*cdf0e10cSrcweir it may be completed partially. E.g. if it was required to move 103*cdf0e10cSrcweir 5 characters but it is only possible to move 3 <FALSE/> will 104*cdf0e10cSrcweir be returned and the cursor moves only those 3 characters.<p> 105*cdf0e10cSrcweir */ 106*cdf0e10cSrcweir boolean goRight( [in] short nCount, 107*cdf0e10cSrcweir [in] boolean bExpand ); 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir //------------------------------------------------------------------------- 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir /** moves the cursor to the start of the text. 112*cdf0e10cSrcweir */ 113*cdf0e10cSrcweir void gotoStart( [in] boolean bExpand ); 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir //------------------------------------------------------------------------- 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir /** moves the cursor to the end of the text. 118*cdf0e10cSrcweir */ 119*cdf0e10cSrcweir void gotoEnd( [in] boolean bExpand ); 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir //------------------------------------------------------------------------- 122*cdf0e10cSrcweir 123*cdf0e10cSrcweir /** moves or expands the cursor to a specified <type>TextRange</type>. 124*cdf0e10cSrcweir */ 125*cdf0e10cSrcweir void gotoRange( [in] com::sun::star::text::XTextRange xRange, 126*cdf0e10cSrcweir [in] boolean bExpand ); 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir}; 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir//============================================================================= 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir}; }; }; }; 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir#endif 135