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 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_view_XViewCursor_idl__
#define __com_sun_star_view_XViewCursor_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
//=============================================================================
module com { module sun { module star { module view {
//=============================================================================
/** makes it possible to move a cursor up/down/left/right within laid out text.
@see com::sun::star::table::CellCursor
@see com::sun::star::text::TextCursor
@see com::sun::star::view::XLineCursor
*/
published interface XViewCursor: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** moves the cursor the specified number of lines down.
@param nCount
specifies the number of lines to go down.
@param bExpand
determines whether the text range of the cursor is expanded (<TRUE/>)
or the cursor will be just at the new position after the move (<FALSE/>).
@returns
<TRUE/> if the cursor was moved,
or <FALSE/> if it was already in the bottom row.
*/
boolean goDown( [in] short nCount, [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor the specified number of lines up.
@param nCount
specifies the number of lines to go up.
@param bExpand
determines whether the text range of the cursor is expanded (<TRUE/>)
@returns
<TRUE/> if the cursor was moved,
or <FALSE/> if it was already in the top row.
*/
boolean goUp( [in] short nCount, [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor the specified number of characters to the left.
@param nCount
specifies the number of characters to move.
@param bExpand
determines whether the text range of the cursor is expanded (<TRUE/>)
@returns
<TRUE/> if the cursor was moved,
or <FALSE/> if it was already at the leftmost position.
*/
boolean goLeft( [in] short nCount, [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor the specified number of characters to the right.
@param nCount
specifies the number of characters to move.
@param bExpand
determines whether the text range of the cursor is expanded (<TRUE/>)
@returns
<TRUE/> if the cursor was moved,
or <FALSE/> if it was already at the rightmost position.
*/
boolean goRight( [in] short nCount, [in] boolean bExpand );
};
//=============================================================================
}; }; }; };
#endif
|
