blob: 1c5e896f22ed25b67fb5f45ff0b2ee59698cf5d5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XWordCursor.idl,v $
* $Revision: 1.11 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_text_XWordCursor_idl__
#define __com_sun_star_text_XWordCursor_idl__
#ifndef __com_sun_star_text_XTextCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** makes it possible to move a cursor word by word.
*/
published interface XWordCursor: com::sun::star::text::XTextCursor
{
//-------------------------------------------------------------------------
/** determines if the cursor is positioned at the start of a word.
*/
boolean isStartOfWord();
//-------------------------------------------------------------------------
/** determines if the cursor is positioned at the end of a word.
*/
boolean isEndOfWord();
//-------------------------------------------------------------------------
/** moves the cursor to the next word.
<p>Note: the function returning <true/> does not necessarily mean
that the cursor is located at the next word, or any word at all!
This may happen for example if it travels over empty paragraphs.</p>
@returns
<true/> if the cursor was moved. It returns <false/> it the
cursor can not advance further.
*/
boolean gotoNextWord( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the previous word.
<p>Note: the function returning <true/> does not necessarily mean
that the cursor is located at the previous word, or any word at all!
This may happen for example if it travels over empty paragraphs.</p>
@returns
<true/> if the cursor was moved. It returns <false/> it the
cursor can not advance further.
*/
boolean gotoPreviousWord( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the end of the current word.
@returns
<true/> if the cursor is now at the end of a word,
<false/> otherwise. If <false/> was returned the cursor
will remain at its original position.
*/
boolean gotoEndOfWord( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the start of the current word.
@returns
<true/> if the cursor is now at the start of a word,
<false/> otherwise. If <false/> was returned the cursor
will remain at its original position.
*/
boolean gotoStartOfWord( [in] boolean bExpand );
};
//=============================================================================
}; }; }; };
#endif
|