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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XTextConvert_idl__
  28 #define __com_sun_star_text_XTextConvert_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_beans_PropertyValues_idl__
  35 #include <com/sun/star/beans/PropertyValues.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_UnknownPropertyException_idl__
  43 #include <com/sun/star/beans/UnknownPropertyException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_text_XTextRange_idl__
  47 #include <com/sun/star/text/XTextRange.idl>
  48 #endif
  49 #ifndef __com_sun_star_text_XTextContent_idl__
  50 #include <com/sun/star/text/XTextContent.idl>
  51 #endif
  52 #ifndef __com_sun_star_text_XTextTable_idl__
  53 #include <com/sun/star/text/XTextTable.idl>
  54 #endif
  55
  56
  57
  58 //=============================================================================
  59
  60  module com {  module sun {  module star {  module text {
  61
  62 //=============================================================================
  63
  64 /** .
  65  */
  66 interface XTextConvert : com::sun::star::uno::XInterface
  67 {
  68     //-------------------------------------------------------------------------
  69
  70         /** moves the paragraphs from Start to End into a text frame.
  71
  72                 <p>FrameProperties contains the properties of the to-be-created text frame.</p>
  73
  74         @param
  75             .
  76
  77         @param
  78             .
  79         @return
  80
  81      */
  82     ::com::sun::star::text::XTextContent convertToTextFrame(
  83                         [in] com::sun::star::text::XTextRange Start,
  84                         [in] com::sun::star::text::XTextRange End,
  85                         [in] com::sun::star::beans::PropertyValues FrameProperties )
  86                         raises( com::sun::star::lang::IllegalArgumentException,
  87                                        com::sun::star::beans::UnknownPropertyException );
  88
  89         /** .
  90
  91
  92         @param TableRanges contains the TextRange interfaces of the paragraphs, cells and rows of the table.
  93             <p>The innter sequence contains the start and end paragraphs of each table cell.
  94             The next sequence groups the cells to a row and the outer sequence groups the rows of the table.</p>
  95
  96         @param CellProperties contains the properties of each cell.
  97         @param RowProperties contains the properties of each table row.
  98         @param TableProperties contains the properties of the table.
  99         @return the created table.
 100
 101      */
 102     ::com::sun::star::text::XTextTable convertToTable(
 103                      [in] sequence< sequence< sequence< com::sun::star::text::XTextRange > > > TableRanges,
 104                      [in] sequence< sequence< com::sun::star::beans::PropertyValues > > CellProperties,
 105                      [in] sequence< com::sun::star::beans::PropertyValues > RowProperties,
 106                      [in] com::sun::star::beans::PropertyValues TableProperties )
 107                         raises( com::sun::star::lang::IllegalArgumentException,
 108                                        com::sun::star::beans::UnknownPropertyException );
 109
 110
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 #endif