1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XSentenceCursor_idl__
24#define __com_sun_star_text_XSentenceCursor_idl__
25
26#ifndef __com_sun_star_text_XTextCursor_idl__
27#include <com/sun/star/text/XTextCursor.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module text {
34
35//=============================================================================
36
37/** makes it possible to perform cursor movements through sentences.
38 */
39published interface XSentenceCursor: com::sun::star::text::XTextCursor
40{
41	//-------------------------------------------------------------------------
42
43	/** determines if the cursor is positioned at the start of a sentence.
44	 */
45	boolean isStartOfSentence();
46
47	//-------------------------------------------------------------------------
48
49	/** determines if the cursor is positioned at the end of a sentence.
50	 */
51	boolean isEndOfSentence();
52
53	//-------------------------------------------------------------------------
54
55	/** moves the cursor to the start of the next sentence.
56
57        @returns
58            <true/> if the cursor was moved. It returns <false/> it the
59            cursor can not advance further.
60     */
61	boolean gotoNextSentence( [in] boolean Expand );
62
63	//-------------------------------------------------------------------------
64
65	/** moves the cursor to the start of the previous sentence.
66
67        @returns
68            <true/> if the cursor was moved. It returns <false/> it the
69            cursor can not advance further.
70     */
71	boolean gotoPreviousSentence( [in] boolean Expand );
72
73	//-------------------------------------------------------------------------
74
75	/** moves the cursor to the start of the current sentence.
76
77        @returns
78            <true/> if the cursor is now at the start of a sentence,
79            <false/> otherwise. If <false/> was returned the cursor
80            will remain at its original position.
81	 */
82	boolean gotoStartOfSentence( [in] boolean Expand );
83
84	//-------------------------------------------------------------------------
85
86	/** moves the cursor to the end of the current sentence.
87
88        @returns
89            <true/> if the cursor is now at the end of a sentence,
90            <false/> otherwise. If <false/> was returned the cursor
91            will remain at its original position.
92	 */
93	boolean gotoEndOfSentence( [in] boolean Expand );
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102