blob: 00d744b7a512ee371f17e9b74eda81855816baa0 (
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
|
/* -*- 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 .
*/
#ifndef __com_sun_star_text_XWordCursor_idl__
#define __com_sun_star_text_XWordCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
//=============================================================================
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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
