summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/XParagraphCursor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/XParagraphCursor.idl')
-rw-r--r--offapi/com/sun/star/text/XParagraphCursor.idl105
1 files changed, 105 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XParagraphCursor.idl b/offapi/com/sun/star/text/XParagraphCursor.idl
new file mode 100644
index 000000000000..7e83557674f2
--- /dev/null
+++ b/offapi/com/sun/star/text/XParagraphCursor.idl
@@ -0,0 +1,105 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_text_XParagraphCursor_idl__
+#define __com_sun_star_text_XParagraphCursor_idl__
+
+#ifndef __com_sun_star_text_XTextCursor_idl__
+#include <com/sun/star/text/XTextCursor.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module text {
+
+//=============================================================================
+
+/** makes it possible to move paragraph by paragraph.
+ */
+published interface XParagraphCursor: com::sun::star::text::XTextCursor
+{
+ //-------------------------------------------------------------------------
+
+ /** determines if the cursor is positioned at the start of a paragraph.
+ */
+ boolean isStartOfParagraph();
+
+ //-------------------------------------------------------------------------
+
+ /** determines if the cursor is positioned at the end of a paragraph.
+ */
+ boolean isEndOfParagraph();
+
+ //-------------------------------------------------------------------------
+
+ /** moves the cursor to the start of the current paragraph.
+
+ @returns
+ <true/> if the cursor is now at the start of a paragraph,
+ <false/> otherwise. If <false/> was returned the cursor
+ will remain at its original position.
+ */
+ boolean gotoStartOfParagraph( [in] boolean bExpand );
+
+ //-------------------------------------------------------------------------
+
+ /** moves the cursor to the end of the current paragraph.
+
+ @returns
+ <true/> if the cursor is now at the end of a paragraph,
+ <false/> otherwise. If <false/> was returned the cursor
+ will remain at its original position.
+ */
+ boolean gotoEndOfParagraph( [in] boolean bExpand );
+
+ //-------------------------------------------------------------------------
+
+ /** moves the cursor to the next paragraph.
+
+ @returns
+ <true/> if the cursor was moved. It returns <false/> it the
+ cursor can not advance further.
+ */
+ boolean gotoNextParagraph( [in] boolean bExpand );
+
+ //-------------------------------------------------------------------------
+
+ /** moves the cursor to the previous paragraph.
+
+ @returns
+ <true/> if the cursor was moved. It returns <false/> it the
+ cursor can not advance further.
+ */
+ boolean gotoPreviousParagraph( [in] boolean bExpand );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif