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_XSentenceCursor_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_XSentenceCursor_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextCursor_idl__ 27cdf0e10cSrcweir#include <com/sun/star/text/XTextCursor.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweir module com { module sun { module star { module text { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** makes it possible to perform cursor movements through sentences. 38cdf0e10cSrcweir */ 39cdf0e10cSrcweirpublished interface XSentenceCursor: com::sun::star::text::XTextCursor 40cdf0e10cSrcweir{ 41cdf0e10cSrcweir //------------------------------------------------------------------------- 42cdf0e10cSrcweir 43cdf0e10cSrcweir /** determines if the cursor is positioned at the start of a sentence. 44cdf0e10cSrcweir */ 45cdf0e10cSrcweir boolean isStartOfSentence(); 46cdf0e10cSrcweir 47cdf0e10cSrcweir //------------------------------------------------------------------------- 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** determines if the cursor is positioned at the end of a sentence. 50cdf0e10cSrcweir */ 51cdf0e10cSrcweir boolean isEndOfSentence(); 52cdf0e10cSrcweir 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir 55cdf0e10cSrcweir /** moves the cursor to the start of the next sentence. 56cdf0e10cSrcweir 57cdf0e10cSrcweir @returns 58cdf0e10cSrcweir <true/> if the cursor was moved. It returns <false/> it the 59cdf0e10cSrcweir cursor can not advance further. 60cdf0e10cSrcweir */ 61cdf0e10cSrcweir boolean gotoNextSentence( [in] boolean Expand ); 62cdf0e10cSrcweir 63cdf0e10cSrcweir //------------------------------------------------------------------------- 64cdf0e10cSrcweir 65cdf0e10cSrcweir /** moves the cursor to the start of the previous sentence. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @returns 68cdf0e10cSrcweir <true/> if the cursor was moved. It returns <false/> it the 69cdf0e10cSrcweir cursor can not advance further. 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir boolean gotoPreviousSentence( [in] boolean Expand ); 72cdf0e10cSrcweir 73cdf0e10cSrcweir //------------------------------------------------------------------------- 74cdf0e10cSrcweir 75cdf0e10cSrcweir /** moves the cursor to the start of the current sentence. 76cdf0e10cSrcweir 77cdf0e10cSrcweir @returns 78cdf0e10cSrcweir <true/> if the cursor is now at the start of a sentence, 79cdf0e10cSrcweir <false/> otherwise. If <false/> was returned the cursor 80cdf0e10cSrcweir will remain at its original position. 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir boolean gotoStartOfSentence( [in] boolean Expand ); 83cdf0e10cSrcweir 84cdf0e10cSrcweir //------------------------------------------------------------------------- 85cdf0e10cSrcweir 86cdf0e10cSrcweir /** moves the cursor to the end of the current sentence. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @returns 89cdf0e10cSrcweir <true/> if the cursor is now at the end of a sentence, 90cdf0e10cSrcweir <false/> otherwise. If <false/> was returned the cursor 91cdf0e10cSrcweir will remain at its original position. 92cdf0e10cSrcweir */ 93cdf0e10cSrcweir boolean gotoEndOfSentence( [in] boolean Expand ); 94cdf0e10cSrcweir 95cdf0e10cSrcweir}; 96cdf0e10cSrcweir 97cdf0e10cSrcweir//============================================================================= 98cdf0e10cSrcweir 99cdf0e10cSrcweir}; }; }; }; 100cdf0e10cSrcweir 101cdf0e10cSrcweir#endif 102