xref: /AOO41X/main/offapi/com/sun/star/table/XCellCursor.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_table_XCellCursor_idl__
25#define __com_sun_star_table_XCellCursor_idl__
26
27#ifndef __com_sun_star_table_XCellRange_idl__
28#include <com/sun/star/table/XCellRange.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module table {
34
35//=============================================================================
36
37/** provides methods to control the position of a cell cursor.
38
39    @see com::sun::star::table::CellCursor
40 */
41published interface XCellCursor: com::sun::star::table::XCellRange
42{
43    //-------------------------------------------------------------------------
44
45    /** points the cursor to a single cell which is the beginning of a
46        contiguous series of (filled) cells.
47     */
48    void gotoStart();
49
50    //-------------------------------------------------------------------------
51
52    /** points the cursor to a single cell which is the end of a contiguous
53        series of (filled) cells.
54     */
55    void gotoEnd();
56
57    //-------------------------------------------------------------------------
58
59    /** points the cursor to the next unprotected cell.
60
61        <p>If the sheet is not protected, this is the next cell to the
62        right.</p>
63     */
64    void gotoNext();
65
66    //-------------------------------------------------------------------------
67
68    /** points the cursor to the previous unprotected cell.
69
70        <p>If the sheet is not protected, this is the next cell to the
71        left.</p>
72     */
73    void gotoPrevious();
74
75    //-------------------------------------------------------------------------
76
77    /** moves the origin of the cursor relative to the current position.
78
79        @param nColumnOffset
80            is the count of columns to move. A negative value moves the
81            cursor to the left.
82
83        @param nRowOffset
84            is the count of rows to move. A negative value moves the
85            cursor to the top.
86     */
87    void gotoOffset( [in] long nColumnOffset, [in] long nRowOffset );
88
89};
90
91//=============================================================================
92
93}; }; }; };
94
95#endif
96
97