offapi: document com.sun.star.text.LineBreak

It's an XTextContent and also document the possible values of the Clear
property.

Change-Id: Ic1c338e4461ceea75cf16ce896e98e732d9af859
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/139397
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins

3 files changed, 42 insertions, 0 deletions

diff --git a/offapi/UnoApi_offapi.mk b/offapi/UnoApi_offapi.mk
index fb3be9253e51..6abbddc21b5d 100644
--- a/offapi/UnoApi_offapi.mk
+++ b/offapi/UnoApi_offapi.mk
@@ -1364,6 +1364,7 @@ $(eval $(call gb_UnoApi_add_idlfiles_noheader,offapi,com/sun/star/text,\
 	GlobalSettings \
 	IllustrationsIndex \
 	InContentMetadata \
+	LineBreak \
 	LineNumberingProperties \
 	MailMerge \
 	NumberingLevel \
diff --git a/offapi/com/sun/star/text/LineBreak.idl b/offapi/com/sun/star/text/LineBreak.idl
new file mode 100644
index 000000000000..2ba8e1ced200
--- /dev/null
+++ b/offapi/com/sun/star/text/LineBreak.idl
@@ -0,0 +1,35 @@
+/* -*- 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/.
+ */
+
+module com { module sun { module star { module text {
+
+/** This service specifies a line break with properties in a TextDocument.
+
+    @since LibreOffice 7.4
+*/
+service LineBreak
+{
+
+    /** Provides a way to insert the line break using insertTextContent().
+    */
+    interface com::sun::star::text::XTextContent;
+
+    /** The type of the clearing break. Possible values:
+        0: None
+        1: Left
+        2: Right
+        3: All
+     */
+    [optional, property] short Clear;
+};
+
+
+}; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/text/TextRangeContentProperties.idl b/offapi/com/sun/star/text/TextRangeContentProperties.idl
index 2649727ad81d..7ba4068ddd17 100644
--- a/offapi/com/sun/star/text/TextRangeContentProperties.idl
+++ b/offapi/com/sun/star/text/TextRangeContentProperties.idl
@@ -75,6 +75,12 @@ service TextRangeContentProperties
      */
     [optional, readonly, property] com::sun::star::text::XTextContent TextParagraph;
 
+    /** Properties of the linebreak, e.g. for clearing break purposes.
+
+        @since LibreOffice 7.4
+     */
+    [optional, readonly, property] com::sun::star::text::XTextContent LineBreak;
+
 };