xref: /AOO41X/main/offapi/com/sun/star/sheet/XSpreadsheet.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XSpreadsheet_idl__
25#define __com_sun_star_sheet_XSpreadsheet_idl__
26
27#ifndef __com_sun_star_sheet_XSheetCellRange_idl__
28#include <com/sun/star/sheet/XSheetCellRange.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37 published interface XSheetCellCursor;
38
39//=============================================================================
40
41/** provides methods to create a cell range cursor.
42 */
43published interface XSpreadsheet: com::sun::star::sheet::XSheetCellRange
44{
45    //-------------------------------------------------------------------------
46
47    /** creates a cell cursor including the whole spreadsheet.
48
49        @see com::sun::star::sheet::SheetCellCursor
50     */
51    com::sun::star::sheet::XSheetCellCursor createCursor();
52
53    //-------------------------------------------------------------------------
54
55    /** creates a cell cursor to travel in the given range context.
56
57        @param aRange
58            the cell range for the cursor.
59
60        @see com::sun::star::sheet::SheetCellCursor
61     */
62    com::sun::star::sheet::XSheetCellCursor createCursorByRange(
63            [in] com::sun::star::sheet::XSheetCellRange aRange );
64
65};
66
67//=============================================================================
68
69}; }; }; };
70
71#endif
72
73