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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XParagraphCursor_idl__
  20 #define __com_sun_star_text_XParagraphCursor_idl__
  21
  22 #include <com/sun/star/text/XTextCursor.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module text {
  27
  28
  29 /** makes it possible to move paragraph by paragraph.
  30  */
  31 published interface XParagraphCursor: com::sun::star::text::XTextCursor
  32 {
  33
  34     /** determines if the cursor is positioned at the start of a paragraph.
  35      */
  36     boolean isStartOfParagraph();
  37
  38
  39     /** determines if the cursor is positioned at the end of a paragraph.
  40      */
  41     boolean isEndOfParagraph();
  42
  43
  44     /** moves the cursor to the start of the current paragraph.
  45
  46         @returns
  47             `TRUE` if the cursor is now at the start of a paragraph,
  48             `FALSE` otherwise. If `FALSE` was returned the cursor
  49             will remain at its original position.
  50      */
  51     boolean gotoStartOfParagraph( [in] boolean bExpand );
  52
  53
  54     /** moves the cursor to the end of the current paragraph.
  55
  56         @returns
  57             `TRUE` if the cursor is now at the end of a paragraph,
  58             `FALSE` otherwise. If `FALSE` was returned the cursor
  59             will remain at its original position.
  60      */
  61     boolean gotoEndOfParagraph( [in] boolean bExpand );
  62
  63
  64     /** moves the cursor to the next paragraph.
  65
  66         @returns
  67             `TRUE` if the cursor was moved. It returns `FALSE` it the
  68             cursor can not advance further.
  69      */
  70     boolean gotoNextParagraph( [in] boolean bExpand );
  71
  72
  73     /** moves the cursor to the previous paragraph.
  74
  75         @returns
  76             `TRUE` if the cursor was moved. It returns `FALSE` it the
  77             cursor can not advance further.
  78      */
  79     boolean gotoPreviousParagraph( [in] boolean bExpand );
  80
  81 };
  82
  83
  84 }; }; }; };
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */