diff options
Diffstat (limited to 'offapi/com/sun/star/view/XLineCursor.idl')
-rw-r--r-- | offapi/com/sun/star/view/XLineCursor.idl | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/XLineCursor.idl b/offapi/com/sun/star/view/XLineCursor.idl new file mode 100644 index 000000000000..320831f308ba --- /dev/null +++ b/offapi/com/sun/star/view/XLineCursor.idl @@ -0,0 +1,83 @@ +/************************************************************************* + * + * 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_XLineCursor_idl__ +#define __com_sun_star_view_XLineCursor_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 by lines within laid out text. + + @see com::sun::star::table::CellCursor + @see com::sun::star::text::TextCursor + @see com::sun::star::text::XTextViewCursor + */ +published interface XLineCursor: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** determines if the cursor is positioned at the start of a line. + */ + boolean isAtStartOfLine(); + + //------------------------------------------------------------------------- + /** determines if the cursor is positioned at the end of a line. + */ + boolean isAtEndOfLine(); + + //------------------------------------------------------------------------- + /** moves the cursor to the end of the current line. + + @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/>). + */ + void gotoEndOfLine( [in] boolean bExpand ); + + //------------------------------------------------------------------------- + /** moves the cursor to the start of the current line. + + @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/>). + */ + void gotoStartOfLine( [in] boolean bExpand ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif |