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