summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/XTable.idl
blob: 246a3d4acceb74ad0b35bcb3cc5718ff4554f1a6 (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
/*************************************************************************
 *
 * 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_table_XTable_idl__
#define __com_sun_star_table_XTable_idl__

#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/table/XCellRange.idl>
#include <com/sun/star/table/XColumnRowRange.idl>
#include <com/sun/star/table/XCellCursor.idl>
#include <com/sun/star/util/XModifiable.idl>
#include <com/sun/star/beans/XMultiPropertySet.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/beans/XFastPropertySet.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

//=============================================================================

module com {  module sun {  module star {  module table {

//=============================================================================

/**
*/
interface XTable
{

    interface com::sun::star::lang::XComponent;

    //-------------------------------------------------------------------------

    interface com::sun::star::table::XCellRange;

    //-------------------------------------------------------------------------

    interface com::sun::star::table::XColumnRowRange;

    //-------------------------------------------------------------------------

    /** interface to make the modify state of the table accessible.
        <p>Additionally, it makes it possible to register listener objects, which
        get notification whenever the content of the table changes.
    */
    interface ::com::sun::star::util::XModifiable;

    //-------------------------------------------------------------------------

    /* interface ::com::sun::star::beans::XMultiPropertySet; */

    //-------------------------------------------------------------------------

    interface ::com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    interface ::com::sun::star::beans::XFastPropertySet;

    //-------------------------------------------------------------------------

    /** creates a cell cursor including the whole table

        @see com::sun::star::table::CellCursor
     */
    com::sun::star::table::XCellCursor createCursor();

    //-------------------------------------------------------------------------

    /** creates a cell cursor to travel in the given range context.

        @param aRange
            the cell range for the cursor.

        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
            if the given reference is empty or not a range from this table.

        @see com::sun::star::table::CellCursor
     */
    com::sun::star::table::XCellCursor createCursorByRange( [in] com::sun::star::table::XCellRange Range )
        raises ( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------

    /** stores the current row count of this table */
    [readonly, attribute] long RowCount;

    //-------------------------------------------------------------------------

    /** stores the current column count of this table */
    [readonly, attribute] long ColumnCount;
};

//=============================================================================

}; }; }; };

#endif