1 files changed, 101 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/XViewCursor.idl b/offapi/com/sun/star/view/XViewCursor.idl
new file mode 100644
index 000000000..5f20dca37
--- /dev/null
+++ b/offapi/com/sun/star/view/XViewCursor.idl
@@ -0,0 +1,101 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   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 .
+ */
+#ifndef __com_sun_star_view_XViewCursor_idl__
+#define __com_sun_star_view_XViewCursor_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */