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
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24
  25 /** makes it possible to move paragraph by paragraph.
  26  */
  27 published interface XParagraphCursor: com::sun::star::text::XTextCursor
  28 {
  29
  30     /** determines if the cursor is positioned at the start of a paragraph.
  31      */
  32     boolean isStartOfParagraph();
  33
  34
  35     /** determines if the cursor is positioned at the end of a paragraph.
  36      */
  37     boolean isEndOfParagraph();
  38
  39
  40     /** moves the cursor to the start of the current paragraph.
  41
  42         @returns
  43             `TRUE` if the cursor is now at the start of a paragraph,
  44             `FALSE` otherwise. If `FALSE` was returned the cursor
  45             will remain at its original position.
  46      */
  47     boolean gotoStartOfParagraph( [in] boolean bExpand );
  48
  49
  50     /** moves the cursor to the end of the current paragraph.
  51
  52         @returns
  53             `TRUE` if the cursor is now at the end of a paragraph,
  54             `FALSE` otherwise. If `FALSE` was returned the cursor
  55             will remain at its original position.
  56      */
  57     boolean gotoEndOfParagraph( [in] boolean bExpand );
  58
  59
  60     /** moves the cursor to the next paragraph.
  61
  62         @returns
  63             `TRUE` if the cursor was moved. It returns `FALSE` it the
  64             cursor can not advance further.
  65      */
  66     boolean gotoNextParagraph( [in] boolean bExpand );
  67
  68
  69     /** moves the cursor to the previous paragraph.
  70
  71         @returns
  72             `TRUE` if the cursor was moved. It returns `FALSE` it the
  73             cursor can not advance further.
  74      */
  75     boolean gotoPreviousParagraph( [in] boolean bExpand );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */