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