diff options
Diffstat (limited to 'offapi/com/sun/star/text/XParagraphCursor.idl')
-rw-r--r-- | offapi/com/sun/star/text/XParagraphCursor.idl | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XParagraphCursor.idl b/offapi/com/sun/star/text/XParagraphCursor.idl new file mode 100644 index 000000000..d7986130b --- /dev/null +++ b/offapi/com/sun/star/text/XParagraphCursor.idl @@ -0,0 +1,88 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_text_XParagraphCursor_idl__ +#define __com_sun_star_text_XParagraphCursor_idl__ + +#include <com/sun/star/text/XTextCursor.idl> + + + + module com { module sun { module star { module text { + + +/** makes it possible to move paragraph by paragraph. + */ +published interface XParagraphCursor: com::sun::star::text::XTextCursor +{ + + /** determines if the cursor is positioned at the start of a paragraph. + */ + boolean isStartOfParagraph(); + + + /** determines if the cursor is positioned at the end of a paragraph. + */ + boolean isEndOfParagraph(); + + + /** moves the cursor to the start of the current paragraph. + + @returns + `TRUE` if the cursor is now at the start of a paragraph, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoStartOfParagraph( [in] boolean bExpand ); + + + /** moves the cursor to the end of the current paragraph. + + @returns + `TRUE` if the cursor is now at the end of a paragraph, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoEndOfParagraph( [in] boolean bExpand ); + + + /** moves the cursor to the next paragraph. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoNextParagraph( [in] boolean bExpand ); + + + /** moves the cursor to the previous paragraph. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoPreviousParagraph( [in] boolean bExpand ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |