1 files changed, 96 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XWordCursor.idl b/offapi/com/sun/star/text/XWordCursor.idl
new file mode 100644
index 000000000..52c877def
--- /dev/null
+++ b/offapi/com/sun/star/text/XWordCursor.idl
@@ -0,0 +1,96 @@
+/* -*- 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_text_XWordCursor_idl__
+#define __com_sun_star_text_XWordCursor_idl__
+
+#include <com/sun/star/text/XTextCursor.idl>
+
+
+
+ module com {  module sun {  module star {  module text {
+
+
+/** makes it possible to move a cursor word by word.
+ */
+published interface XWordCursor: com::sun::star::text::XTextCursor
+{
+
+    /** determines if the cursor is positioned at the start of a word.
+     */
+    boolean isStartOfWord();
+
+
+    /** determines if the cursor is positioned at the end of a word.
+     */
+    boolean isEndOfWord();
+
+
+    /** moves the cursor to the next word.
+
+        <p>Note: the function returning `TRUE` does not necessarily mean
+        that the cursor is located at the next word, or any word at all!
+        This may happen for example if it travels over empty paragraphs.</p>
+
+        @returns
+            `TRUE` if the cursor was moved. It returns `FALSE` it the
+            cursor can not advance further.
+     */
+    boolean gotoNextWord( [in] boolean bExpand );
+
+
+    /** moves the cursor to the previous word.
+
+        <p>Note: the function returning `TRUE` does not necessarily mean
+        that the cursor is located at the previous word, or any word at all!
+        This may happen for example if it travels over empty paragraphs.</p>
+
+        @returns
+            `TRUE` if the cursor was moved. It returns `FALSE` it the
+            cursor can not advance further.
+     */
+    boolean gotoPreviousWord( [in] boolean bExpand );
+
+
+    /** moves the cursor to the end of the current word.
+
+        @returns
+            `TRUE` if the cursor is now at the end of a word,
+            `FALSE` otherwise. If `FALSE` was returned the cursor
+            will remain at its original position.
+     */
+    boolean gotoEndOfWord( [in] boolean bExpand );
+
+
+    /** moves the cursor to the start of the current word.
+
+        @returns
+            `TRUE` if the cursor is now at the start of a word,
+            `FALSE` otherwise. If `FALSE` was returned the cursor
+            will remain at its original position.
+     */
+    boolean gotoStartOfWord( [in] boolean bExpand );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */