offapi/com/sun/star/text/XWordCursor.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_XWordCursor_idl__
  20 #define __com_sun_star_text_XWordCursor_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 a cursor word by word.
  30  */
  31 published interface XWordCursor: com::sun::star::text::XTextCursor
  32 {
  33
  34     /** determines if the cursor is positioned at the start of a word.
  35      */
  36     boolean isStartOfWord();
  37
  38
  39     /** determines if the cursor is positioned at the end of a word.
  40      */
  41     boolean isEndOfWord();
  42
  43
  44     /** moves the cursor to the next word.
  45
  46         <p>Note: the function returning `TRUE` does not necessarily mean
  47         that the cursor is located at the next word, or any word at all!
  48         This may happen for example if it travels over empty paragraphs.</p>
  49
  50         @returns
  51             `TRUE` if the cursor was moved. It returns `FALSE` it the
  52             cursor can not advance further.
  53      */
  54     boolean gotoNextWord( [in] boolean bExpand );
  55
  56
  57     /** moves the cursor to the previous word.
  58
  59         <p>Note: the function returning `TRUE` does not necessarily mean
  60         that the cursor is located at the previous word, or any word at all!
  61         This may happen for example if it travels over empty paragraphs.</p>
  62
  63         @returns
  64             `TRUE` if the cursor was moved. It returns `FALSE` it the
  65             cursor can not advance further.
  66      */
  67     boolean gotoPreviousWord( [in] boolean bExpand );
  68
  69
  70     /** moves the cursor to the end of the current word.
  71
  72         @returns
  73             `TRUE` if the cursor is now at the end of a word,
  74             `FALSE` otherwise. If `FALSE` was returned the cursor
  75             will remain at its original position.
  76      */
  77     boolean gotoEndOfWord( [in] boolean bExpand );
  78
  79
  80     /** moves the cursor to the start of the current word.
  81
  82         @returns
  83             `TRUE` if the cursor is now at the start of a word,
  84             `FALSE` otherwise. If `FALSE` was returned the cursor
  85             will remain at its original position.
  86      */
  87     boolean gotoStartOfWord( [in] boolean bExpand );
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */