1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10cdf0e10cSrcweir * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12cdf0e10cSrcweir * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19cdf0e10cSrcweir * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_view_XViewCursor_idl__ 24cdf0e10cSrcweir#define __com_sun_star_view_XViewCursor_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweirmodule com { module sun { module star { module view { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** makes it possible to move a cursor up/down/left/right within laid out text. 38cdf0e10cSrcweir 39cdf0e10cSrcweir @see com::sun::star::table::CellCursor 40cdf0e10cSrcweir @see com::sun::star::text::TextCursor 41cdf0e10cSrcweir @see com::sun::star::view::XLineCursor 42cdf0e10cSrcweir */ 43cdf0e10cSrcweirpublished interface XViewCursor: com::sun::star::uno::XInterface 44cdf0e10cSrcweir{ 45cdf0e10cSrcweir //------------------------------------------------------------------------- 46cdf0e10cSrcweir /** moves the cursor the specified number of lines down. 47cdf0e10cSrcweir 48cdf0e10cSrcweir @param nCount 49cdf0e10cSrcweir specifies the number of lines to go down. 50cdf0e10cSrcweir 51cdf0e10cSrcweir @param bExpand 52cdf0e10cSrcweir determines whether the text range of the cursor is expanded (<TRUE/>) 53cdf0e10cSrcweir or the cursor will be just at the new position after the move (<FALSE/>). 54cdf0e10cSrcweir 55cdf0e10cSrcweir @returns 56cdf0e10cSrcweir <TRUE/> if the cursor was moved, 57cdf0e10cSrcweir or <FALSE/> if it was already in the bottom row. 58cdf0e10cSrcweir */ 59cdf0e10cSrcweir boolean goDown( [in] short nCount, [in] boolean bExpand ); 60cdf0e10cSrcweir 61cdf0e10cSrcweir //------------------------------------------------------------------------- 62cdf0e10cSrcweir /** moves the cursor the specified number of lines up. 63cdf0e10cSrcweir 64cdf0e10cSrcweir @param nCount 65cdf0e10cSrcweir specifies the number of lines to go up. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @param bExpand 68cdf0e10cSrcweir determines whether the text range of the cursor is expanded (<TRUE/>) 69cdf0e10cSrcweir 70cdf0e10cSrcweir @returns 71cdf0e10cSrcweir <TRUE/> if the cursor was moved, 72cdf0e10cSrcweir or <FALSE/> if it was already in the top row. 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir boolean goUp( [in] short nCount, [in] boolean bExpand ); 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir /** moves the cursor the specified number of characters to the left. 78cdf0e10cSrcweir 79cdf0e10cSrcweir @param nCount 80cdf0e10cSrcweir specifies the number of characters to move. 81cdf0e10cSrcweir 82cdf0e10cSrcweir @param bExpand 83cdf0e10cSrcweir determines whether the text range of the cursor is expanded (<TRUE/>) 84cdf0e10cSrcweir 85cdf0e10cSrcweir @returns 86cdf0e10cSrcweir <TRUE/> if the cursor was moved, 87cdf0e10cSrcweir or <FALSE/> if it was already at the leftmost position. 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir boolean goLeft( [in] short nCount, [in] boolean bExpand ); 90cdf0e10cSrcweir 91cdf0e10cSrcweir //------------------------------------------------------------------------- 92cdf0e10cSrcweir /** moves the cursor the specified number of characters to the right. 93cdf0e10cSrcweir 94cdf0e10cSrcweir @param nCount 95cdf0e10cSrcweir specifies the number of characters to move. 96cdf0e10cSrcweir 97cdf0e10cSrcweir @param bExpand 98cdf0e10cSrcweir determines whether the text range of the cursor is expanded (<TRUE/>) 99cdf0e10cSrcweir 100cdf0e10cSrcweir @returns 101cdf0e10cSrcweir <TRUE/> if the cursor was moved, 102cdf0e10cSrcweir or <FALSE/> if it was already at the rightmost position. 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir boolean goRight( [in] short nCount, [in] boolean bExpand ); 105cdf0e10cSrcweir 106cdf0e10cSrcweir}; 107cdf0e10cSrcweir 108cdf0e10cSrcweir//============================================================================= 109cdf0e10cSrcweir 110cdf0e10cSrcweir}; }; }; }; 111cdf0e10cSrcweir 112cdf0e10cSrcweir#endif 113