offapi/com/sun/star/i18n/TextConversionResult.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: TextConversionResult.idl,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef __com_sun_star_i18n_XTextConversionResult_idl__
  32 #define __com_sun_star_i18n_XTextConversionResult_idl__
  33
  34
  35 #ifndef __com_sun_star_i18n_Boundary_idl__
  36 #include <com/sun/star/i18n/Boundary.idl>
  37 #endif
  38
  39
  40 //=============================================================================
  41
  42 module com {  module sun {  module star {  module i18n {
  43
  44 //=============================================================================
  45
  46 /** Text conversion result to be used with <type>XTextConversion</type>.
  47
  48      @since OOo 1.1.2
  49 */
  50
  51 published struct TextConversionResult
  52 {
  53     /** The boundary of the first convertible word in the given text.
  54
  55         <p>If there is no convertible word found in the text, <var>startPos</var>
  56         and <var>endPos</var> for Boundary equal 0.
  57     */
  58     ::com::sun::star::i18n::Boundary Boundary;
  59
  60     /** A list of replacement candidates for the first convertible word
  61         found in the given text.
  62     */
  63     sequence < string >         Candidates;
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 #endif