office-gobmx/offapi/com/sun/star/inspection/XStringRepresentation.idl
Rüdiger Timm b1e32c3c2c INTEGRATION: CWS changefileheader (1.2.184); FILE MERGED
2008/03/31 16:01:37 rt 1.2.184.1: #i87441# Change license header to LPGL v3.
2008-04-10 23:35:39 +00:00

79 lines
3.1 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XStringRepresentation.idl,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 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
*/
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