xref: /trunk/main/offapi/com/sun/star/inspection/XStringRepresentation.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_inspection_XStringRepresentation_idl__
#define __com_sun_star_inspection_XStringRepresentation_idl__

#ifndef __com_sun_star_script_XTypeConverter_idl__
#include <com/sun/star/script/XTypeConverter.idl>
#endif

//=============================================================================
module com {  module sun {  module star {  module inspection {

//-----------------------------------------------------------------------------
/** handles string representations of property values.
    @see
*/
published interface XStringRepresentation
{
    /** converts a  into a string.
        @param PropertyValue
            The to-be-converted property value.
        @return
            The converted string representation of the property value.
        @see <member>XPropertyHandler::convertToControlValue</member>
    */
    string  convertToControlValue([in]any PropertyValue) raises( com::sun::star::uno::Exception );

    /** converts a string into an any with the type defined by the target tpye.
        @param ControlValue
            The to-be-converted control value.
        @param ControlValueType
            The target type of the conversion.
        @see <member>XPropertyHandler::convertToPropertyValue</member>
    */
    any     convertToPropertyValue(
                            [in]string ControlValue,
                            [in]type ControlValueType
                        ) raises( com::sun::star::uno::Exception );
};

service StringRepresentation : XStringRepresentation
{
    create([in]com::sun::star::script::XTypeConverter TypeConverter)raises( com::sun::star::lang::IllegalArgumentException );
    createConstant([in]com::sun::star::script::XTypeConverter TypeConverter,[in] string Constant,[in] sequence<string> Values)raises( com::sun::star::lang::IllegalArgumentException );
};
//=============================================================================

}; }; }; };

#endif