offapi/com/sun/star/text/XTextCursor.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 /** extends a text range by method to modify its position.
  26  */
  27 published interface XTextCursor: com::sun::star::text::XTextRange
  28 {
  29
  30     /** sets the end of the position to the start.
  31      */
  32     void collapseToStart();
  33
  34
  35     /** sets the start of the position to the end.
  36      */
  37     void collapseToEnd();
  38
  39
  40     /** determines if the start and end positions are the same.
  41      */
  42     boolean isCollapsed();
  43
  44
  45     /** moves the cursor the specified number of characters to the left.
  46
  47         @param nCount
  48             the number of characters to move.
  49
  50         @param bExpand
  51             specifies if the current selection of the cursor should
  52             be expanded or not.
  53
  54         @returns
  55             `TRUE` if the command was successfully completed.
  56             `FALSE` otherwise.
  57
  58             <p>Note: Even if the command was not completed successfully
  59             it may be completed partially. E.g. if it was required to move
  60             5 characters but it is only possible to move 3 `FALSE` will
  61             be returned and the cursor moves only those 3 characters.<p>
  62      */
  63     boolean goLeft( [in] short nCount,
  64              [in] boolean bExpand );
  65
  66
  67     /** moves the cursor the specified number of characters to the right.
  68
  69         @param nCount
  70             the number of characters to move.
  71
  72         @param bExpand
  73             specifies if the current selection of the cursor should
  74             be expanded or not.
  75
  76         @returns
  77             `TRUE` if the command was successfully completed.
  78             `FALSE` otherwise.
  79
  80             <p>Note: Even if the command was not completed successfully
  81             it may be completed partially. E.g. if it was required to move
  82             5 characters but it is only possible to move 3 `FALSE` will
  83             be returned and the cursor moves only those 3 characters.<p>
  84      */
  85     boolean goRight( [in] short nCount,
  86              [in] boolean bExpand );
  87
  88
  89     /** moves the cursor to the start of the text.
  90      */
  91     void gotoStart( [in] boolean bExpand );
  92
  93
  94     /** moves the cursor to the end of the text.
  95      */
  96     void gotoEnd( [in] boolean bExpand );
  97
  98
  99     /** moves or expands the cursor to a specified TextRange.
 100      */
 101     void gotoRange( [in] com::sun::star::text::XTextRange xRange,
 102              [in] boolean bExpand );
 103
 104 };
 105
 106
 107 }; }; }; };
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */