summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/view/XViewCursor.idl
blob: 98d5d162c5498ab47976c9a9c628066112934102 (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
/**************************************************************
 *
 * 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_view_XViewCursor_idl__
#define __com_sun_star_view_XViewCursor_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


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

module com {  module sun {  module star {  module view {

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

/** makes it possible to move a cursor up/down/left/right within laid out text.

    @see com::sun::star::table::CellCursor
    @see com::sun::star::text::TextCursor
    @see com::sun::star::view::XLineCursor
 */
published interface XViewCursor: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of lines down.

        @param nCount
            specifies the number of lines to go down.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)
            or the cursor will be just at the new position after the move (<FALSE/>).

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already in the bottom row.
     */
    boolean goDown( [in] short nCount, [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of lines up.

        @param nCount
            specifies the number of lines to go up.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already in the top row.
     */
    boolean goUp( [in] short nCount, [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of characters to the left.

        @param nCount
            specifies the number of characters to move.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already at the leftmost position.
     */
    boolean goLeft( [in] short nCount, [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of characters to the right.

        @param nCount
            specifies the number of characters to move.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already at the rightmost position.
     */
    boolean goRight( [in] short nCount, [in] boolean bExpand );

};

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

}; }; }; };

#endif