include/comphelper/propertysetinfo.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_PROPERTYSETINFO_HXX
  21 #define INCLUDED_COMPHELPER_PROPERTYSETINFO_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <map>
  26
  27 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  28 #include <cppuhelper/implbase.hxx>
  29 #include <comphelper/comphelperdllapi.h>
  30 #include <memory>
  31
  32 namespace comphelper
  33 {
  34
  35 struct PropertyMapEntry
  36 {
  37     OUString       maName;
  38     sal_Int32      mnHandle;
  39     css::uno::Type maType;
  40     sal_Int16      mnAttributes;
  41     sal_uInt8      mnMemberId;
  42 };
  43
  44 typedef std::map<OUString, PropertyMapEntry const *> PropertyMap;
  45
  46 class PropertyMapImpl;
  47
  48 // don't export to avoid duplicate WeakImplHelper definitions with MSVC
  49 class SAL_DLLPUBLIC_TEMPLATE PropertySetInfo_BASE
  50     : public ::cppu::WeakImplHelper< css::beans::XPropertySetInfo >
  51 {};
  52
  53 /** this class implements a XPropertySetInfo that is initialized with arrays of PropertyMapEntry.
  54     It is used by the class PropertySetHelper.
  55 */
  56 class COMPHELPER_DLLPUBLIC PropertySetInfo
  57     : public PropertySetInfo_BASE
  58 {
  59 private:
  60     std::unique_ptr<PropertyMapImpl> mpImpl;
  61 public:
  62     PropertySetInfo() throw();
  63     PropertySetInfo( PropertyMapEntry const * pMap ) throw();
  64     PropertySetInfo(css::uno::Sequence<css::beans::Property> const &) throw();
  65     virtual ~PropertySetInfo() throw() override;
  66
  67     /** returns a stl map with all PropertyMapEntry pointer.<p>
  68         The key is the property name.
  69     */
  70     const PropertyMap& getPropertyMap() const throw();
  71
  72     /** adds an array of PropertyMapEntry to this instance.<p>
  73         The end is marked with a PropertyMapEntry where mpName equals NULL</p>
  74     */
  75     void add( PropertyMapEntry const * pMap ) throw();
  76
  77     /** removes an already added PropertyMapEntry which string in mpName equals to aName */
  78     void remove( const OUString& aName ) throw();
  79
  80     virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties() override;
  81     virtual css::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) override;
  82     virtual sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) override;
  83 };
  84
  85 }
  86
  87 #endif // _UTL_PROPERTSETINFO_HXX_
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */