?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
update dev300-m58
[ooovba.git] / framework / inc / helper / opluginframedispatcher.hxx
blobc3000e67a40bb75ca5415752cac3d08b8f0bf47f
1 /*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * $RCSfile: opluginframedispatcher.hxx,v $
10 * $Revision: 1.8 $
11 *
12 * This file is part of OpenOffice.org.
13 *
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
17 *
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
23 *
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
28 *
29 ************************************************************************/
30
31 #ifndef __FRAMEWORK_HELPER_OPLUGINFRAMEDISPATCHER_HXX_
32 #define __FRAMEWORK_HELPER_OPLUGINFRAMEDISPATCHER_HXX_
33
34 //_________________________________________________________________________________________________________________
35 // my own includes
36 //_________________________________________________________________________________________________________________
37
38 #include <threadhelp/threadhelpbase.hxx>
39 #include <macros/generic.hxx>
40 #include <macros/xinterface.hxx>
41 #include <macros/debug.hxx>
42 #include <general.h>
43
44 //_________________________________________________________________________________________________________________
45 // interface includes
46 //_________________________________________________________________________________________________________________
47 #include <com/sun/star/frame/XFrame.hpp>
48 #include <com/sun/star/frame/XDispatch.hpp>
49 #include <com/sun/star/frame/XDispatchProvider.hpp>
50 #include <com/sun/star/mozilla/XPluginInstance.hpp>
51 #include <com/sun/star/mozilla/XPluginInstancePeer.hpp>
52 #include <com/sun/star/mozilla/XPluginInstanceNotifySink.hpp>
53 #include <com/sun/star/util/URL.hpp>
54 #include <com/sun/star/frame/DispatchDescriptor.hpp>
55 #include <com/sun/star/io/XInputStream.hpp>
56 #include <com/sun/star/beans/PROPERTYVALUE.hpp>
57
58 //_________________________________________________________________________________________________________________
59 // other includes
60 //_________________________________________________________________________________________________________________
61 #include <cppuhelper/implbase3.hxx>
62 #include <cppuhelper/weakref.hxx>
63 #include <cppuhelper/interfacecontainer.hxx>
64
65 //_________________________________________________________________________________________________________________
66 // namespace
67 //_________________________________________________________________________________________________________________
68
69 namespace framework{
70
71 //_________________________________________________________________________________________________________________
72 // exported const
73 //_________________________________________________________________________________________________________________
74
75 //_________________________________________________________________________________________________________________
76 // exported definitions
77 //_________________________________________________________________________________________________________________
78
79 /*-************************************************************************************************************//**
80 Use OMultiTypeInterfaceContainerHelperVar-template to create new class to get a container
81 to combine string values with listeners.
82 *//*-*************************************************************************************************************/
83
84 struct IMPL_hashCode
85 {
86 size_t operator()(const ::rtl::OUString& sString) const
87 {
88 return sString.hashCode();
89 }
90 };
91
92 typedef ::cppu::OMultiTypeInterfaceContainerHelperVar< ::rtl::OUString ,
93 IMPL_hashCode ,
94 ::std::equal_to< ::rtl::OUString > > IMPL_ListenerContainerHelper ;
95
96 /*-************************************************************************************************************//**
97 @short -
98 @descr -
99
100 @implements XInterface
101 XDispatchProvider
102 XDispatch
103 XPluginInstanceNotifySink
104 @base OWeakObject
105
106 @devstatus ready to use
107 *//*-*************************************************************************************************************/
108
109 class OPlugInFrameDispatcher : private ThreadHelpBase ,
110 public ::cppu::WeakImplHelper3< ::com::sun::star::frame::XDispatchProvider, ::com::sun::star::frame::XDispatch, ::com::sun::star::mozilla::XPluginInstanceNotifySink >
111 {
112 //-------------------------------------------------------------------------------------------------------------
113 // public methods
114 //-------------------------------------------------------------------------------------------------------------
115
116 public:
117
118 static void AddArguments ( const css::uno::Sequence< css::beans::PropertyValue > & rArgs ,
119 const ::rtl::OUString& rURL );
120 static const css::uno::Sequence < css::beans::PropertyValue >* GetArguments ( const ::rtl::OUString& rURL );
121 static void RemoveArguments ( const ::rtl::OUString& rURL );
122
123 //---------------------------------------------------------------------------------------------------------
124 // constructor / destructor
125 //---------------------------------------------------------------------------------------------------------
126
127 /*-****************************************************************************************************//**
128 @short standard ctor
129 @descr These initialize a new instance of ths class with needed informations for work.
130
131 @seealso using at owner
132
133 @param -
134 @return -
135
136 @onerror -
137 *//*-*****************************************************************************************************/
138
139 OPlugInFrameDispatcher( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ,
140 const css::uno::Reference< css::mozilla::XPluginInstance >& xOwner ,
141 const css::uno::Reference< css::mozilla::XPluginInstancePeer >& xPlugInDLL );
142
143 //---------------------------------------------------------------------------------------------------------
144 // XDispatchProvider
145 //---------------------------------------------------------------------------------------------------------
146
147 /*-****************************************************************************************************//**
148 @short search a dispatcher for given URL
149 @descr If no interceptor is set on owner, we search for right frame and dispatch URL to it.
150 If no frame was found, we do nothing.
151
152 @seealso -
153
154 @param "aURL" , URL to dispatch.
155 @param "sTargetFrameName" , name of searched frame.
156 @param "nSearchFlags" , flags for searching.
157 @return A reference a dispatcher for these URL (if someone was found!).
158
159 @onerror We return a NULL-reference.
160 *//*-*****************************************************************************************************/
161
162 virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch( const css::util::URL& aURL ,
163 const ::rtl::OUString& sTargetFrameName ,
164 sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException );
165
166 /*-****************************************************************************************************//**
167 @short search dispatcher for more the one URL
168 @descr Call this method, if you search dispatcher for more then one URL at the same time.
169 ( But these mode is not supported yet! )
170
171 @seealso -
172
173 @param "seqDescripts", descriptor to search more then one dispatcher.
174 @return A list of founded dispatcher. (if somewhere exist!)
175
176 @onerror An empty list is returned.
177 *//*-*****************************************************************************************************/
178
179 virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& seqDescripts ) throw( css::uno::RuntimeException );
180
181 //---------------------------------------------------------------------------------------------------------
182 // XDispatch
183 //---------------------------------------------------------------------------------------------------------
184
185 /*-****************************************************************************************************//**
186 @short dispatch URL with arguments
187 @descr This class implement XDispatch interface to. We use the implementation of ouer owner
188 directly to do this. He must support a function impl_loadComponent().
189
190 @seealso methode <owner>::impl_loadComponent()
191
192 @param "aURL" , URL to dispatch.
193 @param "seqArguments" , list of optional arguments.
194 @return -
195
196 @onerror -
197 *//*-*****************************************************************************************************/
198
199 virtual void SAL_CALL dispatch( const css::util::URL& aURL ,
200 const css::uno::Sequence< css::beans::PropertyValue >& seqArguments) throw( css::uno::RuntimeException );
201
202 /*-****************************************************************************************************//**
203 @short add listener for state events
204 @descr -
205
206 @seealso -
207
208 @param "xControl" , reference to a valid listener for state events.
209 @param "aURL" , URL about listener will be informed, if something occured.
210 @return -
211
212 @onerror -
213 *//*-*****************************************************************************************************/
214
215 virtual void SAL_CALL addStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xControl,
216 const css::util::URL& aURL ) throw( css::uno::RuntimeException );
217
218 /*-****************************************************************************************************//**
219 @short remove listener
220 @descr -
221
222 @seealso -
223
224 @param "xControl" , reference to a valid listener.
225 @param "aURL" , URL on which listener has registered.
226 @return -
227
228 @onerror -
229 *//*-*****************************************************************************************************/
230
231 virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xControl,
232 const css::util::URL& aURL ) throw( css::uno::RuntimeException );
233
234 //---------------------------------------------------------------------------------------------------------
235 // XPluginInstanceNotifySink
236 //---------------------------------------------------------------------------------------------------------
237
238 /*-****************************************************************************************************//**
239 @short -
240 @descr -
241
242 @seealso -
243
244 @param -
245 @param -
246 @return -
247
248 @onerror -
249 *//*-*****************************************************************************************************/
250
251 void SAL_CALL notifyURL( const ::rtl::OUString& sURL ) throw( css::uno::RuntimeException );
252
253 //-------------------------------------------------------------------------------------------------------------
254 // protected methods
255 //-------------------------------------------------------------------------------------------------------------
256
257 protected:
258
259 /*-****************************************************************************************************//**
260 @short standard destructor
261 @descr This method destruct an instance of this class and clear some member.
262 This method is protected, because its not allowed to use an instance of this class as a member!
263 You MUST use a pointer.
264
265 @seealso -
266
267 @param -
268 @return -
269
270 @onerror -
271 *//*-*****************************************************************************************************/
272
273 virtual ~OPlugInFrameDispatcher();
274
275 //-------------------------------------------------------------------------------------------------------------
276 // private methods
277 //-------------------------------------------------------------------------------------------------------------
278
279 private:
280
281 /*-****************************************************************************************************//**
282 @short -
283 @descr -
284
285 @seealso -
286
287 @param -
288 @return -
289
290 @onerror -
291 *//*-*****************************************************************************************************/
292
293 void impl_sendStatusEvent( const ::rtl::OUString& sURL ,
294 sal_Bool bLoadingSuccessful );
295
296 //-------------------------------------------------------------------------------------------------------------
297 // debug methods
298 // (should be private everyway!)
299 //-------------------------------------------------------------------------------------------------------------
300
301 /*-****************************************************************************************************//**
302 @short debug-method to check incoming parameter of some other mehods of this class
303 @descr The following methods are used to check parameters for other methods
304 of this class. The return value is used directly for an ASSERT(...).
305
306 @seealso ASSERTs in implementation!
307
308 @param references to checking variables
309 @return sal_False on invalid parameter<BR>
310 sal_True otherway
311
312 @onerror -
313 *//*-*****************************************************************************************************/
314
315 #ifdef ENABLE_ASSERTIONS
316
317 private:
318
319 static sal_Bool impldbg_checkParameter_OPlugInFrameDispatcherCtor ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ,
320 const css::uno::Reference< css::mozilla::XPluginInstance >& xOwner ,
321 const css::uno::Reference< css::mozilla::XPluginInstancePeer >& xPlugInDLL );
322 static sal_Bool impldbg_checkParameter_queryDispatch ( const css::util::URL& aURL ,
323 const ::rtl::OUString& sTargetFrameName ,
324 sal_Int32 nSearchFlags );
325 static sal_Bool impldbg_checkParameter_queryDispatches ( const css::uno::Sequence< css::frame::DispatchDescriptor >& seqDescriptor );
326 static sal_Bool impldbg_checkParameter_dispatch ( const css::util::URL& aURL ,
327 const css::uno::Sequence< css::beans::PropertyValue >& seqArguments );
328 static sal_Bool impldbg_checkParameter_addStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& xControl ,
329 const css::util::URL& aURL );
330 static sal_Bool impldbg_checkParameter_removeStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& xControl ,
331 const css::util::URL& aURL );
332 static sal_Bool impldbg_checkParameter_notifyURL ( const ::rtl::OUString& sURL );
333
334 #endif // #ifdef ENABLE_ASSERTIONS
335
336 //-------------------------------------------------------------------------------------------------------------
337 // variables
338 // (should be private everyway!)
339 //-------------------------------------------------------------------------------------------------------------
340
341 private:
342
343 css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ; /// servicemanager to create uno services
344 css::uno::WeakReference< css::mozilla::XPluginInstance > m_xOwnerWeak ; /// weakreference to owner (Don't use a hard reference. Owner can't delete us then!)
345 css::uno::Reference< css::mozilla::XPluginInstancePeer > m_xPlugInDLL ; /// Interface for communication with browser.
346 ::rtl::OUString m_sTargetFrameName ; /// We need it as target for get/postURL.
347 IMPL_ListenerContainerHelper m_aListenerContainer ; /// Container to combine listeners and URLs.
348
349 }; // class OPlugInFrameDispatcher
350
351 } // namespace framework
352
353 #endif // #ifndef __FRAMEWORK_HELPER_OPLUGINFRAMEDISPATCHER_HXX_
vba interoperability for OOo