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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*************************************************************************
*
* $RCSfile: XTextCursor.idl,v $
*
* $Revision: 1.9 $
*
* last change: $Author: obo $ $Date: 2004-01-20 13:22:32 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_text_XTextCursor_idl__
#define __com_sun_star_text_XTextCursor_idl__
#ifndef __com_sun_star_text_XTextRange_idl__
#include <com/sun/star/text/XTextRange.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** extends a text range by method to modify its position.
*/
interface XTextCursor: com::sun::star::text::XTextRange
{
//-------------------------------------------------------------------------
/** sets the end of the position to the start.
*/
[oneway] void collapseToStart();
//-------------------------------------------------------------------------
/** sets the start of the position to the end.
*/
[oneway] void collapseToEnd();
//-------------------------------------------------------------------------
/** determines if the start and end positions are the same.
*/
boolean isCollapsed();
//-------------------------------------------------------------------------
/** moves the cursor the specified number of characters to the left.
@param nCount
the number of characters to move.
@param bExpand
specifies if the current selection of the cursor should
be expanded or not.
@returns
<TRUE/> if the command was successfully completed.
<FALSE/> otherwise.
<p>Note: Even if the command was not completed successfully
it may be completed partially. E.g. if it was required to move
5 characters but it is only possible to move 3 <FALSE/> will
be returned and the cursor moves only those 3 characters.<p>
*/
boolean goLeft( [in] short nCount,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor the specified number of characters to the right.
@param nCount
the number of characters to move.
@param bExpand
specifies if the current selection of the cursor should
be expanded or not.
@returns
<TRUE/> if the command was successfully completed.
<FALSE/> otherwise.
<p>Note: Even if the command was not completed successfully
it may be completed partially. E.g. if it was required to move
5 characters but it is only possible to move 3 <FALSE/> will
be returned and the cursor moves only those 3 characters.<p>
*/
boolean goRight( [in] short nCount,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the start of the text.
*/
void gotoStart( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the end of the text.
*/
void gotoEnd( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves or expands the cursor to a specified <type>TextRange</type>.
*/
void gotoRange( [in] com::sun::star::text::XTextRange xRange,
[in] boolean bExpand );
};
//=============================================================================
}; }; }; };
#endif
|
