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