blob: 64ed5c049566711663eb0b699b76ebbd846b5283 (
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
|
/* -*- 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_XTextTable_idl__
#define __com_sun_star_text_XTextTable_idl__
#include <com/sun/star/text/XTextContent.idl>
#include <com/sun/star/table/XTableRows.idl>
#include <com/sun/star/table/XTableColumns.idl>
#include <com/sun/star/table/XCell.idl>
#include <com/sun/star/text/XTextTableCursor.idl>
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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
