extensions/source/propctrlr/buttonnavigationhandler.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 "buttonnavigationhandler.hxx"
  21 #include "formstrings.hxx"
  22 #include "formmetadata.hxx"
  23 #include "pushbuttonnavigation.hxx"
  24
  25 #include <com/sun/star/form/inspection/FormComponentPropertyHandler.hpp>
  26
  27 namespace pcr
  28 {
  29
  30
  31     using namespace ::com::sun::star::uno;
  32     using namespace ::com::sun::star::beans;
  33     using namespace ::com::sun::star::inspection;
  34
  35     ButtonNavigationHandler::ButtonNavigationHandler( const Reference< XComponentContext >& _rxContext )
  36         :PropertyHandlerComponent( _rxContext )
  37     {
  38
  39         m_xSlaveHandler = css::form::inspection::FormComponentPropertyHandler::create( m_xContext );
  40     }
  41
  42
  43     ButtonNavigationHandler::~ButtonNavigationHandler( )
  44     {
  45     }
  46
  47
  48     OUString ButtonNavigationHandler::getImplementationName(  )
  49     {
  50         return u"com.sun.star.comp.extensions.ButtonNavigationHandler"_ustr;
  51     }
  52
  53
  54     Sequence< OUString > ButtonNavigationHandler::getSupportedServiceNames(  )
  55     {
  56         return { u"com.sun.star.form.inspection.ButtonNavigationHandler"_ustr };
  57     }
  58
  59
  60     void SAL_CALL ButtonNavigationHandler::inspect( const Reference< XInterface >& _rxIntrospectee )
  61     {
  62         PropertyHandlerComponent::inspect( _rxIntrospectee );
  63         m_xSlaveHandler->inspect( _rxIntrospectee );
  64     }
  65
  66
  67     PropertyState  SAL_CALL ButtonNavigationHandler::getPropertyState( const OUString& _rPropertyName )
  68     {
  69         ::osl::MutexGuard aGuard( m_aMutex );
  70         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
  71         PropertyState eState = PropertyState_DIRECT_VALUE;
  72         switch ( nPropId )
  73         {
  74         case PROPERTY_ID_BUTTONTYPE:
  75         {
  76             PushButtonNavigation aHelper( m_xComponent );
  77             eState = aHelper.getCurrentButtonTypeState();
  78         }
  79         break;
  80         case PROPERTY_ID_TARGET_URL:
  81         {
  82             PushButtonNavigation aHelper( m_xComponent );
  83             eState = aHelper.getCurrentTargetURLState();
  84         }
  85         break;
  86
  87         default:
  88             OSL_FAIL( "ButtonNavigationHandler::getPropertyState: cannot handle this property!" );
  89             break;
  90         }
  91
  92         return eState;
  93     }
  94
  95
  96     Any SAL_CALL ButtonNavigationHandler::getPropertyValue( const OUString& _rPropertyName )
  97     {
  98         ::osl::MutexGuard aGuard( m_aMutex );
  99         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 100
 101         Any aReturn;
 102         switch ( nPropId )
 103         {
 104         case PROPERTY_ID_BUTTONTYPE:
 105         {
 106             PushButtonNavigation aHelper( m_xComponent );
 107             aReturn = aHelper.getCurrentButtonType();
 108         }
 109         break;
 110
 111         case PROPERTY_ID_TARGET_URL:
 112         {
 113             PushButtonNavigation aHelper( m_xComponent );
 114             aReturn = aHelper.getCurrentTargetURL();
 115         }
 116         break;
 117
 118         default:
 119             OSL_FAIL( "ButtonNavigationHandler::getPropertyValue: cannot handle this property!" );
 120             break;
 121         }
 122
 123         return aReturn;
 124     }
 125
 126
 127     void SAL_CALL ButtonNavigationHandler::setPropertyValue( const OUString& _rPropertyName, const Any& _rValue )
 128     {
 129         ::osl::MutexGuard aGuard( m_aMutex );
 130         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 131         switch ( nPropId )
 132         {
 133         case PROPERTY_ID_BUTTONTYPE:
 134         {
 135             PushButtonNavigation aHelper( m_xComponent );
 136             aHelper.setCurrentButtonType( _rValue );
 137         }
 138         break;
 139
 140         case PROPERTY_ID_TARGET_URL:
 141         {
 142             PushButtonNavigation aHelper( m_xComponent );
 143             aHelper.setCurrentTargetURL( _rValue );
 144         }
 145         break;
 146
 147         default:
 148             OSL_FAIL( "ButtonNavigationHandler::setPropertyValue: cannot handle this id!" );
 149         }
 150     }
 151
 152
 153     bool ButtonNavigationHandler::isNavigationCapableButton( const Reference< XPropertySet >& _rxComponent )
 154     {
 155         Reference< XPropertySetInfo > xPSI;
 156         if ( _rxComponent.is() )
 157             xPSI = _rxComponent->getPropertySetInfo();
 158
 159         return xPSI.is()
 160             && xPSI->hasPropertyByName( PROPERTY_TARGET_URL )
 161             && xPSI->hasPropertyByName( PROPERTY_BUTTONTYPE );
 162     }
 163
 164
 165     Sequence< Property > ButtonNavigationHandler::doDescribeSupportedProperties() const
 166     {
 167         std::vector< Property > aProperties;
 168
 169         if ( isNavigationCapableButton( m_xComponent ) )
 170         {
 171             addStringPropertyDescription( aProperties, PROPERTY_TARGET_URL );
 172             implAddPropertyDescription( aProperties, PROPERTY_BUTTONTYPE, ::cppu::UnoType<sal_Int32>::get() );
 173         }
 174
 175         if ( aProperties.empty() )
 176             return Sequence< Property >();
 177         return comphelper::containerToSequence(aProperties);
 178     }
 179
 180
 181     Sequence< OUString > SAL_CALL ButtonNavigationHandler::getActuatingProperties( )
 182     {
 183         Sequence< OUString > aActuating{ PROPERTY_BUTTONTYPE, PROPERTY_TARGET_URL };
 184         return aActuating;
 185     }
 186
 187
 188     InteractiveSelectionResult SAL_CALL ButtonNavigationHandler::onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool _bPrimary, Any& _rData, const Reference< XObjectInspectorUI >& _rxInspectorUI )
 189     {
 190         ::osl::MutexGuard aGuard( m_aMutex );
 191         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 192
 193         InteractiveSelectionResult eReturn( InteractiveSelectionResult_Cancelled );
 194
 195         switch ( nPropId )
 196         {
 197         case PROPERTY_ID_TARGET_URL:
 198             eReturn = m_xSlaveHandler->onInteractivePropertySelection( _rPropertyName, _bPrimary, _rData, _rxInspectorUI );
 199             break;
 200         default:
 201             eReturn = PropertyHandlerComponent::onInteractivePropertySelection( _rPropertyName, _bPrimary, _rData, _rxInspectorUI );
 202             break;
 203         }
 204
 205         return eReturn;
 206     }
 207
 208
 209     void SAL_CALL ButtonNavigationHandler::actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const Any& /*_rNewValue*/, const Any& /*_rOldValue*/, const Reference< XObjectInspectorUI >& _rxInspectorUI, sal_Bool /*_bFirstTimeInit*/ )
 210     {
 211         ::osl::MutexGuard aGuard( m_aMutex );
 212         PropertyId nPropId( impl_getPropertyId_throwRuntime( _rActuatingPropertyName ) );
 213         switch ( nPropId )
 214         {
 215         case PROPERTY_ID_BUTTONTYPE:
 216         {
 217             PushButtonNavigation aHelper( m_xComponent );
 218             _rxInspectorUI->enablePropertyUI( PROPERTY_TARGET_URL, aHelper.currentButtonTypeIsOpenURL() );
 219         }
 220         break;
 221
 222         case PROPERTY_ID_TARGET_URL:
 223         {
 224             PushButtonNavigation aHelper( m_xComponent );
 225             _rxInspectorUI->enablePropertyUI( PROPERTY_TARGET_FRAME, aHelper.hasNonEmptyCurrentTargetURL() );
 226         }
 227         break;
 228
 229         default:
 230             OSL_FAIL( "ButtonNavigationHandler::actuatingPropertyChanged: cannot handle this id!" );
 231         }
 232     }
 233
 234
 235     LineDescriptor SAL_CALL ButtonNavigationHandler::describePropertyLine( const OUString& _rPropertyName, const Reference< XPropertyControlFactory >& _rxControlFactory )
 236     {
 237         ::osl::MutexGuard aGuard( m_aMutex );
 238         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 239
 240         LineDescriptor aReturn;
 241
 242         switch ( nPropId )
 243         {
 244         case PROPERTY_ID_TARGET_URL:
 245             aReturn = m_xSlaveHandler->describePropertyLine( _rPropertyName, _rxControlFactory );
 246             break;
 247         default:
 248             aReturn = PropertyHandlerComponent::describePropertyLine( _rPropertyName, _rxControlFactory );
 249             break;
 250         }
 251
 252         return aReturn;
 253     }
 254
 255
 256 }   // namespace pcr
 257
 258 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 259 extensions_propctrlr_ButtonNavigationHandler_get_implementation(
 260     css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
 261 {
 262     return cppu::acquire(new pcr::ButtonNavigationHandler(context));
 263 }
 264
 265 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */