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