Version 5.2.6.1, tag libreoffice-5.2.6.1
[LibreOffice.git] / offapi / com / sun / star / text / XSentenceCursor.idl
blobd8a0da6f058c177fd086245a2b9eaaa6264fd9ef
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
19 #ifndef __com_sun_star_text_XSentenceCursor_idl__
20 #define __com_sun_star_text_XSentenceCursor_idl__
22 #include <com/sun/star/text/XTextCursor.idl>
26 module com { module sun { module star { module text {
29 /** makes it possible to perform cursor movements through sentences.
31 published interface XSentenceCursor: com::sun::star::text::XTextCursor
34 /** determines if the cursor is positioned at the start of a sentence.
36 boolean isStartOfSentence();
39 /** determines if the cursor is positioned at the end of a sentence.
41 boolean isEndOfSentence();
44 /** moves the cursor to the start of the next sentence.
46 @returns
47 `TRUE` if the cursor was moved. It returns `FALSE` it the
48 cursor can not advance further.
50 boolean gotoNextSentence( [in] boolean Expand );
53 /** moves the cursor to the start of the previous sentence.
55 @returns
56 `TRUE` if the cursor was moved. It returns `FALSE` it the
57 cursor can not advance further.
59 boolean gotoPreviousSentence( [in] boolean Expand );
62 /** moves the cursor to the start of the current sentence.
64 @returns
65 `TRUE` if the cursor is now at the start of a sentence,
66 `FALSE` otherwise. If `FALSE` was returned the cursor
67 will remain at its original position.
69 boolean gotoStartOfSentence( [in] boolean Expand );
72 /** moves the cursor to the end of the current sentence.
74 @returns
75 `TRUE` if the cursor is now at the end of a sentence,
76 `FALSE` otherwise. If `FALSE` was returned the cursor
77 will remain at its original position.
79 boolean gotoEndOfSentence( [in] boolean Expand );
84 }; }; }; };
86 #endif
88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */