1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_XSentenceCursor_idl__
28#define __com_sun_star_text_XSentenceCursor_idl__
29
30#ifndef __com_sun_star_text_XTextCursor_idl__
31#include <com/sun/star/text/XTextCursor.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module text {
38
39//=============================================================================
40
41/** makes it possible to perform cursor movements through sentences.
42 */
43published interface XSentenceCursor: com::sun::star::text::XTextCursor
44{
45	//-------------------------------------------------------------------------
46
47	/** determines if the cursor is positioned at the start of a sentence.
48	 */
49	boolean isStartOfSentence();
50
51	//-------------------------------------------------------------------------
52
53	/** determines if the cursor is positioned at the end of a sentence.
54	 */
55	boolean isEndOfSentence();
56
57	//-------------------------------------------------------------------------
58
59	/** moves the cursor to the start of the next sentence.
60
61        @returns
62            <true/> if the cursor was moved. It returns <false/> it the
63            cursor can not advance further.
64     */
65	boolean gotoNextSentence( [in] boolean Expand );
66
67	//-------------------------------------------------------------------------
68
69	/** moves the cursor to the start of the previous sentence.
70
71        @returns
72            <true/> if the cursor was moved. It returns <false/> it the
73            cursor can not advance further.
74     */
75	boolean gotoPreviousSentence( [in] boolean Expand );
76
77	//-------------------------------------------------------------------------
78
79	/** moves the cursor to the start of the current sentence.
80
81        @returns
82            <true/> if the cursor is now at the start of a sentence,
83            <false/> otherwise. If <false/> was returned the cursor
84            will remain at its original position.
85	 */
86	boolean gotoStartOfSentence( [in] boolean Expand );
87
88	//-------------------------------------------------------------------------
89
90	/** moves the cursor to the end of the current sentence.
91
92        @returns
93            <true/> if the cursor is now at the end of a sentence,
94            <false/> otherwise. If <false/> was returned the cursor
95            will remain at its original position.
96	 */
97	boolean gotoEndOfSentence( [in] boolean Expand );
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106