diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
commit | 267c6f2ac71f92999e969232431ba04678e7437e (patch) | |
tree | 358c9467650e1d0a1d7227a21dac2e3d08b622b2 /offapi/com/sun/star/text/XSentenceCursor.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.tar.xz libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.zip |
Adding upstream version 4:24.2.0.upstream/4%24.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/text/XSentenceCursor.idl')
-rw-r--r-- | offapi/com/sun/star/text/XSentenceCursor.idl | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XSentenceCursor.idl b/offapi/com/sun/star/text/XSentenceCursor.idl new file mode 100644 index 0000000000..8121044e04 --- /dev/null +++ b/offapi/com/sun/star/text/XSentenceCursor.idl @@ -0,0 +1,82 @@ +/* -*- 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 . + */ + + + + module com { module sun { module star { module text { + + +/** makes it possible to perform cursor movements through sentences. + */ +published interface XSentenceCursor: com::sun::star::text::XTextCursor +{ + + /** determines if the cursor is positioned at the start of a sentence. + */ + boolean isStartOfSentence(); + + + /** determines if the cursor is positioned at the end of a sentence. + */ + boolean isEndOfSentence(); + + + /** moves the cursor to the start of the next sentence. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoNextSentence( [in] boolean Expand ); + + + /** moves the cursor to the start of the previous sentence. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoPreviousSentence( [in] boolean Expand ); + + + /** moves the cursor to the start of the current sentence. + + @returns + `TRUE` if the cursor is now at the start of a sentence, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoStartOfSentence( [in] boolean Expand ); + + + /** moves the cursor to the end of the current sentence. + + @returns + `TRUE` if the cursor is now at the end of a sentence, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoEndOfSentence( [in] boolean Expand ); + +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |