include/svl/itemprop.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 #ifndef INCLUDED_SVL_ITEMPROP_HXX
  20 #define INCLUDED_SVL_ITEMPROP_HXX
  21
  22 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  23 #include <com/sun/star/beans/PropertyState.hpp>
  24 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  25 #include <cppuhelper/implbase1.hxx>
  26 #include <svl/itemset.hxx>
  27 #include <svl/svldllapi.h>
  28 #include <vector>
  29
  30 struct SfxItemPropertyMapEntry
  31 {
  32     OUString                            aName;
  33     sal_uInt16                          nWID;
  34     com::sun::star::uno::Type           aType;
  35     long                                nFlags;
  36     sal_uInt8                           nMemberId;
  37
  38 };
  39
  40 struct SfxItemPropertySimpleEntry
  41 {
  42     sal_uInt16                          nWID;
  43     com::sun::star::uno::Type           aType;
  44     long                                nFlags;
  45     sal_uInt8                           nMemberId;
  46
  47     SfxItemPropertySimpleEntry()
  48         : nWID( 0 )
  49         , nFlags( 0 )
  50         , nMemberId( 0 )
  51         {
  52         }
  53
  54     SfxItemPropertySimpleEntry(sal_uInt16 _nWID, com::sun::star::uno::Type const & _rType,
  55                                long _nFlags, sal_uInt8 _nMemberId)
  56         : nWID(      _nWID )
  57         , aType(     _rType )
  58         , nFlags(    _nFlags )
  59         , nMemberId( _nMemberId )
  60         {
  61         }
  62
  63     SfxItemPropertySimpleEntry( const SfxItemPropertyMapEntry* pMapEntry )
  64         : nWID( pMapEntry->nWID )
  65         , aType( pMapEntry->aType )
  66         , nFlags( pMapEntry->nFlags )
  67         , nMemberId( pMapEntry->nMemberId )
  68         {
  69         }
  70
  71 };
  72 struct SfxItemPropertyNamedEntry : public SfxItemPropertySimpleEntry
  73 {
  74     OUString sName;
  75     SfxItemPropertyNamedEntry( const OUString& rName, const SfxItemPropertySimpleEntry& rSimpleEntry)
  76         : SfxItemPropertySimpleEntry( rSimpleEntry )
  77         , sName( rName )
  78 {
  79 }
  80
  81 };
  82 typedef std::vector< SfxItemPropertyNamedEntry > PropertyEntryVector_t;
  83 class SfxItemPropertyMap_Impl;
  84 class SVL_DLLPUBLIC SfxItemPropertyMap
  85 {
  86     SfxItemPropertyMap_Impl* m_pImpl;
  87 public:
  88     SfxItemPropertyMap( const SfxItemPropertyMapEntry* pEntries );
  89     SfxItemPropertyMap( const SfxItemPropertyMap& rSource );
  90     ~SfxItemPropertyMap();
  91
  92     const SfxItemPropertySimpleEntry*  getByName( const OUString &rName ) const;
  93     com::sun::star::uno::Sequence< com::sun::star::beans::Property > getProperties() const;
  94     com::sun::star::beans::Property getPropertyByName( const OUString & rName ) const
  95         throw( ::com::sun::star::beans::UnknownPropertyException );
  96     bool hasPropertyByName( const OUString& rName ) const;
  97
  98     void mergeProperties( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& rPropSeq );
  99     PropertyEntryVector_t getPropertyEntries() const;
 100     sal_uInt32 getSize() const;
 101
 102 };
 103
 104 class SVL_DLLPUBLIC SfxItemPropertySet
 105 {
 106     SfxItemPropertyMap                                                              m_aMap;
 107     mutable com::sun::star::uno::Reference<com::sun::star::beans::XPropertySetInfo> m_xInfo;
 108
 109 public:
 110                             SfxItemPropertySet( const SfxItemPropertyMapEntry *pMap ) :
 111                                 m_aMap(pMap) {}
 112                             virtual ~SfxItemPropertySet();
 113
 114     void getPropertyValue( const SfxItemPropertySimpleEntry& rEntry,
 115                                           const SfxItemSet& rSet,
 116                                           com::sun::star::uno::Any& rAny) const
 117                                           throw(::com::sun::star::uno::RuntimeException);
 118     void getPropertyValue( const OUString &rName,
 119                                             const SfxItemSet& rSet,
 120                                             com::sun::star::uno::Any& rAny) const
 121                                             throw(::com::sun::star::uno::RuntimeException,
 122                                                     ::com::sun::star::beans::UnknownPropertyException);
 123     com::sun::star::uno::Any
 124         getPropertyValue( const OUString &rName,
 125                                             const SfxItemSet& rSet ) const
 126                                             throw(::com::sun::star::uno::RuntimeException,
 127                                                     ::com::sun::star::beans::UnknownPropertyException);
 128     void                setPropertyValue( const SfxItemPropertySimpleEntry& rEntry,
 129                                           const com::sun::star::uno::Any& aVal,
 130                                           SfxItemSet& rSet ) const
 131                                           throw(::com::sun::star::uno::RuntimeException,
 132                                                   com::sun::star::lang::IllegalArgumentException);
 133     void                  setPropertyValue( const OUString& rPropertyName,
 134                                             const com::sun::star::uno::Any& aVal,
 135                                             SfxItemSet& rSet ) const
 136                                             throw(::com::sun::star::uno::RuntimeException,
 137                                                     com::sun::star::lang::IllegalArgumentException,
 138                                                     ::com::sun::star::beans::UnknownPropertyException);
 139
 140     com::sun::star::beans::PropertyState
 141         getPropertyState(const OUString& rName, const SfxItemSet& rSet)const
 142                                     throw(com::sun::star::beans::UnknownPropertyException);
 143     com::sun::star::beans::PropertyState
 144         getPropertyState(const SfxItemPropertySimpleEntry& rEntry, const SfxItemSet& rSet) const
 145                                     throw();
 146
 147     com::sun::star::uno::Reference<com::sun::star::beans::XPropertySetInfo>
 148         getPropertySetInfo() const;
 149     const SfxItemPropertyMap& getPropertyMap() const {return m_aMap;}
 150 };
 151
 152 struct SfxItemPropertySetInfo_Impl;
 153 class SVL_DLLPUBLIC SfxItemPropertySetInfo : public
 154     cppu::WeakImplHelper1<com::sun::star::beans::XPropertySetInfo>
 155 {
 156     SfxItemPropertySetInfo_Impl* m_pImpl;
 157
 158 public:
 159     SfxItemPropertySetInfo(const SfxItemPropertyMap &rMap );
 160     SfxItemPropertySetInfo(const SfxItemPropertyMapEntry *pEntries );
 161     virtual ~SfxItemPropertySetInfo();
 162
 163     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL
 164         getProperties(  )
 165             throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 166
 167     virtual ::com::sun::star::beans::Property SAL_CALL
 168         getPropertyByName( const OUString& aName )
 169             throw(::com::sun::star::beans::UnknownPropertyException,
 170                     ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 171
 172     virtual sal_Bool SAL_CALL
 173         hasPropertyByName( const OUString& Name )
 174             throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 175
 176 };
 177
 178 class SVL_DLLPUBLIC SfxExtItemPropertySetInfo: public cppu::WeakImplHelper1<com::sun::star::beans::XPropertySetInfo >
 179 {
 180     SfxItemPropertyMap aExtMap;
 181 public:
 182                             SfxExtItemPropertySetInfo(
 183                                 const SfxItemPropertyMapEntry *pMap,
 184                                 const com::sun::star::uno::Sequence<com::sun::star::beans::Property>& rPropSeq );
 185                             virtual ~SfxExtItemPropertySetInfo();
 186
 187     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL
 188         getProperties(  )
 189             throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 190
 191     virtual ::com::sun::star::beans::Property SAL_CALL
 192         getPropertyByName( const OUString& aName )
 193             throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 194
 195     virtual sal_Bool SAL_CALL
 196         hasPropertyByName( const OUString& Name )
 197             throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 198 };
 199
 200 #endif
 201
 202 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */