include/comphelper/propertycontainer.hxx

   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 INCLUDED_COMPHELPER_PROPERTYCONTAINER_HXX
  21 #define INCLUDED_COMPHELPER_PROPERTYCONTAINER_HXX
  22
  23 #include <comphelper/propertycontainerhelper.hxx>
  24 #include <cppuhelper/propshlp.hxx>
  25 #include <comphelper/comphelperdllapi.h>
  26
  27
  28 namespace com::sun::star::uno { class Any; }
  29 namespace com::sun::star::uno { class Type; }
  30
  31 namespace comphelper
  32 {
  33
  34
  35 /** an OPropertySetHelper implementation which is just a simple container for properties represented
  36     by class members, usually in a derived class.
  37     <BR>
  38     A restriction of this class is that no value conversions are made on a setPropertyValue call. Though
  39     the base class supports this with the convertFastPropertyValue method, the OPropertyContainer accepts only
  40     values which already have the correct type, it's unable to convert, for instance, a long to a short.
  41 */
  42 class COMPHELPER_DLLPUBLIC OPropertyContainer
  43             :public cppu::OPropertySetHelper
  44             ,public OPropertyContainerHelper
  45 {
  46 public:
  47     // this dtor is needed otherwise we can get a wrong delete operator
  48     virtual ~OPropertyContainer();
  49
  50 protected:
  51     OPropertyContainer(::cppu::OBroadcastHelper& _rBHelper);
  52
  53     /// for scripting : the types of the interfaces supported by this class
  54     ///
  55     /// @throws css::uno::RuntimeException
  56     static css::uno::Sequence< css::uno::Type > getBaseTypes();
  57
  58 // OPropertySetHelper overridables
  59     virtual sal_Bool SAL_CALL convertFastPropertyValue(
  60                             css::uno::Any & rConvertedValue,
  61                             css::uno::Any & rOldValue,
  62                             sal_Int32 nHandle,
  63                             const css::uno::Any& rValue ) override;
  64
  65     virtual void SAL_CALL   setFastPropertyValue_NoBroadcast(
  66                                 sal_Int32 nHandle,
  67                                 const css::uno::Any& rValue
  68                             ) override;
  69
  70     using OPropertySetHelper::getFastPropertyValue;
  71     virtual void SAL_CALL getFastPropertyValue(
  72                                 css::uno::Any& rValue,
  73                                 sal_Int32 nHandle
  74                                      ) const override;
  75
  76     // disambiguate a base class method (XFastPropertySet)
  77     using OPropertySetHelper::setFastPropertyValue;
  78 };
  79
  80
  81 }   // namespace comphelper
  82
  83
  84 #endif // INCLUDED_COMPHELPER_PROPERTYCONTAINER_HXX
  85
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */