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