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