summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/XTextConvert.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/XTextConvert.idl')
-rw-r--r--offapi/com/sun/star/text/XTextConvert.idl92
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XTextConvert.idl b/offapi/com/sun/star/text/XTextConvert.idl
new file mode 100644
index 000000000..2de810cf5
--- /dev/null
+++ b/offapi/com/sun/star/text/XTextConvert.idl
@@ -0,0 +1,92 @@
+/* -*- 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_XTextConvert_idl__
+#define __com_sun_star_text_XTextConvert_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/beans/PropertyValues.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/beans/PropertyVetoException,idl>
+#include <com/sun/star/beans/UnknownPropertyException.idl>
+#include <com/sun/star/text/XTextRange.idl>
+#include <com/sun/star/text/XTextContent.idl>
+#include <com/sun/star/text/XTextTable.idl>
+
+
+
+
+ module com { module sun { module star { module text {
+
+
+/** allows converting selections of text to frames or tables.
+ */
+interface XTextConvert : com::sun::star::uno::XInterface
+{
+
+ /** moves the paragraphs from Start to End into a text frame.
+
+
+ @param Start start position of frame content
+
+ @param End end position of frame content
+
+ @param FrameProperties
+ contains the properties of the to-be-created text frame
+
+ @return the newly created text frame
+
+ */
+ ::com::sun::star::text::XTextContent convertToTextFrame(
+ [in] com::sun::star::text::XTextRange Start,
+ [in] com::sun::star::text::XTextRange End,
+ [in] com::sun::star::beans::PropertyValues FrameProperties )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::beans::UnknownPropertyException,
+ com::sun::star::beans::PropertyVetoException );
+
+ /** converts the paragraphs marked in TableRanges into a table.
+
+
+ @param TableRanges contains the TextRange interfaces of the paragraphs, cells and rows of the table.
+ <p>The inner sequence contains the start and end paragraphs of each table cell.
+ The next sequence groups the cells to a row and the outer sequence groups the rows of the table.</p>
+
+ @param CellProperties contains the properties of each cell.
+ @param RowProperties contains the properties of each table row.
+ @param TableProperties contains the properties of the table.
+ @return the created table.
+
+ */
+ ::com::sun::star::text::XTextTable convertToTable(
+ [in] sequence< sequence< sequence< com::sun::star::text::XTextRange > > > TableRanges,
+ [in] sequence< sequence< com::sun::star::beans::PropertyValues > > CellProperties,
+ [in] sequence< com::sun::star::beans::PropertyValues > RowProperties,
+ [in] com::sun::star::beans::PropertyValues TableProperties )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::beans::UnknownPropertyException );
+
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */