summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/XSimpleText.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/text/XSimpleText.idl127
1 files changed, 127 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XSimpleText.idl b/offapi/com/sun/star/text/XSimpleText.idl
new file mode 100644
index 000000000..f93339180
--- /dev/null
+++ b/offapi/com/sun/star/text/XSimpleText.idl
@@ -0,0 +1,127 @@
+/* -*- 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_XSimpleText_idl__
+#define __com_sun_star_text_XSimpleText_idl__
+
+#include <com/sun/star/text/XTextRange.idl>
+
+#include <com/sun/star/text/XTextCursor.idl>
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+#include <com/sun/star/text/XTextContent.idl>
+
+#include <com/sun/star/container/NoSuchElementException.idl>
+
+
+
+ module com { module sun { module star { module text {
+
+
+/** is the main interface for a distinct text unit, i.e. the main text of
+ a document, the text for headers and footers or for single cells of a
+ table.@see XText
+ */
+published interface XSimpleText: com::sun::star::text::XTextRange
+{
+
+ /** @returns
+ a new instance of a TextCursor service which can
+ be used to travel in the given text context.
+
+ @see com::sun::star::text::TextCursor
+ */
+ com::sun::star::text::XTextCursor createTextCursor();
+
+
+ /** @returns
+ a new instance of a TextCursor which is located
+ at the specified TextRange to travel in the
+ given text context.
+
+ <p>The initial position is set to <var>aTextPosition</var>.
+
+ @param aTextPosition
+ specifies the start position for the new
+ TextCursor.
+
+ @see com::sun::star::text::TextCursor
+ */
+ com::sun::star::text::XTextCursor createTextCursorByRange( [in] com::sun::star::text::XTextRange aTextPosition );
+
+
+ /** inserts a string of characters into the text.
+
+ <p>The string may contain the following white spaces:
+ </p>
+ <ul>
+ <li>blank</li>
+ <li>tab</li>
+ <li>cr (which will insert a paragraph break)</li>
+ <li>lf (which will insert a line break)</li>
+ </ul>
+
+ @param xRange
+ specifies the position of insertion. For example,
+ XSimpleText::createTextCursor() can be used to
+ get an XTextRange for this argument.
+
+ <p>If the parameter bAbsorb() was `TRUE`
+ the text range will contain the new inserted string, otherwise
+ the range (and it's text) will remain unchanged.
+
+ @param aString
+ specifies the string to insert.
+
+ @param bAbsorb
+ specifies whether the text spanned by <var>xRange</var> will be
+ replaced. If `TRUE` then the content of <var>xRange</var> will
+ be replaced by <var>aString</var>, otherwise <var>aString</var>
+ will be inserted at the beginning of <var>xRange</var>.
+
+ @code{.java}
+ xText.insertString( xTextCursor, "Hello " + aName + ",", false )
+
+ xText.insertControlCharacter( xTextCursor,
+ ControlCharacter.PARAGRAPH_BREAK, false );
+
+ xText.insertString( xTextCursor, "more text ...", false )
+ @endcode
+ */
+ void insertString( [in] com::sun::star::text::XTextRange xRange,
+ [in] string aString,
+ [in] boolean bAbsorb );
+
+
+ /** inserts a control character (like a paragraph break or a hard
+ space) into the text.@see com::sun::star::text::ControlCharacter
+ */
+ void insertControlCharacter( [in] com::sun::star::text::XTextRange xRange,
+ [in] short nControlCharacter,
+ [in] boolean bAbsorb )
+ raises( com::sun::star::lang::IllegalArgumentException );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */