sfx2/source/appl/helpinterceptor.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29
  30 #include "helpinterceptor.hxx"
  31 #include "helpdispatch.hxx"
  32 #include "newhelp.hxx"
  33 #include <sfx2/sfxuno.hxx>
  34 #include <tools/urlobj.hxx>
  35 #include <tools/debug.hxx>
  36 #include <com/sun/star/beans/PropertyValue.hpp>
  37 #include <com/sun/star/frame/XNotifyingDispatch.hpp>
  38 #include <cppuhelper/interfacecontainer.h>
  39 #include <vcl/window.hxx>
  40 #include <limits.h>
  41
  42 using namespace ::com::sun::star::beans;
  43 using namespace ::com::sun::star::frame;
  44 using namespace ::com::sun::star::uno;
  45 using namespace ::com::sun::star::util;
  46 using namespace ::com::sun::star::lang;
  47
  48 extern void AppendConfigToken_Impl( String& rURL, sal_Bool bQuestionMark ); // sfxhelp.cxx
  49
  50 // class HelpInterceptor_Impl --------------------------------------------
  51
  52 HelpInterceptor_Impl::HelpInterceptor_Impl() :
  53
  54     m_pHistory  ( NULL ),
  55     m_nCurPos   ( 0 )
  56
  57 {
  58 }
  59
  60 // -----------------------------------------------------------------------
  61
  62 HelpInterceptor_Impl::~HelpInterceptor_Impl()
  63 {
  64     if ( m_pHistory )
  65     {
  66         for ( size_t i = 0, n = m_pHistory->size(); i < n; ++i )
  67             delete m_pHistory->at( i );
  68         delete m_pHistory;
  69     }
  70 }
  71
  72 // -----------------------------------------------------------------------
  73
  74 void HelpInterceptor_Impl::addURL( const String& rURL )
  75 {
  76   if ( !m_pHistory )
  77         m_pHistory = new HelpHistoryList_Impl;
  78
  79     size_t nCount = m_pHistory->size();
  80     if ( nCount && m_nCurPos < ( nCount - 1 ) )
  81     {
  82         for ( size_t i = nCount - 1; i > m_nCurPos; i-- )
  83         {
  84             delete m_pHistory->at( i );
  85             HelpHistoryList_Impl::iterator it = m_pHistory->begin();
  86             ::std::advance( it, i );
  87             m_pHistory->erase( it );
  88         }
  89     }
  90     Reference<XFrame> xFrame(m_xIntercepted, UNO_QUERY);
  91     Reference<XController> xController;
  92     if(xFrame.is())
  93         xController = xFrame->getController();
  94     Any aViewData;
  95     if(xController.is() && !m_pHistory->empty())
  96     {
  97         m_pHistory->at( m_nCurPos )->aViewData = xController->getViewData();
  98     }
  99
 100     m_aCurrentURL = rURL;
 101     Any aEmptyViewData;
 102     m_pHistory->push_back( new HelpHistoryEntry_Impl( rURL, aEmptyViewData ) );
 103     m_nCurPos = m_pHistory->size() - 1;
 104 // TODO ?
 105     if ( m_xListener.is() )
 106     {
 107         ::com::sun::star::frame::FeatureStateEvent aEvent;
 108         URL aURL;
 109         aURL.Complete = rURL;
 110         aEvent.FeatureURL = aURL;
 111         aEvent.Source = (::com::sun::star::frame::XDispatch*)this;
 112         m_xListener->statusChanged( aEvent );
 113     }
 114
 115     m_pWindow->UpdateToolbox();
 116 }
 117
 118 // -----------------------------------------------------------------------
 119
 120 void HelpInterceptor_Impl::setInterception( Reference< XFrame > xFrame )
 121 {
 122     m_xIntercepted = Reference< XDispatchProviderInterception>( xFrame, UNO_QUERY );
 123
 124     if ( m_xIntercepted.is() )
 125         m_xIntercepted->registerDispatchProviderInterceptor( (XDispatchProviderInterceptor*)this );
 126 }
 127
 128 // -----------------------------------------------------------------------
 129
 130 sal_Bool HelpInterceptor_Impl::HasHistoryPred() const
 131 {
 132     return m_pHistory && ( m_nCurPos > 0 );
 133 }
 134
 135 sal_Bool HelpInterceptor_Impl::HasHistorySucc() const
 136 {
 137     return m_pHistory && ( m_nCurPos < ( m_pHistory->size() - 1 ) );
 138 }
 139
 140
 141 // -----------------------------------------------------------------------
 142 // XDispatchProvider
 143
 144 Reference< XDispatch > SAL_CALL HelpInterceptor_Impl::queryDispatch(
 145
 146     const URL& aURL, const ::rtl::OUString& aTargetFrameName, sal_Int32 nSearchFlags )
 147
 148     throw( RuntimeException )
 149
 150 {
 151     Reference< XDispatch > xResult;
 152     if ( m_xSlaveDispatcher.is() )
 153         xResult = m_xSlaveDispatcher->queryDispatch( aURL, aTargetFrameName, nSearchFlags );
 154
 155     sal_Bool bHelpURL = aURL.Complete.toAsciiLowerCase().match("vnd.sun.star.help",0);
 156
 157     if ( bHelpURL )
 158     {
 159         DBG_ASSERT( xResult.is(), "invalid dispatch" );
 160         HelpDispatch_Impl* pHelpDispatch = new HelpDispatch_Impl( *this, xResult );
 161         xResult = Reference< XDispatch >( static_cast< ::cppu::OWeakObject* >(pHelpDispatch), UNO_QUERY );
 162     }
 163
 164     return xResult;
 165 }
 166
 167 // -----------------------------------------------------------------------
 168
 169 Sequence < Reference < XDispatch > > SAL_CALL HelpInterceptor_Impl::queryDispatches(
 170
 171     const Sequence< DispatchDescriptor >& aDescripts )
 172
 173     throw( RuntimeException )
 174
 175 {
 176     Sequence< Reference< XDispatch > > aReturn( aDescripts.getLength() );
 177     Reference< XDispatch >* pReturn = aReturn.getArray();
 178     const DispatchDescriptor* pDescripts = aDescripts.getConstArray();
 179     for ( sal_Int16 i = 0; i < aDescripts.getLength(); ++i, ++pReturn, ++pDescripts )
 180     {
 181         *pReturn = queryDispatch( pDescripts->FeatureURL, pDescripts->FrameName, pDescripts->SearchFlags );
 182     }
 183     return aReturn;
 184 }
 185
 186 // -----------------------------------------------------------------------
 187 // XDispatchProviderInterceptor
 188
 189 Reference< XDispatchProvider > SAL_CALL HelpInterceptor_Impl::getSlaveDispatchProvider()
 190
 191     throw( RuntimeException )
 192
 193 {
 194     return m_xSlaveDispatcher;
 195 }
 196
 197 // -----------------------------------------------------------------------
 198
 199 void SAL_CALL HelpInterceptor_Impl::setSlaveDispatchProvider( const Reference< XDispatchProvider >& xNewSlave )
 200
 201     throw( RuntimeException )
 202
 203 {
 204     m_xSlaveDispatcher = xNewSlave;
 205 }
 206
 207 // -----------------------------------------------------------------------
 208
 209 Reference< XDispatchProvider > SAL_CALL HelpInterceptor_Impl::getMasterDispatchProvider()
 210
 211     throw( RuntimeException )
 212
 213 {
 214     return m_xMasterDispatcher;
 215 }
 216
 217 // -----------------------------------------------------------------------
 218
 219 void SAL_CALL HelpInterceptor_Impl::setMasterDispatchProvider( const Reference< XDispatchProvider >& xNewMaster )
 220
 221     throw( RuntimeException )
 222
 223 {
 224     m_xMasterDispatcher = xNewMaster;
 225 }
 226
 227 // -----------------------------------------------------------------------
 228 // XInterceptorInfo
 229
 230 Sequence< ::rtl::OUString > SAL_CALL HelpInterceptor_Impl::getInterceptedURLs()
 231
 232     throw( RuntimeException )
 233
 234 {
 235     Sequence< ::rtl::OUString > aURLList( 1 );
 236     aURLList[0] = DEFINE_CONST_UNICODE("vnd.sun.star.help://*");
 237     return aURLList;
 238 }
 239
 240 // -----------------------------------------------------------------------
 241 // XDispatch
 242
 243 void SAL_CALL HelpInterceptor_Impl::dispatch(
 244     const URL& aURL, const Sequence< ::com::sun::star::beans::PropertyValue >& ) throw( RuntimeException )
 245 {
 246     sal_Bool bBack = ( String( DEFINE_CONST_UNICODE(".uno:Backward") ) == String( aURL.Complete ) );
 247     if ( bBack || String( DEFINE_CONST_UNICODE(".uno:Forward") ) == String( aURL.Complete ) )
 248     {
 249         if ( m_pHistory )
 250         {
 251             if(m_pHistory->size() > m_nCurPos)
 252             {
 253                 Reference<XFrame> xFrame(m_xIntercepted, UNO_QUERY);
 254                 Reference<XController> xController;
 255                 if(xFrame.is())
 256                     xController = xFrame->getController();
 257                 if(xController.is())
 258                 {
 259                     m_pHistory->at( m_nCurPos )->aViewData = xController->getViewData();
 260                 }
 261             }
 262
 263             sal_uIntPtr nPos = ( bBack && m_nCurPos > 0 ) ? --m_nCurPos
 264                                                     : ( !bBack && m_nCurPos < m_pHistory->size() - 1 )
 265                                                     ? ++m_nCurPos
 266                                                     : ULONG_MAX;
 267
 268             if ( nPos < ULONG_MAX )
 269             {
 270                 HelpHistoryEntry_Impl* pEntry = m_pHistory->at( nPos );
 271                 if ( pEntry )
 272                     m_pWindow->loadHelpContent(pEntry->aURL, sal_False); // false => dont add item to history again!
 273             }
 274
 275             m_pWindow->UpdateToolbox();
 276         }
 277     }
 278 }
 279
 280 // -----------------------------------------------------------------------
 281
 282 void SAL_CALL HelpInterceptor_Impl::addStatusListener(
 283     const Reference< XStatusListener >& xControl, const URL& ) throw( RuntimeException )
 284 {
 285     DBG_ASSERT( !m_xListener.is(), "listener already exists" );
 286     m_xListener = xControl;
 287 }
 288
 289 // -----------------------------------------------------------------------
 290
 291 void SAL_CALL HelpInterceptor_Impl::removeStatusListener(
 292     const Reference< XStatusListener >&, const URL&) throw( RuntimeException )
 293 {
 294     m_xListener = 0;
 295 }
 296
 297 // HelpListener_Impl -----------------------------------------------------
 298
 299 HelpListener_Impl::HelpListener_Impl( HelpInterceptor_Impl* pInter )
 300 {
 301     pInterceptor = pInter;
 302     pInterceptor->addStatusListener( this, ::com::sun::star::util::URL() );
 303 }
 304
 305 // -----------------------------------------------------------------------
 306
 307 void SAL_CALL HelpListener_Impl::statusChanged( const ::com::sun::star::frame::FeatureStateEvent& Event )
 308
 309     throw( ::com::sun::star::uno::RuntimeException )
 310
 311 {
 312     INetURLObject aObj( Event.FeatureURL.Complete );
 313     aFactory = aObj.GetHost();
 314     aChangeLink.Call( this );
 315 }
 316
 317 // -----------------------------------------------------------------------
 318
 319 void SAL_CALL HelpListener_Impl::disposing( const ::com::sun::star::lang::EventObject& )
 320
 321     throw( ::com::sun::star::uno::RuntimeException )
 322
 323 {
 324     pInterceptor->removeStatusListener( this, ::com::sun::star::util::URL() );
 325     pInterceptor = NULL;
 326 }
 327
 328 HelpStatusListener_Impl::HelpStatusListener_Impl(
 329         Reference < XDispatch > aDispatch, URL& rURL)
 330 {
 331     aDispatch->addStatusListener(this, rURL);
 332 }
 333
 334 HelpStatusListener_Impl::~HelpStatusListener_Impl()
 335 {
 336     if(xDispatch.is())
 337         xDispatch->removeStatusListener(this, com::sun::star::util::URL());
 338 }
 339
 340 void HelpStatusListener_Impl::statusChanged(
 341     const FeatureStateEvent& rEvent ) throw( RuntimeException )
 342 {
 343     aStateEvent = rEvent;
 344 }
 345
 346 void HelpStatusListener_Impl::disposing( const EventObject& ) throw( RuntimeException )
 347 {
 348     xDispatch->removeStatusListener(this, com::sun::star::util::URL());
 349     xDispatch = 0;
 350 }
 351
 352 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */