framework/source/helper/uielementwrapperbase.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 <helper/uielementwrapperbase.hxx>
  21 #include <general.h>
  22 #include <properties.h>
  23
  24 #include <com/sun/star/beans/PropertyAttribute.hpp>
  25 #include <com/sun/star/beans/PropertyValue.hpp>
  26 #include <com/sun/star/beans/XPropertySet.hpp>
  27
  28 #include <vcl/svapp.hxx>
  29 #include <comphelper/sequence.hxx>
  30
  31 const int UIELEMENT_PROPHANDLE_RESOURCEURL  = 1;
  32 const int UIELEMENT_PROPHANDLE_TYPE         = 2;
  33 const int UIELEMENT_PROPHANDLE_FRAME        = 3;
  34 const char UIELEMENT_PROPNAME_RESOURCEURL[] = "ResourceURL";
  35 const char UIELEMENT_PROPNAME_TYPE[] = "Type";
  36 const char UIELEMENT_PROPNAME_FRAME[] = "Frame";
  37
  38 using namespace ::com::sun::star::uno;
  39 using namespace ::com::sun::star::beans;
  40 using namespace ::com::sun::star::frame;
  41
  42 namespace framework
  43 {
  44
  45 UIElementWrapperBase::UIElementWrapperBase( sal_Int16 nType )
  46     :   ::cppu::OBroadcastHelperVar< ::cppu::OMultiTypeInterfaceContainerHelper, ::cppu::OMultiTypeInterfaceContainerHelper::keyType >( m_aMutex )
  47     ,   ::cppu::OPropertySetHelper  ( *static_cast< ::cppu::OBroadcastHelper* >(this) )
  48     ,   m_aListenerContainer        ( m_aMutex )
  49     ,   m_nType                     ( nType                                             )
  50     ,   m_bInitialized              ( false                                         )
  51     ,   m_bDisposed                 ( false                                         )
  52 {
  53 }
  54
  55 UIElementWrapperBase::~UIElementWrapperBase()
  56 {
  57 }
  58
  59 Any SAL_CALL UIElementWrapperBase::queryInterface( const Type& _rType )
  60 {
  61     Any aRet = UIElementWrapperBase_BASE::queryInterface( _rType );
  62     if ( !aRet.hasValue() )
  63         aRet = OPropertySetHelper::queryInterface( _rType );
  64     return aRet;
  65 }
  66
  67 Sequence< Type > SAL_CALL UIElementWrapperBase::getTypes(  )
  68 {
  69     return comphelper::concatSequences(
  70         UIElementWrapperBase_BASE::getTypes(),
  71         ::cppu::OPropertySetHelper::getTypes()
  72     );
  73 }
  74
  75 void SAL_CALL UIElementWrapperBase::addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener )
  76 {
  77     m_aListenerContainer.addInterface( cppu::UnoType<css::lang::XEventListener>::get(), xListener );
  78 }
  79
  80 void SAL_CALL UIElementWrapperBase::removeEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener )
  81 {
  82     m_aListenerContainer.removeInterface( cppu::UnoType<css::lang::XEventListener>::get(), xListener );
  83 }
  84
  85 void SAL_CALL UIElementWrapperBase::initialize( const Sequence< Any >& aArguments )
  86 {
  87     SolarMutexGuard g;
  88
  89     if ( !m_bInitialized )
  90     {
  91         for ( sal_Int32 n = 0; n < aArguments.getLength(); n++ )
  92         {
  93             PropertyValue aPropValue;
  94             if ( aArguments[n] >>= aPropValue )
  95             {
  96                 if ( aPropValue.Name == "ResourceURL" )
  97                     aPropValue.Value >>= m_aResourceURL;
  98                 else if ( aPropValue.Name == "Frame" )
  99                 {
 100                     Reference< XFrame > xFrame;
 101                     aPropValue.Value >>= xFrame;
 102                     m_xWeakFrame = xFrame;
 103                 }
 104             }
 105         }
 106
 107         m_bInitialized = true;
 108     }
 109 }
 110
 111 // XUIElement
 112 css::uno::Reference< css::frame::XFrame > SAL_CALL UIElementWrapperBase::getFrame()
 113 {
 114     css::uno::Reference< css::frame::XFrame > xFrame( m_xWeakFrame );
 115     return xFrame;
 116 }
 117
 118 OUString SAL_CALL UIElementWrapperBase::getResourceURL()
 119 {
 120     return m_aResourceURL;
 121 }
 122
 123 ::sal_Int16 SAL_CALL UIElementWrapperBase::getType()
 124 {
 125     return m_nType;
 126 }
 127
 128 // XUpdatable
 129 void SAL_CALL UIElementWrapperBase::update()
 130 {
 131     // can be implemented by derived class
 132 }
 133
 134 // XPropertySet helper
 135 sal_Bool SAL_CALL UIElementWrapperBase::convertFastPropertyValue( Any&       /*aConvertedValue*/ ,
 136                                                                   Any&       /*aOldValue*/       ,
 137                                                                   sal_Int32  /*nHandle*/         ,
 138                                                                   const Any& /*aValue*/             )
 139 {
 140     //  Initialize state with sal_False !!!
 141     //  (Handle can be invalid)
 142     return false;
 143 }
 144
 145 void SAL_CALL UIElementWrapperBase::setFastPropertyValue_NoBroadcast(   sal_Int32               /*nHandle*/ ,
 146                                                                         const css::uno::Any&    /*aValue*/  )
 147 {
 148 }
 149
 150 void SAL_CALL UIElementWrapperBase::getFastPropertyValue( css::uno::Any& aValue  ,
 151                                                           sal_Int32      nHandle                ) const
 152 {
 153     switch( nHandle )
 154     {
 155         case UIELEMENT_PROPHANDLE_RESOURCEURL:
 156             aValue <<= m_aResourceURL;
 157             break;
 158         case UIELEMENT_PROPHANDLE_TYPE:
 159             aValue <<= m_nType;
 160             break;
 161         case UIELEMENT_PROPHANDLE_FRAME:
 162             Reference< XFrame > xFrame( m_xWeakFrame );
 163             aValue <<= xFrame;
 164             break;
 165     }
 166 }
 167
 168 ::cppu::IPropertyArrayHelper& SAL_CALL UIElementWrapperBase::getInfoHelper()
 169 {
 170     // Define static member to give structure of properties to baseclass "OPropertySetHelper".
 171     // "impl_getStaticPropertyDescriptor" is a non exported and static function, who will define a static propertytable.
 172     // "true" say: Table is sorted by name.
 173     static ::cppu::OPropertyArrayHelper ourInfoHelper( impl_getStaticPropertyDescriptor(), true );
 174
 175     return ourInfoHelper;
 176 }
 177
 178 css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL UIElementWrapperBase::getPropertySetInfo()
 179 {
 180     // Create structure of propertysetinfo for baseclass "OPropertySetHelper".
 181     // (Use method "getInfoHelper()".)
 182     static css::uno::Reference< css::beans::XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 183
 184     return xInfo;
 185 }
 186
 187 css::uno::Sequence< css::beans::Property > UIElementWrapperBase::impl_getStaticPropertyDescriptor()
 188 {
 189     // Create a property array to initialize sequence!
 190     // Table of all predefined properties of this class. It's used from OPropertySetHelper-class!
 191     // Don't forget to change the defines (see begin of this file), if you add, change or delete a property in this list!!!
 192     // It's necessary for methods of OPropertySetHelper.
 193     // ATTENTION:
 194     //      YOU MUST SORT FOLLOW TABLE BY NAME ALPHABETICAL !!!
 195
 196     return
 197     {
 198         css::beans::Property( UIELEMENT_PROPNAME_FRAME, UIELEMENT_PROPHANDLE_FRAME          , cppu::UnoType<XFrame>::get(), css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
 199         css::beans::Property( UIELEMENT_PROPNAME_RESOURCEURL, UIELEMENT_PROPHANDLE_RESOURCEURL    , cppu::UnoType<sal_Int16>::get(), css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
 200         css::beans::Property( UIELEMENT_PROPNAME_TYPE, UIELEMENT_PROPHANDLE_TYPE           , cppu::UnoType<OUString>::get(), css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY )
 201     };
 202 }
 203
 204 }
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */