summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/XCellCursor.idl
blob: afe229c6e8dd3645a3254c7521dbe7c0d581f880 (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
/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_table_XCellCursor_idl__
#define __com_sun_star_table_XCellCursor_idl__

#ifndef __com_sun_star_table_XCellRange_idl__
#include <com/sun/star/table/XCellRange.idl>
#endif

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

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

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

/** provides methods to control the position of a cell cursor.

    @see com::sun::star::table::CellCursor
 */
published interface XCellCursor: com::sun::star::table::XCellRange
{
    //-------------------------------------------------------------------------

    /** points the cursor to a single cell which is the beginning of a
        contiguous series of (filled) cells.
     */
    void gotoStart();

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

    /** points the cursor to a single cell which is the end of a contiguous
        series of (filled) cells.
     */
    void gotoEnd();

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

    /** points the cursor to the next unprotected cell.

        <p>If the sheet is not protected, this is the next cell to the
        right.</p>
     */
    void gotoNext();

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

    /** points the cursor to the previous unprotected cell.

        <p>If the sheet is not protected, this is the next cell to the
        left.</p>
     */
    void gotoPrevious();

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

    /** moves the origin of the cursor relative to the current position.

        @param nColumnOffset
            is the count of columns to move. A negative value moves the
            cursor to the left.

        @param nRowOffset
            is the count of rows to move. A negative value moves the
            cursor to the top.
     */
    void gotoOffset( [in] long nColumnOffset, [in] long nRowOffset );

};

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

}; }; }; };

#endif