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