sfx2/source/appl/helpinterceptor.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
  21 #include "helpinterceptor.hxx"
  22 #include "helpdispatch.hxx"
  23 #include "newhelp.hxx"
  24 #include <tools/urlobj.hxx>
  25 #include <tools/debug.hxx>
  26 #include <limits.h>
  27
  28 using namespace ::com::sun::star::beans;
  29 using namespace ::com::sun::star::frame;
  30 using namespace ::com::sun::star::uno;
  31 using namespace ::com::sun::star::util;
  32 using namespace ::com::sun::star::lang;
  33
  34 HelpInterceptor_Impl::HelpInterceptor_Impl() :
  35
  36     m_pWindow  ( nullptr ),
  37     m_nCurPos   ( 0 )
  38
  39 {
  40 }
  41
  42
  43 HelpInterceptor_Impl::~HelpInterceptor_Impl()
  44 {
  45 }
  46
  47
  48 void HelpInterceptor_Impl::addURL( const OUString& rURL )
  49 {
  50     size_t nCount = m_vHistoryUrls.size();
  51     if ( nCount && m_nCurPos < ( nCount - 1 ) )
  52     {
  53         m_vHistoryUrls.erase(
  54             m_vHistoryUrls.begin() + m_nCurPos + 1,
  55             m_vHistoryUrls.end());
  56     }
  57     Reference<XFrame> xFrame(m_xIntercepted, UNO_QUERY);
  58     Reference<XController> xController;
  59     if(xFrame.is())
  60         xController = xFrame->getController();
  61
  62     m_aCurrentURL = rURL;
  63     m_vHistoryUrls.emplace_back( rURL );
  64     m_nCurPos = m_vHistoryUrls.size() - 1;
  65 // TODO ?
  66     if ( m_xListener.is() )
  67     {
  68         css::frame::FeatureStateEvent aEvent;
  69         URL aURL;
  70         aURL.Complete = rURL;
  71         aEvent.FeatureURL = aURL;
  72         aEvent.Source = static_cast<css::frame::XDispatch*>(this);
  73         m_xListener->statusChanged( aEvent );
  74     }
  75
  76     m_pWindow->UpdateToolbox();
  77 }
  78
  79
  80 void HelpInterceptor_Impl::setInterception( const Reference< XFrame >& xFrame )
  81 {
  82     m_xIntercepted.set( xFrame, UNO_QUERY );
  83
  84     if ( m_xIntercepted.is() )
  85         m_xIntercepted->registerDispatchProviderInterceptor( static_cast<XDispatchProviderInterceptor*>(this) );
  86 }
  87
  88
  89 bool HelpInterceptor_Impl::HasHistoryPred() const
  90 {
  91     return m_nCurPos > 0;
  92 }
  93
  94 bool HelpInterceptor_Impl::HasHistorySucc() const
  95 {
  96     return m_nCurPos < ( m_vHistoryUrls.size() - 1 );
  97 }
  98
  99
 100 // XDispatchProvider
 101
 102 Reference< XDispatch > SAL_CALL HelpInterceptor_Impl::queryDispatch(
 103
 104     const URL& aURL, const OUString& aTargetFrameName, sal_Int32 nSearchFlags )
 105
 106 {
 107     Reference< XDispatch > xResult;
 108     if ( m_xSlaveDispatcher.is() )
 109         xResult = m_xSlaveDispatcher->queryDispatch( aURL, aTargetFrameName, nSearchFlags );
 110
 111     bool bHelpURL = aURL.Complete.toAsciiLowerCase().match("vnd.sun.star.help",0);
 112
 113     if ( bHelpURL )
 114     {
 115         DBG_ASSERT( xResult.is(), "invalid dispatch" );
 116         HelpDispatch_Impl* pHelpDispatch = new HelpDispatch_Impl( *this, xResult );
 117         xResult.set( static_cast< ::cppu::OWeakObject* >(pHelpDispatch), UNO_QUERY );
 118     }
 119
 120     return xResult;
 121 }
 122
 123
 124 Sequence < Reference < XDispatch > > SAL_CALL HelpInterceptor_Impl::queryDispatches(
 125
 126     const Sequence< DispatchDescriptor >& aDescripts )
 127
 128 {
 129     Sequence< Reference< XDispatch > > aReturn( aDescripts.getLength() );
 130     std::transform(aDescripts.begin(), aDescripts.end(), aReturn.begin(),
 131         [this](const DispatchDescriptor& rDescr) -> Reference<XDispatch> {
 132             return queryDispatch(rDescr.FeatureURL, rDescr.FrameName, rDescr.SearchFlags); });
 133     return aReturn;
 134 }
 135
 136
 137 // XDispatchProviderInterceptor
 138
 139 Reference< XDispatchProvider > SAL_CALL HelpInterceptor_Impl::getSlaveDispatchProvider()
 140
 141 {
 142     return m_xSlaveDispatcher;
 143 }
 144
 145
 146 void SAL_CALL HelpInterceptor_Impl::setSlaveDispatchProvider( const Reference< XDispatchProvider >& xNewSlave )
 147
 148 {
 149     m_xSlaveDispatcher = xNewSlave;
 150 }
 151
 152
 153 Reference< XDispatchProvider > SAL_CALL HelpInterceptor_Impl::getMasterDispatchProvider()
 154
 155 {
 156     return m_xMasterDispatcher;
 157 }
 158
 159
 160 void SAL_CALL HelpInterceptor_Impl::setMasterDispatchProvider( const Reference< XDispatchProvider >& xNewMaster )
 161
 162 {
 163     m_xMasterDispatcher = xNewMaster;
 164 }
 165
 166
 167 // XInterceptorInfo
 168
 169 Sequence< OUString > SAL_CALL HelpInterceptor_Impl::getInterceptedURLs()
 170
 171 {
 172     Sequence<OUString> aURLList { "vnd.sun.star.help://*" };
 173     return aURLList;
 174 }
 175
 176
 177 // XDispatch
 178
 179 void SAL_CALL HelpInterceptor_Impl::dispatch(
 180     const URL& aURL, const Sequence< css::beans::PropertyValue >& )
 181 {
 182     bool bBack = aURL.Complete == ".uno:Backward";
 183     if ( !bBack && aURL.Complete != ".uno:Forward" )
 184         return;
 185
 186     if ( m_vHistoryUrls.empty() )
 187         return;
 188
 189     size_t nPos = ( bBack && m_nCurPos > 0 ) ? --m_nCurPos
 190                                             : ( !bBack && m_nCurPos < m_vHistoryUrls.size() - 1 )
 191                                             ? ++m_nCurPos
 192                                             : std::numeric_limits<std::size_t>::max();
 193
 194     if ( nPos < std::numeric_limits<std::size_t>::max() )
 195     {
 196         m_pWindow->loadHelpContent(m_vHistoryUrls[nPos], false); // false => don't add item to history again!
 197     }
 198
 199     m_pWindow->UpdateToolbox();
 200 }
 201
 202
 203 void SAL_CALL HelpInterceptor_Impl::addStatusListener(
 204     const Reference< XStatusListener >& xControl, const URL& )
 205 {
 206     DBG_ASSERT( !m_xListener.is(), "listener already exists" );
 207     m_xListener = xControl;
 208 }
 209
 210
 211 void SAL_CALL HelpInterceptor_Impl::removeStatusListener(
 212     const Reference< XStatusListener >&, const URL&)
 213 {
 214     m_xListener = nullptr;
 215 }
 216
 217 // HelpListener_Impl -----------------------------------------------------
 218
 219 HelpListener_Impl::HelpListener_Impl( HelpInterceptor_Impl* pInter )
 220 {
 221     pInterceptor = pInter;
 222     pInterceptor->addStatusListener( this, css::util::URL() );
 223 }
 224
 225
 226 void SAL_CALL HelpListener_Impl::statusChanged( const css::frame::FeatureStateEvent& Event )
 227 {
 228     INetURLObject aObj( Event.FeatureURL.Complete );
 229     aFactory = aObj.GetHost();
 230     aChangeLink.Call( *this );
 231 }
 232
 233
 234 void SAL_CALL HelpListener_Impl::disposing( const css::lang::EventObject& )
 235 {
 236     pInterceptor->removeStatusListener( this, css::util::URL() );
 237     pInterceptor = nullptr;
 238 }
 239
 240 HelpStatusListener_Impl::HelpStatusListener_Impl(
 241         Reference < XDispatch > const & aDispatch, URL const & rURL)
 242 {
 243     aDispatch->addStatusListener(this, rURL);
 244 }
 245
 246 HelpStatusListener_Impl::~HelpStatusListener_Impl()
 247 {
 248     if(xDispatch.is())
 249         xDispatch->removeStatusListener(this, css::util::URL());
 250 }
 251
 252 void HelpStatusListener_Impl::statusChanged(
 253     const FeatureStateEvent& rEvent )
 254 {
 255     aStateEvent = rEvent;
 256 }
 257
 258 void HelpStatusListener_Impl::disposing( const EventObject& )
 259 {
 260     xDispatch->removeStatusListener(this, css::util::URL());
 261     xDispatch = nullptr;
 262 }
 263
 264 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */