/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #include "richtextcontrol.hxx" #include #include #include "richtextmodel.hxx" #include "richtextvclcontrol.hxx" #include "clipboarddispatcher.hxx" #include "parametrizedattributedispatcher.hxx" #include "specialdispatchers.hxx" #include #include #include #include #include #include #include #include #include #include #include #include namespace frm { using namespace ::com::sun::star::uno; using namespace ::com::sun::star::beans; using namespace ::com::sun::star::awt; using namespace ::com::sun::star::lang; using namespace ::com::sun::star::frame; ORichTextControl::ORichTextControl() { } ORichTextControl::~ORichTextControl() { } IMPLEMENT_FORWARD_XTYPEPROVIDER2( ORichTextControl, UnoEditControl, ORichTextControl_Base ) Any SAL_CALL ORichTextControl::queryAggregation( const Type& _rType ) { Any aReturn = UnoEditControl::queryAggregation( _rType ); if ( !aReturn.hasValue() ) aReturn = ORichTextControl_Base::queryInterface( _rType ); return aReturn; } namespace { void implAdjustTriStateFlag( const Reference< XPropertySet >& _rxProps, const OUString& _rPropertyName, WinBits& _rAllBits, WinBits _nPositiveFlag, WinBits nNegativeFlag ) { bool bFlagValue = false; if ( _rxProps->getPropertyValue( _rPropertyName ) >>= bFlagValue ) _rAllBits |= ( bFlagValue ? _nPositiveFlag : nNegativeFlag ); } void implAdjustTwoStateFlag( const Any& _rValue, WinBits& _rAllBits, WinBits _nFlag, bool _bInvert ) { bool bFlagValue = false; if ( _rValue >>= bFlagValue ) { if ( _bInvert ) bFlagValue = !bFlagValue; if ( bFlagValue ) _rAllBits |= _nFlag; else _rAllBits &= ~_nFlag; } } void implAdjustTwoStateFlag( const Reference< XPropertySet >& _rxProps, const OUString& _rPropertyName, WinBits& _rAllBits, WinBits _nFlag, bool _bInvert = false ) { implAdjustTwoStateFlag( _rxProps->getPropertyValue( _rPropertyName ), _rAllBits, _nFlag, _bInvert ); } void adjustTwoStateWinBit( vcl::Window* _pWindow, const Any& _rValue, WinBits _nFlag, bool _bInvert = false ) { WinBits nBits = _pWindow->GetStyle(); implAdjustTwoStateFlag( _rValue, nBits, _nFlag, _bInvert ); _pWindow->SetStyle( nBits ); } WinBits getWinBits( const Reference< XControlModel >& _rxModel ) { WinBits nBits = 0; try { Reference< XPropertySet > xProps( _rxModel, UNO_QUERY ); if ( xProps.is() ) { sal_Int16 nBorder = 0; xProps->getPropertyValue( PROPERTY_BORDER ) >>= nBorder; if ( nBorder ) nBits |= WB_BORDER; implAdjustTriStateFlag( xProps, PROPERTY_TABSTOP, nBits, WB_TABSTOP, WB_NOTABSTOP ); implAdjustTwoStateFlag( xProps, PROPERTY_HSCROLL, nBits, WB_HSCROLL ); implAdjustTwoStateFlag( xProps, PROPERTY_VSCROLL, nBits, WB_VSCROLL ); implAdjustTwoStateFlag( xProps, PROPERTY_HARDLINEBREAKS, nBits, WB_WORDBREAK, true ); } } catch( const Exception& ) { DBG_UNHANDLED_EXCEPTION("forms.richtext"); } return nBits; } } void SAL_CALL ORichTextControl::createPeer( const Reference< XToolkit >& _rToolkit, const Reference< XWindowPeer >& _rParentPeer ) { bool bReallyActAsRichText = false; try { Reference< XPropertySet > xModelProps( getModel(), UNO_QUERY_THROW ); xModelProps->getPropertyValue( PROPERTY_RICH_TEXT ) >>= bReallyActAsRichText; } catch( const Exception& ) { DBG_UNHANDLED_EXCEPTION("forms.richtext"); } if ( !bReallyActAsRichText ) { UnoEditControl::createPeer( _rToolkit, _rParentPeer ); return; } SolarMutexGuard aGuard; if (getPeer().is()) return; mbCreatingPeer = true; // determine the VCL window for the parent vcl::Window* pParentWin = nullptr; if ( _rParentPeer.is() ) { VCLXWindow* pParentXWin = comphelper::getFromUnoTunnel( _rParentPeer ); if ( pParentXWin ) pParentWin = pParentXWin->GetWindow(); DBG_ASSERT( pParentWin, "ORichTextControl::createPeer: could not obtain the VCL-level parent window!" ); } // create the peer Reference< XControlModel > xModel( getModel() ); rtl::Reference pPeer = ORichTextPeer::Create( xModel, pParentWin, getWinBits( xModel ) ); DBG_ASSERT( pPeer, "ORichTextControl::createPeer: invalid peer returned!" ); if ( pPeer ) { // announce the peer to the base class setPeer( pPeer ); // initialize ourself (and thus the peer) with the model properties updateFromModel(); Reference< XView > xPeerView( getPeer(), UNO_QUERY ); if ( xPeerView.is() ) { xPeerView->setZoom( maComponentInfos.nZoomX, maComponentInfos.nZoomY ); xPeerView->setGraphics( mxGraphics ); } // a lot of initial settings from our component infos setPosSize( maComponentInfos.nX, maComponentInfos.nY, maComponentInfos.nWidth, maComponentInfos.nHeight, PosSize::POSSIZE ); pPeer->setVisible ( maComponentInfos.bVisible && !mbDesignMode ); pPeer->setEnable ( maComponentInfos.bEnable ); pPeer->setDesignMode( mbDesignMode ); peerCreated(); } mbCreatingPeer = false; } OUString SAL_CALL ORichTextControl::getImplementationName() { return "com.sun.star.comp.form.ORichTextControl"; } Sequence< OUString > SAL_CALL ORichTextControl::getSupportedServiceNames() { return { "com.sun.star.awt.UnoControl", "com.sun.star.awt.UnoControlEdit", FRM_SUN_CONTROL_RICHTEXTCONTROL }; } Reference< XDispatch > SAL_CALL ORichTextControl::queryDispatch( const css::util::URL& _rURL, const OUString& _rTargetFrameName, sal_Int32 _nSearchFlags ) { Reference< XDispatch > aReturn; Reference< XDispatchProvider > xTypedPeer( getPeer(), UNO_QUERY ); if ( xTypedPeer.is() ) { aReturn = xTypedPeer->queryDispatch( _rURL, _rTargetFrameName, _nSearchFlags ); } return aReturn; } Sequence< Reference< XDispatch > > SAL_CALL ORichTextControl::queryDispatches( const Sequence< DispatchDescriptor >& _rRequests ) { Reference xTypedPeer(getPeer(), UNO_QUERY); if (xTypedPeer.is()) return xTypedPeer->queryDispatches(_rRequests); return Sequence>(); } bool ORichTextControl::requiresNewPeer( const OUString& _rPropertyName ) const { return UnoControl::requiresNewPeer( _rPropertyName ) || _rPropertyName == PROPERTY_RICH_TEXT; } // ORichTextPeer rtl::Reference ORichTextPeer::Create( const Reference< XControlModel >& _rxModel, vcl::Window* _pParentWindow, WinBits _nStyle ) { DBG_TESTSOLARMUTEX(); // the EditEngine of the model RichTextEngine* pEngine = ORichTextModel::getEditEngine( _rxModel ); OSL_ENSURE( pEngine, "ORichTextPeer::Create: could not obtaine the edit engine from the model!" ); if ( !pEngine ) return nullptr; // the peer itself rtl::Reference pPeer(new ORichTextPeer); // the VCL control for the peer VclPtrInstance pRichTextControl( pEngine, _pParentWindow, _nStyle, nullptr, pPeer.get() ); // some knittings pRichTextControl->SetComponentInterface( pPeer ); // outta here return pPeer; } ORichTextPeer::ORichTextPeer() { } ORichTextPeer::~ORichTextPeer() { } void ORichTextPeer::dispose( ) { { SolarMutexGuard aGuard; VclPtr< RichTextControl > pRichTextControl = GetAs< RichTextControl >(); if ( pRichTextControl ) { for (auto const& dispatcher : m_aDispatchers) { pRichTextControl->disableAttributeNotification(dispatcher.first); dispatcher.second->dispose(); } } AttributeDispatchers().swap(m_aDispatchers); } VCLXWindow::dispose(); } void SAL_CALL ORichTextPeer::draw( sal_Int32 _nX, sal_Int32 _nY ) { SolarMutexGuard aGuard; VclPtr< RichTextControl > pControl = GetAs< RichTextControl >(); if ( !pControl ) return; OutputDevice* pTargetDevice = VCLUnoHelper::GetOutputDevice( getGraphics() ); OSL_ENSURE( pTargetDevice != nullptr, "ORichTextPeer::draw: no graphics -> no drawing!" ); if ( !pTargetDevice ) return; const MapUnit eTargetUnit = pTargetDevice->GetMapMode().GetMapUnit(); ::Point aPos( _nX, _nY ); // the XView::draw API talks about pixels, always ... if ( eTargetUnit != MapUnit::MapPixel ) aPos = pTargetDevice->PixelToLogic( aPos ); pControl->Draw( pTargetDevice, aPos, SystemTextColorFlags::NoControls ); } void SAL_CALL ORichTextPeer::setProperty( const OUString& _rPropertyName, const Any& _rValue ) { SolarMutexGuard g; if ( !GetWindow() ) { VCLXWindow::setProperty( _rPropertyName, _rValue ); return; } if ( _rPropertyName == PROPERTY_BACKGROUNDCOLOR ) { VclPtr< RichTextControl > pControl = GetAs< RichTextControl >(); if ( !_rValue.hasValue() ) { pControl->SetBackgroundColor( ); } else { Color nColor = COL_TRANSPARENT; _rValue >>= nColor; pControl->SetBackgroundColor( nColor ); } } else if ( _rPropertyName == PROPERTY_HSCROLL ) { adjustTwoStateWinBit( GetWindow(), _rValue, WB_HSCROLL ); } else if ( _rPropertyName == PROPERTY_VSCROLL ) { adjustTwoStateWinBit( GetWindow(), _rValue, WB_VSCROLL ); } else if ( _rPropertyName == PROPERTY_HARDLINEBREAKS ) { adjustTwoStateWinBit( GetWindow(), _rValue, WB_WORDBREAK, true ); } else if ( _rPropertyName == PROPERTY_READONLY ) { VclPtr< RichTextControl > pControl = GetAs< RichTextControl >(); bool bReadOnly( pControl->IsReadOnly() ); OSL_VERIFY( _rValue >>= bReadOnly ); pControl->SetReadOnly( bReadOnly ); // update the dispatchers for (auto const& dispatcher : m_aDispatchers) { dispatcher.second->invalidate(); } } else if ( _rPropertyName == PROPERTY_HIDEINACTIVESELECTION ) { VclPtr< RichTextControl > pRichTextControl = GetAs< RichTextControl >(); bool bHide = pRichTextControl->GetHideInactiveSelection(); OSL_VERIFY( _rValue >>= bHide ); pRichTextControl->SetHideInactiveSelection( bHide ); } else VCLXWindow::setProperty( _rPropertyName, _rValue ); } IMPLEMENT_FORWARD_XINTERFACE2( ORichTextPeer, VCLXWindow, ORichTextPeer_Base ) IMPLEMENT_FORWARD_XTYPEPROVIDER2( ORichTextPeer, VCLXWindow, ORichTextPeer_Base ) namespace { SfxSlotId lcl_translateConflictingSlot( SfxSlotId _nIDFromPool ) { // HACK HACK HACK // unfortunately, some of our applications have some conflicting slots, // i.e. slots which have the same UNO name as an existing other (common) // slot. // For instance, both the slots SID_SET_SUPER_SCRIPT (from SVX) and FN_SET_SUPER_SCRIPT // (from SW) have the UNO name "SuperScript". // Now, if the controls lives in a text document, and asks the SfxSlotPool for // the id belonging to "SuperScript", it gets the FN_SET_SUPER_SCRIPT - which // is completely unknown to the EditEngine. // So, we need to translate such conflicting ids. // Note that the real solution would be to fix the applications to // *not* define conflicting slots. Alternatively, if SFX would provide a slot pool // which is *static* (i.e. independent on the active application), then we // would also never encounter such a conflict. SfxSlotId nReturn( _nIDFromPool ); switch ( _nIDFromPool ) { case 20411: /* FM_SET_SUPER_SCRIPT, originating in SW */ nReturn = SID_SET_SUPER_SCRIPT; break; case 20412: /* FN_SET_SUB_SCRIPT, originating in SW */ nReturn = SID_SET_SUB_SCRIPT; break; } return nReturn; } } ORichTextPeer::SingleAttributeDispatcher ORichTextPeer::implCreateDispatcher( SfxSlotId _nSlotId, const css::util::URL& _rURL ) { VclPtr< RichTextControl > pRichTextControl = GetAs< RichTextControl >(); OSL_PRECOND( pRichTextControl, "ORichTextPeer::implCreateDispatcher: invalid window!" ); if ( !pRichTextControl ) return SingleAttributeDispatcher( nullptr ); rtl::Reference pDispatcher; rtl::Reference pAttributeDispatcher; switch ( _nSlotId ) { case SID_CUT: pDispatcher = new OClipboardDispatcher( pRichTextControl->getView(), OClipboardDispatcher::eCut ); break; case SID_COPY: pDispatcher = new OClipboardDispatcher( pRichTextControl->getView(), OClipboardDispatcher::eCopy ); break; case SID_PASTE: pDispatcher = new OPasteClipboardDispatcher( pRichTextControl->getView() ); break; case SID_SELECTALL: pDispatcher = new OSelectAllDispatcher( pRichTextControl->getView(), _rURL ); break; case SID_ATTR_PARA_LEFT_TO_RIGHT: case SID_ATTR_PARA_RIGHT_TO_LEFT: pAttributeDispatcher = new OParagraphDirectionDispatcher( pRichTextControl->getView(), _nSlotId, _rURL, pRichTextControl ); break; case SID_TEXTDIRECTION_TOP_TO_BOTTOM: case SID_TEXTDIRECTION_LEFT_TO_RIGHT: pDispatcher = new OTextDirectionDispatcher( pRichTextControl->getView(), _rURL ); break; case SID_ATTR_PARA_HANGPUNCTUATION: case SID_ATTR_PARA_FORBIDDEN_RULES: case SID_ATTR_PARA_SCRIPTSPACE: pAttributeDispatcher = new OAsianFontLayoutDispatcher( pRichTextControl->getView(), _nSlotId, _rURL, pRichTextControl ); break; default: { const SfxItemPool& rPool = *pRichTextControl->getView().GetEmptyItemSet().GetPool(); bool bSupportedSlot = rPool.IsInRange( rPool.GetWhich( _nSlotId ) ); if ( !bSupportedSlot ) bSupportedSlot = RichTextControl::isMappableSlot( _nSlotId ); if ( bSupportedSlot ) { // it's really a slot which is supported by the EditEngine bool bNeedParametrizedDispatcher = true; if ( ( _nSlotId == SID_ATTR_CHAR_POSTURE ) || ( _nSlotId == SID_ATTR_CHAR_CJK_POSTURE ) || ( _nSlotId == SID_ATTR_CHAR_CTL_POSTURE ) || ( _nSlotId == SID_ATTR_CHAR_LATIN_POSTURE ) || ( _nSlotId == SID_ATTR_CHAR_WEIGHT ) || ( _nSlotId == SID_ATTR_CHAR_CJK_WEIGHT ) || ( _nSlotId == SID_ATTR_CHAR_CTL_WEIGHT ) || ( _nSlotId == SID_ATTR_CHAR_LATIN_WEIGHT ) || ( _nSlotId == SID_ATTR_CHAR_LANGUAGE ) || ( _nSlotId == SID_ATTR_CHAR_CJK_LANGUAGE ) || ( _nSlotId == SID_ATTR_CHAR_CTL_LANGUAGE ) || ( _nSlotId == SID_ATTR_CHAR_LATIN_LANGUAGE ) || ( _nSlotId == SID_ATTR_CHAR_CONTOUR ) || ( _nSlotId == SID_ATTR_CHAR_SHADOWED ) || ( _nSlotId == SID_ATTR_CHAR_WORDLINEMODE ) || ( _nSlotId == SID_ATTR_CHAR_COLOR ) || ( _nSlotId == SID_ATTR_CHAR_RELIEF ) || ( _nSlotId == SID_ATTR_CHAR_KERNING ) || ( _nSlotId == SID_ATTR_CHAR_AUTOKERN ) || ( _nSlotId == SID_ATTR_CHAR_SCALEWIDTH ) ) { bNeedParametrizedDispatcher = true; } else { SfxSlotPool& rSlotPool = SfxSlotPool::GetSlotPool(); const SfxSlot* pSlot = rSlotPool.GetSlot( _nSlotId ); const SfxType* pType = pSlot ? pSlot->GetType() : nullptr; if ( pType ) { bNeedParametrizedDispatcher = ( pType->nAttribs > 0 ); } } if ( bNeedParametrizedDispatcher ) { pAttributeDispatcher = new OParametrizedAttributeDispatcher( pRichTextControl->getView(), _nSlotId, _rURL, pRichTextControl ); } else { pAttributeDispatcher = new OAttributeDispatcher( pRichTextControl->getView(), _nSlotId, _rURL, pRichTextControl ); } } else { SAL_WARN("forms.richtext", "ORichTextPeer::implCreateDispatcher: not creating dispatcher (unsupported slot) for " << _rURL.Complete); } } break; } SingleAttributeDispatcher xDispatcher( pDispatcher ); if ( pAttributeDispatcher ) { xDispatcher = SingleAttributeDispatcher( pAttributeDispatcher ); pRichTextControl->enableAttributeNotification( _nSlotId, pAttributeDispatcher.get() ); } return xDispatcher; } namespace { SfxSlotId lcl_getSlotFromUnoName( SfxSlotPool const & _rSlotPool, const OUString& _rUnoSlotName ) { const SfxSlot* pSlot = _rSlotPool.GetUnoSlot( _rUnoSlotName ); if ( pSlot ) { // okay, there's a slot with the given UNO name return lcl_translateConflictingSlot( pSlot->GetSlotId() ); } // some hard-coded slots, which do not have a UNO name at SFX level, but which // we nevertheless need to transport via UNO mechanisms, so we need a name if ( _rUnoSlotName == "AllowHangingPunctuation" ) return SID_ATTR_PARA_HANGPUNCTUATION; if ( _rUnoSlotName == "ApplyForbiddenCharacterRules" ) return SID_ATTR_PARA_FORBIDDEN_RULES; if ( _rUnoSlotName == "UseScriptSpacing" ) return SID_ATTR_PARA_SCRIPTSPACE; OSL_ENSURE( pSlot, "lcl_getSlotFromUnoName: unknown UNO slot name!" ); return 0; } } Reference< XDispatch > SAL_CALL ORichTextPeer::queryDispatch( const css::util::URL& _rURL, const OUString& /*_rTargetFrameName*/, sal_Int32 /*_nSearchFlags*/ ) { Reference< XDispatch > xReturn; if ( !GetWindow() ) { OSL_FAIL( "ORichTextPeer::queryDispatch: already disposed?" ); return xReturn; } // is it a UNO slot? static constexpr std::u16string_view sUnoProtocolPrefix( u".uno:" ); if ( _rURL.Complete.startsWith( sUnoProtocolPrefix ) ) { OUString sUnoSlotName = _rURL.Complete.copy( sUnoProtocolPrefix.size() ); SfxSlotId nSlotId = lcl_getSlotFromUnoName( SfxSlotPool::GetSlotPool(), sUnoSlotName ); if ( nSlotId > 0 ) { // do we already have a dispatcher for this? AttributeDispatchers::const_iterator aDispatcherPos = m_aDispatchers.find( nSlotId ); if ( aDispatcherPos == m_aDispatchers.end() ) { SingleAttributeDispatcher pDispatcher = implCreateDispatcher( nSlotId, _rURL ); if ( pDispatcher.is() ) { aDispatcherPos = m_aDispatchers.emplace( nSlotId, pDispatcher ).first; } } if ( aDispatcherPos != m_aDispatchers.end() ) xReturn = aDispatcherPos->second.get(); } } return xReturn; } Sequence< Reference< XDispatch > > SAL_CALL ORichTextPeer::queryDispatches( const Sequence< DispatchDescriptor >& _rRequests ) { Sequence< Reference< XDispatch > > aReturn( _rRequests.getLength() ); Reference< XDispatch >* pReturn = aReturn.getArray(); const DispatchDescriptor* pRequest = _rRequests.getConstArray(); const DispatchDescriptor* pRequestEnd = pRequest + _rRequests.getLength(); for ( ; pRequest != pRequestEnd; ++pRequest, ++pReturn ) { *pReturn = queryDispatch( pRequest->FeatureURL, pRequest->FrameName, pRequest->SearchFlags ); } return aReturn; } void ORichTextPeer::onSelectionChanged() { AttributeDispatchers::iterator aDispatcherPos = m_aDispatchers.find( SID_COPY ); if ( aDispatcherPos != m_aDispatchers.end() ) aDispatcherPos->second->invalidate(); aDispatcherPos = m_aDispatchers.find( SID_CUT ); if ( aDispatcherPos != m_aDispatchers.end() ) aDispatcherPos->second->invalidate(); } } // namespace frm extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* com_sun_star_comp_form_ORichTextControl_get_implementation(css::uno::XComponentContext*, css::uno::Sequence const &) { return cppu::acquire(new frm::ORichTextControl()); } /* vim:set shiftwidth=4 softtabstop=4 expandtab: */