offapi/com/sun/star/text/XSentenceCursor.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 perform cursor movements through sentences.
  26  */
  27 published interface XSentenceCursor: com::sun::star::text::XTextCursor
  28 {
  29
  30     /** determines if the cursor is positioned at the start of a sentence.
  31      */
  32     boolean isStartOfSentence();
  33
  34
  35     /** determines if the cursor is positioned at the end of a sentence.
  36      */
  37     boolean isEndOfSentence();
  38
  39
  40     /** moves the cursor to the start of the next sentence.
  41
  42         @returns
  43             `TRUE` if the cursor was moved. It returns `FALSE` it the
  44             cursor can not advance further.
  45      */
  46     boolean gotoNextSentence( [in] boolean Expand );
  47
  48
  49     /** moves the cursor to the start of the previous sentence.
  50
  51         @returns
  52             `TRUE` if the cursor was moved. It returns `FALSE` it the
  53             cursor can not advance further.
  54      */
  55     boolean gotoPreviousSentence( [in] boolean Expand );
  56
  57
  58     /** moves the cursor to the start of the current sentence.
  59
  60         @returns
  61             `TRUE` if the cursor is now at the start of a sentence,
  62             `FALSE` otherwise. If `FALSE` was returned the cursor
  63             will remain at its original position.
  64      */
  65     boolean gotoStartOfSentence( [in] boolean Expand );
  66
  67
  68     /** moves the cursor to the end of the current sentence.
  69
  70         @returns
  71             `TRUE` if the cursor is now at the end of a sentence,
  72             `FALSE` otherwise. If `FALSE` was returned the cursor
  73             will remain at its original position.
  74      */
  75     boolean gotoEndOfSentence( [in] boolean Expand );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */