extensions/source/propctrlr/inspectormodelbase.cxx

   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 #include <memory>
  21 #include "inspectormodelbase.hxx"
  22 #include "pcrcommon.hxx"
  23
  24 #include <com/sun/star/beans/PropertyAttribute.hpp>
  25
  26 #include <comphelper/propertycontainerhelper.hxx>
  27 #include <cppuhelper/supportsservice.hxx>
  28
  29
  30 namespace pcr
  31 {
  32
  33
  34 #define MODEL_PROPERTY_ID_HAS_HELP_SECTION      2000
  35 #define MODEL_PROPERTY_ID_MIN_HELP_TEXT_LINES   2001
  36 #define MODEL_PROPERTY_ID_MAX_HELP_TEXT_LINES   2002
  37 #define MODEL_PROPERTY_ID_IS_READ_ONLY          2003
  38
  39     using ::com::sun::star::uno::Reference;
  40     using ::com::sun::star::beans::XPropertySetInfo;
  41     using ::com::sun::star::uno::RuntimeException;
  42     using ::com::sun::star::uno::Any;
  43     using ::com::sun::star::lang::IllegalArgumentException;
  44     using ::com::sun::star::uno::Exception;
  45     using ::com::sun::star::uno::Sequence;
  46     using ::com::sun::star::uno::makeAny;
  47     using ::com::sun::star::beans::Property;
  48
  49     namespace PropertyAttribute = ::com::sun::star::beans::PropertyAttribute;
  50
  51
  52     //= InspectorModelProperties
  53
  54     /** helper class for implementing the property set related functionality
  55         of an ImplInspectorModel
  56     */
  57     class InspectorModelProperties : public ::comphelper::OPropertyContainerHelper
  58     {
  59     private:
  60         ::osl::Mutex&           m_rMutex;
  61         bool                m_bHasHelpSection;
  62         sal_Int32               m_nMinHelpTextLines;
  63         sal_Int32               m_nMaxHelpTextLines;
  64         bool                m_bIsReadOnly;
  65         std::unique_ptr< ::cppu::IPropertyArrayHelper >
  66                                 m_pPropertyInfo;
  67
  68     public:
  69         explicit InspectorModelProperties( ::osl::Mutex& _rMutex );
  70
  71         using ::comphelper::OPropertyContainerHelper::convertFastPropertyValue;
  72         using ::comphelper::OPropertyContainerHelper::setFastPropertyValue;
  73         using ::comphelper::OPropertyContainerHelper::getFastPropertyValue;
  74
  75     public:
  76         bool    hasHelpSection() const { return m_bHasHelpSection; }
  77         bool    isReadOnly() const { return m_bIsReadOnly; }
  78         sal_Int32   getMinHelpTextLines() const { return m_nMinHelpTextLines; }
  79         sal_Int32   getMaxHelpTextLines() const { return m_nMaxHelpTextLines; }
  80
  81         css::uno::Reference< css::beans::XPropertySetInfo >
  82                             getPropertySetInfo();
  83         ::cppu::IPropertyArrayHelper&
  84                             getInfoHelper();
  85
  86         void    constructWithHelpSection( sal_Int32 _nMinHelpTextLines, sal_Int32 _nMaxHelpTextLines );
  87     };
  88
  89
  90     //= InspectorModelProperties
  91
  92
  93     InspectorModelProperties::InspectorModelProperties( ::osl::Mutex& _rMutex )
  94         :m_rMutex( _rMutex )
  95         ,m_bHasHelpSection( false )
  96         ,m_nMinHelpTextLines( 3 )
  97         ,m_nMaxHelpTextLines( 8 )
  98         ,m_bIsReadOnly( false )
  99     {
 100         registerProperty(
 101             "HasHelpSection",
 102             MODEL_PROPERTY_ID_HAS_HELP_SECTION,
 103             PropertyAttribute::READONLY,
 104             &m_bHasHelpSection, cppu::UnoType<decltype(m_bHasHelpSection)>::get()
 105         );
 106         registerProperty(
 107             "MinHelpTextLines",
 108             MODEL_PROPERTY_ID_MIN_HELP_TEXT_LINES,
 109             PropertyAttribute::READONLY,
 110             &m_nMinHelpTextLines, cppu::UnoType<decltype(m_nMinHelpTextLines)>::get()
 111         );
 112         registerProperty(
 113             "MaxHelpTextLines",
 114             MODEL_PROPERTY_ID_MAX_HELP_TEXT_LINES,
 115             PropertyAttribute::READONLY,
 116             &m_nMaxHelpTextLines, cppu::UnoType<decltype(m_nMaxHelpTextLines)>::get()
 117         );
 118         registerProperty(
 119             "IsReadOnly",
 120             MODEL_PROPERTY_ID_IS_READ_ONLY,
 121             PropertyAttribute::BOUND,
 122             &m_bIsReadOnly, cppu::UnoType<decltype(m_bIsReadOnly)>::get()
 123         );
 124     }
 125
 126
 127     void InspectorModelProperties::constructWithHelpSection( sal_Int32 _nMinHelpTextLines, sal_Int32 _nMaxHelpTextLines )
 128     {
 129         m_bHasHelpSection = true;
 130         m_nMinHelpTextLines = _nMinHelpTextLines;
 131         m_nMaxHelpTextLines = _nMaxHelpTextLines;
 132         // no need to notify this, those properties are not bound. Also, the method should
 133         // only be used during construction phase, where we don't expect to have any listeners.
 134     }
 135
 136
 137     ::cppu::IPropertyArrayHelper& InspectorModelProperties::getInfoHelper()
 138     {
 139         ::osl::MutexGuard aGuard( m_rMutex );
 140         if ( m_pPropertyInfo.get() == nullptr )
 141         {
 142             Sequence< Property > aProperties;
 143             describeProperties( aProperties );
 144
 145             m_pPropertyInfo.reset( new ::cppu::OPropertyArrayHelper( aProperties ) );
 146         }
 147         return *m_pPropertyInfo;
 148     }
 149
 150
 151     Reference< XPropertySetInfo > InspectorModelProperties::getPropertySetInfo()
 152     {
 153         return ::cppu::OPropertySetHelper::createPropertySetInfo( getInfoHelper() );
 154     }
 155
 156
 157     //= ImplInspectorModel
 158
 159     ImplInspectorModel::ImplInspectorModel()
 160         :ImplInspectorModel_PBase( GetBroadcastHelper() )
 161         ,m_pProperties( new InspectorModelProperties( m_aMutex ) )
 162     {
 163     }
 164
 165
 166     ImplInspectorModel::~ImplInspectorModel()
 167     {
 168     }
 169
 170
 171     IMPLEMENT_FORWARD_XINTERFACE2( ImplInspectorModel, ImplInspectorModel_Base, ImplInspectorModel_PBase )
 172
 173
 174     IMPLEMENT_FORWARD_XTYPEPROVIDER2( ImplInspectorModel, ImplInspectorModel_Base, ImplInspectorModel_PBase )
 175
 176
 177     Reference< XPropertySetInfo > SAL_CALL ImplInspectorModel::getPropertySetInfo(  )
 178     {
 179         return m_pProperties->getPropertySetInfo();
 180     }
 181
 182
 183     ::cppu::IPropertyArrayHelper& SAL_CALL ImplInspectorModel::getInfoHelper()
 184     {
 185         return m_pProperties->getInfoHelper();
 186     }
 187
 188
 189     sal_Bool SAL_CALL ImplInspectorModel::convertFastPropertyValue( Any & rConvertedValue, Any & rOldValue, sal_Int32 nHandle, const Any& rValue )
 190     {
 191         return m_pProperties->convertFastPropertyValue( rConvertedValue, rOldValue, nHandle, rValue );
 192     }
 193
 194
 195     void SAL_CALL ImplInspectorModel::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const Any& rValue )
 196     {
 197         m_pProperties->setFastPropertyValue( nHandle, rValue );
 198     }
 199
 200
 201     void SAL_CALL ImplInspectorModel::getFastPropertyValue( Any& rValue, sal_Int32 nHandle ) const
 202     {
 203         m_pProperties->getFastPropertyValue( rValue, nHandle );
 204     }
 205
 206
 207     sal_Bool SAL_CALL ImplInspectorModel::getHasHelpSection()
 208     {
 209         return m_pProperties->hasHelpSection();
 210     }
 211
 212
 213     ::sal_Int32 SAL_CALL ImplInspectorModel::getMinHelpTextLines()
 214     {
 215         return m_pProperties->getMinHelpTextLines();
 216     }
 217
 218
 219     ::sal_Int32 SAL_CALL ImplInspectorModel::getMaxHelpTextLines()
 220     {
 221         return m_pProperties->getMaxHelpTextLines();
 222     }
 223
 224
 225     sal_Bool SAL_CALL ImplInspectorModel::getIsReadOnly()
 226     {
 227         return m_pProperties->isReadOnly();
 228     }
 229
 230
 231     void SAL_CALL ImplInspectorModel::setIsReadOnly( sal_Bool IsReadOnly )
 232     {
 233         setFastPropertyValue( MODEL_PROPERTY_ID_IS_READ_ONLY, makeAny( IsReadOnly ) );
 234     }
 235
 236     sal_Bool SAL_CALL ImplInspectorModel::supportsService( const OUString& ServiceName )
 237     {
 238         return cppu::supportsService(this, ServiceName);
 239     }
 240
 241
 242     void ImplInspectorModel::enableHelpSectionProperties( sal_Int32 _nMinHelpTextLines, sal_Int32 _nMaxHelpTextLines )
 243     {
 244         m_pProperties->constructWithHelpSection( _nMinHelpTextLines, _nMaxHelpTextLines );
 245     }
 246
 247
 248 } // namespace pcr
 249
 250
 251 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */