Line data    Source code

       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/implbase1.hxx>
      29             : #include <comphelper/comphelperdllapi.h>
      30             : 
      31             : 
      32             : //= property helper classes
      33             : 
      34             : 
      35             : //... namespace comphelper .......................................................
      36             : namespace comphelper
      37             : {
      38             : 
      39             : 
      40           0 : struct PropertyMapEntry
      41             : {
      42             :     OUString maName;
      43             :     sal_Int32 mnHandle;
      44             :     com::sun::star::uno::Type maType;
      45             :     sal_Int16 mnAttributes;
      46             :     sal_uInt8 mnMemberId;
      47             : };
      48             : 
      49             : typedef std::map<OUString, PropertyMapEntry const *> PropertyMap;
      50             : 
      51             : class PropertyMapImpl;
      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 : public ::cppu::WeakImplHelper1< ::com::sun::star::beans::XPropertySetInfo >
      57             : {
      58             : private:
      59             :     PropertyMapImpl* mpMap;
      60             : public:
      61             :     PropertySetInfo() throw();
      62             :     PropertySetInfo( PropertyMapEntry const * pMap ) throw();
      63             :     virtual ~PropertySetInfo() throw();
      64             : 
      65             :     /** returns a stl map with all PropertyMapEntry pointer.<p>
      66             :         The key is the property name.
      67             :     */
      68             :     const PropertyMap* getPropertyMap() const throw();
      69             : 
      70             :     /** adds an array of PropertyMapEntry to this instance.<p>
      71             :         The end is marked with a PropertyMapEntry where mpName equals NULL</p>
      72             :     */
      73             :     void add( PropertyMapEntry const * pMap ) throw();
      74             : 
      75             :     /** removes an already added PropertyMapEntry which string in mpName equals to aName */
      76             :     void remove( const OUString& aName ) throw();
      77             : 
      78             :     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL getProperties() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
      79             :     virtual ::com::sun::star::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
      80             :     virtual sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
      81             : };
      82             : 
      83             : 
      84             : }
      85             : //... namespace comphelper .......................................................
      86             : 
      87             : #endif // _UTL_PROPERTSETINFO_HXX_
      88             : 
      89             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */