1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_text_XParagraphCursor_idl__ 28#define __com_sun_star_text_XParagraphCursor_idl__ 29 30#ifndef __com_sun_star_text_XTextCursor_idl__ 31#include <com/sun/star/text/XTextCursor.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module text { 38 39//============================================================================= 40 41/** makes it possible to move paragraph by paragraph. 42 */ 43published interface XParagraphCursor: com::sun::star::text::XTextCursor 44{ 45 //------------------------------------------------------------------------- 46 47 /** determines if the cursor is positioned at the start of a paragraph. 48 */ 49 boolean isStartOfParagraph(); 50 51 //------------------------------------------------------------------------- 52 53 /** determines if the cursor is positioned at the end of a paragraph. 54 */ 55 boolean isEndOfParagraph(); 56 57 //------------------------------------------------------------------------- 58 59 /** moves the cursor to the start of the current paragraph. 60 61 @returns 62 <true/> if the cursor is now at the start of a paragraph, 63 <false/> otherwise. If <false/> was returned the cursor 64 will remain at its original position. 65 */ 66 boolean gotoStartOfParagraph( [in] boolean bExpand ); 67 68 //------------------------------------------------------------------------- 69 70 /** moves the cursor to the end of the current paragraph. 71 72 @returns 73 <true/> if the cursor is now at the end of a paragraph, 74 <false/> otherwise. If <false/> was returned the cursor 75 will remain at its original position. 76 */ 77 boolean gotoEndOfParagraph( [in] boolean bExpand ); 78 79 //------------------------------------------------------------------------- 80 81 /** moves the cursor to the next paragraph. 82 83 @returns 84 <true/> if the cursor was moved. It returns <false/> it the 85 cursor can not advance further. 86 */ 87 boolean gotoNextParagraph( [in] boolean bExpand ); 88 89 //------------------------------------------------------------------------- 90 91 /** moves the cursor to the previous paragraph. 92 93 @returns 94 <true/> if the cursor was moved. It returns <false/> it the 95 cursor can not advance further. 96 */ 97 boolean gotoPreviousParagraph( [in] boolean bExpand ); 98 99}; 100 101//============================================================================= 102 103}; }; }; }; 104 105#endif 106