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