offapi/com/sun/star/inspection/XStringRepresentation.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_inspection_XStringRepresentation_idl__
  21 #define __com_sun_star_inspection_XStringRepresentation_idl__
  22
  23 #include <com/sun/star/script/XTypeConverter.idl>
  24
  25 module com {  module sun {  module star {  module inspection {
  26
  27 /** handles string representations of property values.
  28     @see
  29 */
  30 interface XStringRepresentation
  31 {
  32     /** converts a  into a string.
  33         @param PropertyValue
  34             The to-be-converted property value.
  35         @return
  36             The converted string representation of the property value.
  37         @see XPropertyHandler::convertToControlValue()
  38     */
  39     string  convertToControlValue([in]any PropertyValue) raises( com::sun::star::uno::Exception );
  40
  41     /** converts a string into an any with the type defined by the target type.
  42         @param ControlValue
  43             The to-be-converted control value.
  44         @param ControlValueType
  45             The target type of the conversion.
  46         @see XPropertyHandler::convertToPropertyValue()
  47     */
  48     any     convertToPropertyValue(
  49                             [in]string ControlValue,
  50                             [in]type ControlValueType
  51                         ) raises( com::sun::star::uno::Exception );
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */