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

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