1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextCursor_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_XTextCursor_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextRange_idl__ 27cdf0e10cSrcweir#include <com/sun/star/text/XTextRange.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweir module com { module sun { module star { module text { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** extends a text range by method to modify its position. 38cdf0e10cSrcweir */ 39cdf0e10cSrcweirpublished interface XTextCursor: com::sun::star::text::XTextRange 40cdf0e10cSrcweir{ 41cdf0e10cSrcweir //------------------------------------------------------------------------- 42cdf0e10cSrcweir 43cdf0e10cSrcweir /** sets the end of the position to the start. 44cdf0e10cSrcweir */ 45cdf0e10cSrcweir [oneway] void collapseToStart(); 46cdf0e10cSrcweir 47cdf0e10cSrcweir //------------------------------------------------------------------------- 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** sets the start of the position to the end. 50cdf0e10cSrcweir */ 51cdf0e10cSrcweir [oneway] void collapseToEnd(); 52cdf0e10cSrcweir 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir 55cdf0e10cSrcweir /** determines if the start and end positions are the same. 56cdf0e10cSrcweir */ 57cdf0e10cSrcweir boolean isCollapsed(); 58cdf0e10cSrcweir 59cdf0e10cSrcweir //------------------------------------------------------------------------- 60cdf0e10cSrcweir 61cdf0e10cSrcweir /** moves the cursor the specified number of characters to the left. 62cdf0e10cSrcweir 63cdf0e10cSrcweir @param nCount 64cdf0e10cSrcweir the number of characters to move. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @param bExpand 67cdf0e10cSrcweir specifies if the current selection of the cursor should 68cdf0e10cSrcweir be expanded or not. 69cdf0e10cSrcweir 70cdf0e10cSrcweir @returns 71cdf0e10cSrcweir <TRUE/> if the command was successfully completed. 72cdf0e10cSrcweir <FALSE/> otherwise. 73cdf0e10cSrcweir 74cdf0e10cSrcweir <p>Note: Even if the command was not completed successfully 75cdf0e10cSrcweir it may be completed partially. E.g. if it was required to move 76cdf0e10cSrcweir 5 characters but it is only possible to move 3 <FALSE/> will 77cdf0e10cSrcweir be returned and the cursor moves only those 3 characters.<p> 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir boolean goLeft( [in] short nCount, 80cdf0e10cSrcweir [in] boolean bExpand ); 81cdf0e10cSrcweir 82cdf0e10cSrcweir //------------------------------------------------------------------------- 83cdf0e10cSrcweir 84cdf0e10cSrcweir /** moves the cursor the specified number of characters to the right. 85cdf0e10cSrcweir 86cdf0e10cSrcweir @param nCount 87cdf0e10cSrcweir the number of characters to move. 88cdf0e10cSrcweir 89cdf0e10cSrcweir @param bExpand 90cdf0e10cSrcweir specifies if the current selection of the cursor should 91cdf0e10cSrcweir be expanded or not. 92cdf0e10cSrcweir 93cdf0e10cSrcweir @returns 94cdf0e10cSrcweir <TRUE/> if the command was successfully completed. 95cdf0e10cSrcweir <FALSE/> otherwise. 96cdf0e10cSrcweir 97cdf0e10cSrcweir <p>Note: Even if the command was not completed successfully 98cdf0e10cSrcweir it may be completed partially. E.g. if it was required to move 99cdf0e10cSrcweir 5 characters but it is only possible to move 3 <FALSE/> will 100cdf0e10cSrcweir be returned and the cursor moves only those 3 characters.<p> 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir boolean goRight( [in] short nCount, 103cdf0e10cSrcweir [in] boolean bExpand ); 104cdf0e10cSrcweir 105cdf0e10cSrcweir //------------------------------------------------------------------------- 106cdf0e10cSrcweir 107cdf0e10cSrcweir /** moves the cursor to the start of the text. 108cdf0e10cSrcweir */ 109cdf0e10cSrcweir void gotoStart( [in] boolean bExpand ); 110cdf0e10cSrcweir 111cdf0e10cSrcweir //------------------------------------------------------------------------- 112cdf0e10cSrcweir 113cdf0e10cSrcweir /** moves the cursor to the end of the text. 114cdf0e10cSrcweir */ 115cdf0e10cSrcweir void gotoEnd( [in] boolean bExpand ); 116cdf0e10cSrcweir 117cdf0e10cSrcweir //------------------------------------------------------------------------- 118cdf0e10cSrcweir 119cdf0e10cSrcweir /** moves or expands the cursor to a specified <type>TextRange</type>. 120cdf0e10cSrcweir */ 121cdf0e10cSrcweir void gotoRange( [in] com::sun::star::text::XTextRange xRange, 122cdf0e10cSrcweir [in] boolean bExpand ); 123cdf0e10cSrcweir 124cdf0e10cSrcweir}; 125cdf0e10cSrcweir 126cdf0e10cSrcweir//============================================================================= 127cdf0e10cSrcweir 128cdf0e10cSrcweir}; }; }; }; 129cdf0e10cSrcweir 130cdf0e10cSrcweir#endif 131