forms/source/component/ImageButton.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 "ImageButton.hxx"
  21 #include <tools/debug.hxx>
  22 #include <tools/urlobj.hxx>
  23 #include <vcl/svapp.hxx>
  24 #include <osl/mutex.hxx>
  25 #include <comphelper/basicio.hxx>
  26 #include <com/sun/star/awt/MouseButton.hpp>
  27 #include <com/sun/star/beans/PropertyAttribute.hpp>
  28 #include <com/sun/star/form/FormComponentType.hpp>
  29 #include <property.hxx>
  30 #include <services.hxx>
  31
  32 namespace frm
  33 {
  34
  35 using namespace ::com::sun::star;
  36 using namespace ::com::sun::star::uno;
  37 using namespace ::com::sun::star::sdb;
  38 using namespace ::com::sun::star::sdbc;
  39 using namespace ::com::sun::star::beans;
  40 using namespace ::com::sun::star::form;
  41 using namespace ::com::sun::star::io;
  42 using namespace ::com::sun::star::lang;
  43 using namespace ::com::sun::star::util;
  44
  45 // OImageButtonModel
  46 OImageButtonModel::OImageButtonModel(const Reference<XComponentContext>& _rxFactory)
  47                     :OClickableImageBaseModel( _rxFactory, VCL_CONTROLMODEL_IMAGEBUTTON, FRM_SUN_CONTROL_IMAGEBUTTON )
  48                     // use the old control name for compatibility reasons
  49 {
  50     m_nClassId = FormComponentType::IMAGEBUTTON;
  51 }
  52
  53 OImageButtonModel::OImageButtonModel( const OImageButtonModel* _pOriginal, const Reference<XComponentContext>& _rxFactory)
  54     :OClickableImageBaseModel( _pOriginal, _rxFactory )
  55 {
  56     implInitializeImageURL();
  57 }
  58
  59 css::uno::Reference< css::util::XCloneable > SAL_CALL OImageButtonModel::createClone()
  60 {
  61     rtl::Reference<OImageButtonModel> pClone = new OImageButtonModel(this, getContext());
  62     pClone->clonedFrom(this);
  63     return pClone;
  64 }
  65
  66 OImageButtonModel::~OImageButtonModel()
  67 {
  68 }
  69
  70 // XServiceInfo
  71 css::uno::Sequence<OUString>  OImageButtonModel::getSupportedServiceNames()
  72 {
  73     css::uno::Sequence<OUString> aSupported = OClickableImageBaseModel::getSupportedServiceNames();
  74     aSupported.realloc(aSupported.getLength() + 2);
  75
  76     OUString*pArray = aSupported.getArray();
  77     pArray[aSupported.getLength()-2] = FRM_SUN_COMPONENT_IMAGEBUTTON;
  78     pArray[aSupported.getLength()-1] = FRM_COMPONENT_IMAGEBUTTON;
  79     return aSupported;
  80 }
  81
  82 void OImageButtonModel::describeFixedProperties( Sequence< Property >& _rProps ) const
  83 {
  84     OClickableImageBaseModel::describeFixedProperties( _rProps );
  85     sal_Int32 nOldCount = _rProps.getLength();
  86     _rProps.realloc( nOldCount + 5);
  87     css::beans::Property* pProperties = _rProps.getArray() + nOldCount;
  88     *pProperties++ = css::beans::Property(PROPERTY_BUTTONTYPE, PROPERTY_ID_BUTTONTYPE, cppu::UnoType<FormButtonType>::get(), css::beans::PropertyAttribute::BOUND);
  89     *pProperties++ = css::beans::Property(PROPERTY_DISPATCHURLINTERNAL, PROPERTY_ID_DISPATCHURLINTERNAL, cppu::UnoType<sal_Bool>::get(), css::beans::PropertyAttribute::BOUND);
  90     *pProperties++ = css::beans::Property(PROPERTY_TARGET_URL, PROPERTY_ID_TARGET_URL, cppu::UnoType<OUString>::get(), css::beans::PropertyAttribute::BOUND);
  91     *pProperties++ = css::beans::Property(PROPERTY_TARGET_FRAME, PROPERTY_ID_TARGET_FRAME, cppu::UnoType<OUString>::get(), css::beans::PropertyAttribute::BOUND);
  92     *pProperties++ = css::beans::Property(PROPERTY_TABINDEX, PROPERTY_ID_TABINDEX, cppu::UnoType<sal_Int16>::get(), css::beans::PropertyAttribute::BOUND);
  93     DBG_ASSERT( pProperties == _rProps.getArray() + _rProps.getLength(), "<...>::describeFixedProperties/getInfoHelper: forgot to adjust the count ?");
  94 }
  95
  96 OUString OImageButtonModel::getServiceName()
  97 {
  98     return FRM_COMPONENT_IMAGEBUTTON;   // old (non-sun) name for compatibility !
  99 }
 100
 101 void OImageButtonModel::write(const Reference<XObjectOutputStream>& _rxOutStream)
 102 {
 103     OControlModel::write(_rxOutStream);
 104
 105     // Version
 106     _rxOutStream->writeShort(0x0003);
 107     _rxOutStream->writeShort(static_cast<sal_uInt16>(m_eButtonType));
 108
 109     OUString sTmp(INetURLObject::decode( m_sTargetURL, INetURLObject::DecodeMechanism::Unambiguous));
 110     _rxOutStream << sTmp;
 111     _rxOutStream << m_sTargetFrame;
 112     writeHelpTextCompatibly(_rxOutStream);
 113 }
 114
 115 void OImageButtonModel::read(const Reference<XObjectInputStream>& _rxInStream)
 116 {
 117     OControlModel::read(_rxInStream);
 118
 119     // Version
 120     sal_uInt16 nVersion = _rxInStream->readShort();
 121
 122     switch (nVersion)
 123     {
 124         case 0x0001:
 125         {
 126             m_eButtonType = static_cast<FormButtonType>(_rxInStream->readShort());
 127         }
 128         break;
 129         case 0x0002:
 130         {
 131             m_eButtonType = static_cast<FormButtonType>(_rxInStream->readShort());
 132             _rxInStream >> m_sTargetURL;
 133             _rxInStream >> m_sTargetFrame;
 134         }
 135         break;
 136         case 0x0003:
 137         {
 138             m_eButtonType = static_cast<FormButtonType>(_rxInStream->readShort());
 139             _rxInStream >> m_sTargetURL;
 140             _rxInStream >> m_sTargetFrame;
 141             readHelpTextCompatibly(_rxInStream);
 142         }
 143         break;
 144
 145         default :
 146             OSL_FAIL("OImageButtonModel::read : unknown version !");
 147             m_eButtonType = FormButtonType_PUSH;
 148             m_sTargetURL.clear();
 149             m_sTargetFrame.clear();
 150             break;
 151     }
 152 }
 153
 154 // OImageButtonControl
 155 Sequence<Type> OImageButtonControl::_getTypes()
 156 {
 157     static Sequence<Type> const aTypes =
 158         concatSequences(OClickableImageBaseControl::_getTypes(), OImageButtonControl_BASE::getTypes());
 159     return aTypes;
 160 }
 161
 162 css::uno::Sequence<OUString>  OImageButtonControl::getSupportedServiceNames()
 163 {
 164     css::uno::Sequence<OUString> aSupported = OClickableImageBaseControl::getSupportedServiceNames();
 165     aSupported.realloc(aSupported.getLength() + 2);
 166
 167     OUString*pArray = aSupported.getArray();
 168     pArray[aSupported.getLength()-2] = FRM_SUN_CONTROL_IMAGEBUTTON;
 169     pArray[aSupported.getLength()-1] = STARDIV_ONE_FORM_CONTROL_IMAGEBUTTON;
 170     return aSupported;
 171 }
 172
 173 OImageButtonControl::OImageButtonControl(const Reference<XComponentContext>& _rxFactory)
 174             :OClickableImageBaseControl(_rxFactory, VCL_CONTROL_IMAGEBUTTON)
 175 {
 176     osl_atomic_increment(&m_refCount);
 177     {
 178         // Register as MouseListener
 179         if (auto xComp = query_aggregation<awt::XWindow>(m_xAggregate))
 180             xComp->addMouseListener( static_cast< awt::XMouseListener* >( this ) );
 181     }
 182     osl_atomic_decrement(&m_refCount);
 183 }
 184
 185 // UNO Binding
 186 Any SAL_CALL OImageButtonControl::queryAggregation(const Type& _rType)
 187 {
 188     Any aReturn = OClickableImageBaseControl::queryAggregation(_rType);
 189     if (!aReturn.hasValue())
 190         aReturn = OImageButtonControl_BASE::queryInterface(_rType);
 191
 192     return aReturn;
 193 }
 194
 195 void OImageButtonControl::mousePressed(const awt::MouseEvent& e)
 196 {
 197     SolarMutexGuard aSolarGuard;
 198
 199     if (e.Buttons != awt::MouseButton::LEFT)
 200         return;
 201
 202     ::osl::ClearableMutexGuard aGuard( m_aMutex );
 203     if( m_aApproveActionListeners.getLength() )
 204     {
 205         // if there are listeners, start the action in an own thread, to not allow
 206         // them to block us here (we're in the application's main thread)
 207         getImageProducerThread()->OComponentEventThread::addEvent( std::make_unique<awt::MouseEvent>(e) );
 208     }
 209     else
 210     {
 211         // Or else don't; we must not notify the listeners in that case.
 212         // Even not if it's added later on.
 213         aGuard.clear();
 214         actionPerformed_Impl( false, e );
 215     }
 216 }
 217
 218 void SAL_CALL OImageButtonControl::mouseReleased(const awt::MouseEvent& /*e*/)
 219 {
 220 }
 221
 222 void SAL_CALL OImageButtonControl::mouseEntered(const awt::MouseEvent& /*e*/)
 223 {
 224 }
 225
 226 void SAL_CALL OImageButtonControl::mouseExited(const awt::MouseEvent& /*e*/)
 227 {
 228 }
 229
 230 }   // namespace frm
 231
 232 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 233 com_sun_star_form_OImageButtonModel_get_implementation(css::uno::XComponentContext* component,
 234         css::uno::Sequence<css::uno::Any> const &)
 235 {
 236     return cppu::acquire(new frm::OImageButtonModel(component));
 237 }
 238
 239 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 240 com_sun_star_form_OImageButtonControl_get_implementation(css::uno::XComponentContext* component,
 241         css::uno::Sequence<css::uno::Any> const &)
 242 {
 243     return cppu::acquire(new frm::OImageButtonControl(component));
 244 }
 245
 246 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */