offapi/com/sun/star/view/XViewCursor.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 view {
  23
  24
  25 /** makes it possible to move a cursor up/down/left/right within laid out text.
  26
  27     @see com::sun::star::table::CellCursor
  28     @see com::sun::star::text::TextCursor
  29     @see com::sun::star::view::XLineCursor
  30  */
  31 published interface XViewCursor: com::sun::star::uno::XInterface
  32 {
  33     /** moves the cursor the specified number of lines down.
  34
  35         @param nCount
  36             specifies the number of lines to go down.
  37
  38         @param bExpand
  39             determines whether the text range of the cursor is expanded (`TRUE`)
  40             or the cursor will be just at the new position after the move (`FALSE`).
  41
  42         @returns
  43             `TRUE` if the cursor was moved,
  44             or `FALSE` if it was already in the bottom row.
  45      */
  46     boolean goDown( [in] short nCount, [in] boolean bExpand );
  47
  48     /** moves the cursor the specified number of lines up.
  49
  50         @param nCount
  51             specifies the number of lines to go up.
  52
  53         @param bExpand
  54             determines whether the text range of the cursor is expanded (`TRUE`)
  55
  56         @returns
  57             `TRUE` if the cursor was moved,
  58             or `FALSE` if it was already in the top row.
  59      */
  60     boolean goUp( [in] short nCount, [in] boolean bExpand );
  61
  62     /** moves the cursor the specified number of characters to the left.
  63
  64         @param nCount
  65             specifies the number of characters to move.
  66
  67         @param bExpand
  68             determines whether the text range of the cursor is expanded (`TRUE`)
  69
  70         @returns
  71             `TRUE` if the cursor was moved,
  72             or `FALSE` if it was already at the leftmost position.
  73      */
  74     boolean goLeft( [in] short nCount, [in] boolean bExpand );
  75
  76     /** moves the cursor the specified number of characters to the right.
  77
  78         @param nCount
  79             specifies the number of characters to move.
  80
  81         @param bExpand
  82             determines whether the text range of the cursor is expanded (`TRUE`)
  83
  84         @returns
  85             `TRUE` if the cursor was moved,
  86             or `FALSE` if it was already at the rightmost position.
  87      */
  88     boolean goRight( [in] short nCount, [in] boolean bExpand );
  89
  90 };
  91
  92
  93 }; }; }; };
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */