include/cppuhelper/proptypehlp.h

   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 #ifndef _CPPUHELPER_PROPTYPEHLP_H
  20 #define _CPPUHELPER_PROPTYPEHLP_H
  21
  22 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  23 #include <com/sun/star/uno/TypeClass.hpp>
  24
  25
  26 namespace cppu {
  27
  28 /** Converts the value stored in an any to a concrete C++ type.
  29     The function does the same as the operator >>= () at the
  30     Any class, except that it throws an IllegalArgumentException in case of
  31     failures (the value cannot be extracted without data loss )
  32
  33    @exception com::sun::star::lang::IllegalArgumentException when the type could not be converted.
  34  */
  35 template < class target >
  36 inline void SAL_CALL convertPropertyValue( target &value , const  ::com::sun::star::uno::Any & a);
  37
  38 template < class target >
  39 inline void SAL_CALL convertPropertyValue( target &value ,  ::com::sun::star::uno::Any & a);
  40
  41 /**
  42   conversion of basic types
  43 */
  44 inline void SAL_CALL convertPropertyValue( sal_Int64 & target ,  const ::com::sun::star::uno::Any & source )
  45     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  46 inline void SAL_CALL convertPropertyValue( sal_uInt64 & target, const ::com::sun::star::uno::Any & source )
  47     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  48 inline void SAL_CALL convertPropertyValue( sal_Int32 & target , const ::com::sun::star::uno::Any & source )
  49     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  50 inline void SAL_CALL convertPropertyValue( sal_uInt32 & target, const ::com::sun::star::uno::Any & source )
  51     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  52 inline void SAL_CALL convertPropertyValue( sal_Int16 & target , const ::com::sun::star::uno::Any & source )
  53     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  54 inline void SAL_CALL convertPropertyValue( sal_uInt16 & target, const ::com::sun::star::uno::Any & source )
  55     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  56 inline void SAL_CALL convertPropertyValue( sal_Int8 & target     , const ::com::sun::star::uno::Any & source )
  57     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  58 inline void SAL_CALL convertPropertyValue( float & target     , const ::com::sun::star::uno::Any & source )
  59     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  60 inline void SAL_CALL convertPropertyValue( double &target     , const ::com::sun::star::uno::Any &source )
  61     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  62 inline void SAL_CALL convertPropertyValue( ::rtl::OUString &target  , const ::com::sun::star::uno::Any &source )
  63     SAL_THROW( (::com::sun::star::lang::IllegalArgumentException) );
  64
  65 } // end namespace cppu
  66
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */