xref: /aoo42x/main/sfx2/source/appl/helpdispatch.cxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove
29*cdf0e10cSrcweir #include "precompiled_sfx2.hxx"
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "helpdispatch.hxx"
32*cdf0e10cSrcweir #include <sfx2/sfxuno.hxx>
33*cdf0e10cSrcweir #include "newhelp.hxx"
34*cdf0e10cSrcweir #include <tools/debug.hxx>
35*cdf0e10cSrcweir #include <tools/urlobj.hxx>
36*cdf0e10cSrcweir #include <com/sun/star/frame/XNotifyingDispatch.hpp>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir using namespace ::com::sun::star::beans;
39*cdf0e10cSrcweir using namespace ::com::sun::star::frame;
40*cdf0e10cSrcweir using namespace ::com::sun::star::uno;
41*cdf0e10cSrcweir using namespace ::com::sun::star::util;
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir // class HelpInterceptor_Impl --------------------------------------------
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir HelpDispatch_Impl::HelpDispatch_Impl( HelpInterceptor_Impl& _rInterceptor,
46*cdf0e10cSrcweir 									  const ::com::sun::star::uno::Reference<
47*cdf0e10cSrcweir 									  	::com::sun::star::frame::XDispatch >& _xDisp ) :
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir 	m_rInterceptor	( _rInterceptor ),
50*cdf0e10cSrcweir 	m_xRealDispatch	( _xDisp )
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir {
53*cdf0e10cSrcweir }
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir // -----------------------------------------------------------------------
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir HelpDispatch_Impl::~HelpDispatch_Impl()
58*cdf0e10cSrcweir {
59*cdf0e10cSrcweir }
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir // -----------------------------------------------------------------------
62*cdf0e10cSrcweir // XDispatch
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir void SAL_CALL HelpDispatch_Impl::dispatch(
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir 	const URL& aURL, const Sequence< PropertyValue >& aArgs ) throw( RuntimeException )
67*cdf0e10cSrcweir 
68*cdf0e10cSrcweir {
69*cdf0e10cSrcweir 	DBG_ASSERT( m_xRealDispatch.is(), "invalid dispatch" );
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir 	// search for a keyword (dispatch from the basic ide)
72*cdf0e10cSrcweir 	sal_Bool bHasKeyword = sal_False;
73*cdf0e10cSrcweir 	String sKeyword;
74*cdf0e10cSrcweir 	const PropertyValue* pBegin = aArgs.getConstArray();
75*cdf0e10cSrcweir 	const PropertyValue* pEnd	= pBegin + aArgs.getLength();
76*cdf0e10cSrcweir 	for ( ; pBegin != pEnd; ++pBegin )
77*cdf0e10cSrcweir 	{
78*cdf0e10cSrcweir 		if ( 0 == ( *pBegin ).Name.compareToAscii( "HelpKeyword" ) )
79*cdf0e10cSrcweir 		{
80*cdf0e10cSrcweir 			rtl::OUString sHelpKeyword;
81*cdf0e10cSrcweir 			if ( ( ( *pBegin ).Value >>= sHelpKeyword ) && sHelpKeyword.getLength() > 0 )
82*cdf0e10cSrcweir 			{
83*cdf0e10cSrcweir 				sKeyword = String( sHelpKeyword );
84*cdf0e10cSrcweir 				bHasKeyword = ( sKeyword.Len() > 0 );
85*cdf0e10cSrcweir 				break;
86*cdf0e10cSrcweir 			}
87*cdf0e10cSrcweir 		}
88*cdf0e10cSrcweir 	}
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir 	// if a keyword was found, then open it
91*cdf0e10cSrcweir 	SfxHelpWindow_Impl* pHelpWin = m_rInterceptor.GetHelpWindow();
92*cdf0e10cSrcweir 	DBG_ASSERT( pHelpWin, "invalid HelpWindow" );
93*cdf0e10cSrcweir 	if ( bHasKeyword )
94*cdf0e10cSrcweir     {
95*cdf0e10cSrcweir 		pHelpWin->OpenKeyword( sKeyword );
96*cdf0e10cSrcweir         return;
97*cdf0e10cSrcweir     }
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir     pHelpWin->loadHelpContent(aURL.Complete);
100*cdf0e10cSrcweir }
101*cdf0e10cSrcweir 
102*cdf0e10cSrcweir // -----------------------------------------------------------------------
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir void SAL_CALL HelpDispatch_Impl::addStatusListener(
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir 	const Reference< XStatusListener >& xControl, const URL& aURL ) throw( RuntimeException )
107*cdf0e10cSrcweir 
108*cdf0e10cSrcweir {
109*cdf0e10cSrcweir 	DBG_ASSERT( m_xRealDispatch.is(), "invalid dispatch" );
110*cdf0e10cSrcweir 	m_xRealDispatch->addStatusListener( xControl, aURL );
111*cdf0e10cSrcweir }
112*cdf0e10cSrcweir 
113*cdf0e10cSrcweir // -----------------------------------------------------------------------
114*cdf0e10cSrcweir 
115*cdf0e10cSrcweir void SAL_CALL HelpDispatch_Impl::removeStatusListener(
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir 	const Reference< XStatusListener >& xControl, const URL& aURL ) throw( RuntimeException )
118*cdf0e10cSrcweir 
119*cdf0e10cSrcweir {
120*cdf0e10cSrcweir 	DBG_ASSERT( m_xRealDispatch.is(), "invalid dispatch" );
121*cdf0e10cSrcweir 	m_xRealDispatch->removeStatusListener( xControl, aURL );
122*cdf0e10cSrcweir }
123*cdf0e10cSrcweir 
124