xref: /AOO41X/main/offapi/com/sun/star/view/XLineCursor.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#ifndef __com_sun_star_view_XLineCursor_idl__
24#define __com_sun_star_view_XLineCursor_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module view {
34
35//=============================================================================
36
37/** makes it possible to move a cursor by lines within laid out text.
38
39    @see com::sun::star::table::CellCursor
40    @see com::sun::star::text::TextCursor
41    @see com::sun::star::text::XTextViewCursor
42 */
43published interface XLineCursor: com::sun::star::uno::XInterface
44{
45    //-------------------------------------------------------------------------
46    /** determines if the cursor is positioned at the start of a line.
47     */
48    boolean isAtStartOfLine();
49
50    //-------------------------------------------------------------------------
51    /** determines if the cursor is positioned at the end of a line.
52     */
53    boolean isAtEndOfLine();
54
55    //-------------------------------------------------------------------------
56    /** moves the cursor to the end of the current line.
57
58        @param bExpand
59            determines whether the text range of the cursor is expanded (<TRUE/>)
60            or the cursor will be just at the new position after the move (<FALSE/>).
61     */
62    void gotoEndOfLine( [in] boolean bExpand );
63
64    //-------------------------------------------------------------------------
65    /** moves the cursor to the start of the current line.
66
67        @param bExpand
68            determines whether the text range of the cursor is expanded (<TRUE/>)
69            or the cursor will be just at the new position after the move (<FALSE/>).
70     */
71    void gotoStartOfLine( [in] boolean bExpand );
72
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80