blob: 44b18be77648835aaef8e060422d7d8aeecde04d (
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
|
/*************************************************************************
*
* 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_XTextTable_idl__
#define __com_sun_star_text_XTextTable_idl__
#ifndef __com_sun_star_text_XTextContent_idl__
#include <com/sun/star/text/XTextContent.idl>
#endif
#ifndef __com_sun_star_table_XTableRows_idl__
#include <com/sun/star/table/XTableRows.idl>
#endif
#ifndef __com_sun_star_table_XTableColumns_idl__
#include <com/sun/star/table/XTableColumns.idl>
#endif
#ifndef __com_sun_star_table_XCell_idl__
#include <com/sun/star/table/XCell.idl>
#endif
#ifndef __com_sun_star_text_XTextTableCursor_idl__
#include <com/sun/star/text/XTextTableCursor.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** manages a text table.
@see com::sun::star::text::TextTable
@see com::sun::star::text::Cell
*/
published interface XTextTable: com::sun::star::text::XTextContent
{
//-------------------------------------------------------------------------
/** determines the numbers of rows and columns of the text table.
<p> This method must be called after the object is created and
before the object is insert or attached elsewhere.
</p>
*/
void initialize( [in] long nRows,
[in] long nColumns );
//-------------------------------------------------------------------------
/** @returns
the access object for the text table rows.
@see com::sun::star::table::XTableRows
*/
com::sun::star::table::XTableRows getRows();
//-------------------------------------------------------------------------
/** @returns
the access object for the text table columns.
@see com::sun::star::table::XTableColumns
*/
com::sun::star::table::XTableColumns getColumns();
//-------------------------------------------------------------------------
/** @returns
the <type scope="com::sun::star::table">XCell</type> interface of the cell with the specified name.
@param aCellName
is a concatenation of the alphanumeric column name and the
index of the row.
<p>Example: The cell in the 4th column and third row has the name "D3".
<p>In cells that are split, the naming convention is more complex.
In this case the name is a concatenation of the former cell name
(i.e. "D3") and the number of the new column and row index inside
of the original table cell separated by dots. This is done
recursively.
<p>Example: If the cell "D3" is horizontally split, it now contains
the cells "D3.1.1" and "D3.1.2"
@see com::sun::star::table::Cell
@see com::sun::star::table::XCell
*/
com::sun::star::table::XCell getCellByName( [in] string aCellName );
//-------------------------------------------------------------------------
/** @returns
the names of all cells of this text table.
*/
sequence<string> getCellNames();
//-------------------------------------------------------------------------
/** creates a text table cursor and returns the
<type>XTextTableCursor</type> interface.
<p>Initially the cursor is positioned in the cell with the specified name.
</p>
@see com::sun::star::text::TextTableCursor
*/
com::sun::star::text::XTextTableCursor createCursorByCellName( [in] string aCellName );
};
//=============================================================================
}; }; }; };
#endif
|
