blob: 4efff5b42e3a84986560c2cd37e066eff937ddef (
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
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
169
170
171
172
173
174
175
176
177
178
179
|
/*************************************************************************
*
* 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_text_XTextTableCursor_idl__
#define __com_sun_star_text_XTextTableCursor_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells
@see com::sun::star::text::TextTable
@see com::sun::star::text::TextTableCursor
@see com::sun::star::text::Cell
@see com::sun::star::text::XTextTable
*/
published interface XTextTableCursor: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** @returns
the name of the cell range that is selected by this cursor.
<p>The name is the cell name of the top left table cell of the range
contatenated by ':' with the table cell name of the bottom left table cell of the cell range.
If the range consists of one table cell only then the name of that table cell is returned.
</p>
@see com::sun:star::text::CellRange
*/
string getRangeName();
//-------------------------------------------------------------------------
/** moves the cursor to the cell with the specified name.
@param aCellName
specifies the name of the cell to go to.
@param bExpand
determines wether the selection is to be expanded.
@see com::sun::star::text::Cell
*/
boolean gotoCellByName( [in] string aCellName,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the left neighbor.
@param nCount
the number of cells to move.
@param bExpand
determines wether the selection is to be expanded.
*/
boolean goLeft( [in] short nCount,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the right neighbor.
@param nCount
the number of cells to move.
@param bExpand
determines wether the selection is to be expanded.
*/
boolean goRight( [in] short nCount,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the top neighbor.
@param nCount
the number of cells to move.
@param bExpand
determines wether the selection is to be expanded.
*/
boolean goUp( [in] short nCount,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the bottom neighbor cell.
@param nCount
the number of cells to move.
@param bExpand
determines wether the selection is to be expanded.
*/
boolean goDown( [in] short nCount,
[in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the top left cell of the table.
@param bExpand
determines wether the selection is to be expanded.
*/
void gotoStart( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** moves the cursor to the bottom right cell of the table.
@param bExpand
determines wether the selection is to be expanded.
*/
void gotoEnd( [in] boolean bExpand );
//-------------------------------------------------------------------------
/** merges the selected range of cells.
@see com:sun::star::CellRange
*/
boolean mergeRange();
//-------------------------------------------------------------------------
/** splits the range of cells.
@param nCount
specifies the number of new cells that will be created
for each cell contained in the range.
@param bHorizontal
<true/> if the range should be split vertically.
Otherwise it will be split horizontally.
@see com:sun::star::Cell
@see com:sun::star::CellRange
*/
boolean splitRange( [in] short nCount,
[in] boolean bHorizontal );
};
//=============================================================================
}; }; }; };
#endif
|
