offapi/com/sun/star/text/XParagraphCursor.idl

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