diff options
Diffstat (limited to 'offapi/com/sun/star/view/XViewCursor.idl')
-rw-r--r-- | offapi/com/sun/star/view/XViewCursor.idl | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/XViewCursor.idl b/offapi/com/sun/star/view/XViewCursor.idl new file mode 100644 index 000000000000..5d5b855a357f --- /dev/null +++ b/offapi/com/sun/star/view/XViewCursor.idl @@ -0,0 +1,116 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_view_XViewCursor_idl__ +#define __com_sun_star_view_XViewCursor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module view { + +//============================================================================= + +/** makes it possible to move a cursor up/down/left/right within laid out text. + + @see com::sun::star::table::CellCursor + @see com::sun::star::text::TextCursor + @see com::sun::star::view::XLineCursor + */ +published interface XViewCursor: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** moves the cursor the specified number of lines down. + + @param nCount + specifies the number of lines to go down. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already in the bottom row. + */ + boolean goDown( [in] short nCount, [in] boolean bExpand ); + + //------------------------------------------------------------------------- + /** moves the cursor the specified number of lines up. + + @param nCount + specifies the number of lines to go up. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already in the top row. + */ + boolean goUp( [in] short nCount, [in] boolean bExpand ); + + //------------------------------------------------------------------------- + /** moves the cursor the specified number of characters to the left. + + @param nCount + specifies the number of characters to move. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already at the leftmost position. + */ + boolean goLeft( [in] short nCount, [in] boolean bExpand ); + + //------------------------------------------------------------------------- + /** moves the cursor the specified number of characters to the right. + + @param nCount + specifies the number of characters to move. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already at the rightmost position. + */ + boolean goRight( [in] short nCount, [in] boolean bExpand ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif |