1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XSentenceCursor_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_text_XSentenceCursor_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XTextCursor_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XTextCursor.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski//============================================================================= 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski module com { module sun { module star { module text { 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski/** makes it possible to perform cursor movements through sentences. 38*b1cdbd2cSJim Jagielski */ 39*b1cdbd2cSJim Jagielskipublished interface XSentenceCursor: com::sun::star::text::XTextCursor 40*b1cdbd2cSJim Jagielski{ 41*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski /** determines if the cursor is positioned at the start of a sentence. 44*b1cdbd2cSJim Jagielski */ 45*b1cdbd2cSJim Jagielski boolean isStartOfSentence(); 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** determines if the cursor is positioned at the end of a sentence. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski boolean isEndOfSentence(); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski /** moves the cursor to the start of the next sentence. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @returns 58*b1cdbd2cSJim Jagielski <true/> if the cursor was moved. It returns <false/> it the 59*b1cdbd2cSJim Jagielski cursor can not advance further. 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski boolean gotoNextSentence( [in] boolean Expand ); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** moves the cursor to the start of the previous sentence. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @returns 68*b1cdbd2cSJim Jagielski <true/> if the cursor was moved. It returns <false/> it the 69*b1cdbd2cSJim Jagielski cursor can not advance further. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski boolean gotoPreviousSentence( [in] boolean Expand ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** moves the cursor to the start of the current sentence. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @returns 78*b1cdbd2cSJim Jagielski <true/> if the cursor is now at the start of a sentence, 79*b1cdbd2cSJim Jagielski <false/> otherwise. If <false/> was returned the cursor 80*b1cdbd2cSJim Jagielski will remain at its original position. 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski boolean gotoStartOfSentence( [in] boolean Expand ); 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski /** moves the cursor to the end of the current sentence. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski @returns 89*b1cdbd2cSJim Jagielski <true/> if the cursor is now at the end of a sentence, 90*b1cdbd2cSJim Jagielski <false/> otherwise. If <false/> was returned the cursor 91*b1cdbd2cSJim Jagielski will remain at its original position. 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski boolean gotoEndOfSentence( [in] boolean Expand ); 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski}; 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski//============================================================================= 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski}; }; }; }; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski#endif 102