offapi/com/sun/star/inspection/XStringRepresentation.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
  28 #ifndef __com_sun_star_inspection_XStringRepresentation_idl__
  29 #define __com_sun_star_inspection_XStringRepresentation_idl__
  30
  31 #ifndef __com_sun_star_script_XTypeConverter_idl__
  32 #include <com/sun/star/script/XTypeConverter.idl>
  33 #endif
  34
  35 //=============================================================================
  36 module com {  module sun {  module star {  module inspection {
  37
  38 //-----------------------------------------------------------------------------
  39 /** handles string representations of property values.
  40     @see
  41 */
  42 interface XStringRepresentation
  43 {
  44     /** converts a  into a string.
  45         @param PropertyValue
  46             The to-be-converted property value.
  47         @return
  48             The converted string representation of the property value.
  49         @see <member>XPropertyHandler::convertToControlValue</member>
  50     */
  51     string  convertToControlValue([in]any PropertyValue) raises( com::sun::star::uno::Exception );
  52
  53     /** converts a string into an any with the type defined by the target tpye.
  54         @param ControlValue
  55             The to-be-converted control value.
  56         @param ControlValueType
  57             The target type of the conversion.
  58         @see <member>XPropertyHandler::convertToPropertyValue</member>
  59     */
  60     any     convertToPropertyValue(
  61                             [in]string ControlValue,
  62                             [in]type ControlValueType
  63                         ) raises( com::sun::star::uno::Exception );
  64 };
  65
  66 service StringRepresentation : XStringRepresentation
  67 {
  68     create([in]com::sun::star::script::XTypeConverter TypeConverter)raises( com::sun::star::lang::IllegalArgumentException );
  69     createConstant([in]com::sun::star::script::XTypeConverter TypeConverter,[in] string Constant,[in] sequence<string> Values)raises( com::sun::star::lang::IllegalArgumentException );
  70 };
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif
  76