offapi/com/sun/star/text/XTextConvert.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XTextConvert_idl__
  20 #define __com_sun_star_text_XTextConvert_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValues.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/beans/PropertyVetoException,idl>
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27 #include <com/sun/star/text/XTextRange.idl>
  28 #include <com/sun/star/text/XTextContent.idl>
  29 #include <com/sun/star/text/XTextTable.idl>
  30
  31
  32
  33
  34  module com {  module sun {  module star {  module text {
  35
  36
  37 /** allows converting selections of text to frames or tables.
  38  */
  39 interface XTextConvert : com::sun::star::uno::XInterface
  40 {
  41
  42         /** moves the paragraphs from Start to End into a text frame.
  43
  44
  45         @param Start    start position of frame content
  46
  47         @param End      end position of frame content
  48
  49         @param FrameProperties
  50             contains the properties of the to-be-created text frame
  51
  52         @return         the newly created text frame
  53
  54      */
  55     ::com::sun::star::text::XTextContent convertToTextFrame(
  56                         [in] com::sun::star::text::XTextRange Start,
  57                         [in] com::sun::star::text::XTextRange End,
  58                         [in] com::sun::star::beans::PropertyValues FrameProperties )
  59                         raises( com::sun::star::lang::IllegalArgumentException,
  60                                 com::sun::star::beans::UnknownPropertyException,
  61                                 com::sun::star::beans::PropertyVetoException );
  62
  63         /** converts the paragraphs marked in TableRanges into a table.
  64
  65
  66         @param TableRanges contains the TextRange interfaces of the paragraphs, cells and rows of the table.
  67             <p>The inner sequence contains the start and end paragraphs of each table cell.
  68             The next sequence groups the cells to a row and the outer sequence groups the rows of the table.</p>
  69
  70         @param CellProperties contains the properties of each cell.
  71         @param RowProperties contains the properties of each table row.
  72         @param TableProperties contains the properties of the table.
  73         @return the created table.
  74
  75      */
  76     ::com::sun::star::text::XTextTable convertToTable(
  77                      [in] sequence< sequence< sequence< com::sun::star::text::XTextRange > > > TableRanges,
  78                      [in] sequence< sequence< com::sun::star::beans::PropertyValues > > CellProperties,
  79                      [in] sequence< com::sun::star::beans::PropertyValues > RowProperties,
  80                      [in] com::sun::star::beans::PropertyValues TableProperties )
  81                         raises( com::sun::star::lang::IllegalArgumentException,
  82                                        com::sun::star::beans::UnknownPropertyException );
  83
  84
  85 };
  86
  87
  88 }; }; }; };
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */