xref: /AOO41X/main/framework/inc/dispatch/systemexec.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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 #ifndef __FRAMEWORK_DISPATCH_SYSTEMEXEC_HXX_
29*cdf0e10cSrcweir #define __FRAMEWORK_DISPATCH_SYSTEMEXEC_HXX_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
32*cdf0e10cSrcweir //	my own includes
33*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <macros/generic.hxx>
36*cdf0e10cSrcweir #include <macros/xinterface.hxx>
37*cdf0e10cSrcweir #include <macros/xtypeprovider.hxx>
38*cdf0e10cSrcweir #include <macros/xserviceinfo.hxx>
39*cdf0e10cSrcweir #include <macros/debug.hxx>
40*cdf0e10cSrcweir #include <threadhelp/threadhelpbase.hxx>
41*cdf0e10cSrcweir #include <general.h>
42*cdf0e10cSrcweir #include <stdtypes.h>
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
45*cdf0e10cSrcweir //	interface includes
46*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
47*cdf0e10cSrcweir #include <com/sun/star/lang/XTypeProvider.hpp>
48*cdf0e10cSrcweir #include <com/sun/star/frame/XNotifyingDispatch.hpp>
49*cdf0e10cSrcweir #include <com/sun/star/frame/XDispatch.hpp>
50*cdf0e10cSrcweir #include <com/sun/star/frame/XDispatchProvider.hpp>
51*cdf0e10cSrcweir #include <com/sun/star/util/URL.hpp>
52*cdf0e10cSrcweir #include <com/sun/star/beans/PropertyValue.hpp>
53*cdf0e10cSrcweir #include <com/sun/star/frame/XStatusListener.hpp>
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
56*cdf0e10cSrcweir //	other includes
57*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
58*cdf0e10cSrcweir #include <cppuhelper/weak.hxx>
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
61*cdf0e10cSrcweir //	namespace
62*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir namespace framework{
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
67*cdf0e10cSrcweir //	exported const
68*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
71*cdf0e10cSrcweir //	exported definitions
72*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir /**
75*cdf0e10cSrcweir     @short          protocol handler for "systemexec:*" URLs
76*cdf0e10cSrcweir     @descr          It's a special dispatch/provider object which is registered for such URL pattern and will
77*cdf0e10cSrcweir                     be automaticly used by the framework dispatch mechanism if such URL occured.
78*cdf0e10cSrcweir                     It forwards all URL's to the underlying operating system.
79*cdf0e10cSrcweir                     So it would e.g. be possible to open HTML files outside the office within a web browser.
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir     @base           ThreadHelpBase
82*cdf0e10cSrcweir                         exports a lock member to guarantee right initialize value of it
83*cdf0e10cSrcweir     @base           OWeakObject
84*cdf0e10cSrcweir                         provides XWeak and ref count mechanism
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir 	@devstatus		ready to use
87*cdf0e10cSrcweir */
88*cdf0e10cSrcweir class SystemExec : // interfaces
89*cdf0e10cSrcweir                        public  css::lang::XTypeProvider      ,
90*cdf0e10cSrcweir                        public  css::lang::XServiceInfo       ,
91*cdf0e10cSrcweir                        public  css::frame::XDispatchProvider ,
92*cdf0e10cSrcweir                        public  css::frame::XNotifyingDispatch, // => XDispatch
93*cdf0e10cSrcweir                        // baseclasses
94*cdf0e10cSrcweir                        // Order is neccessary for right initialization!
95*cdf0e10cSrcweir                        private ThreadHelpBase                ,
96*cdf0e10cSrcweir                        public  cppu::OWeakObject
97*cdf0e10cSrcweir {
98*cdf0e10cSrcweir     /* member */
99*cdf0e10cSrcweir     private:
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir         /// reference to global uno service manager which had created us
102*cdf0e10cSrcweir         css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory;
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir     /* interface */
105*cdf0e10cSrcweir 	public:
106*cdf0e10cSrcweir 
107*cdf0e10cSrcweir         // ctor/dtor
108*cdf0e10cSrcweir                  SystemExec( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
109*cdf0e10cSrcweir         virtual ~SystemExec(                                                                        );
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir         // XInterface, XTypeProvider, XServiceInfo
112*cdf0e10cSrcweir         FWK_DECLARE_XINTERFACE
113*cdf0e10cSrcweir 		FWK_DECLARE_XTYPEPROVIDER
114*cdf0e10cSrcweir         DECLARE_XSERVICEINFO
115*cdf0e10cSrcweir 
116*cdf0e10cSrcweir         // XDispatchProvider
117*cdf0e10cSrcweir         virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL                       queryDispatch  ( const css::util::URL&                                       aURL        ,
118*cdf0e10cSrcweir                                                                                                              const ::rtl::OUString&                                      sTarget     ,
119*cdf0e10cSrcweir                                                                                                                    sal_Int32                                             nFlags      ) throw( css::uno::RuntimeException );
120*cdf0e10cSrcweir         virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) throw( css::uno::RuntimeException );
121*cdf0e10cSrcweir 
122*cdf0e10cSrcweir         // XNotifyingDispatch
123*cdf0e10cSrcweir         virtual void SAL_CALL dispatchWithNotification( const css::util::URL&                                             aURL      ,
124*cdf0e10cSrcweir                                                         const css::uno::Sequence< css::beans::PropertyValue >&            lArguments,
125*cdf0e10cSrcweir                                                         const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw( css::uno::RuntimeException );
126*cdf0e10cSrcweir 
127*cdf0e10cSrcweir         // XDispatch
128*cdf0e10cSrcweir         virtual void SAL_CALL dispatch            ( const css::util::URL&                                     aURL       ,
129*cdf0e10cSrcweir                                                     const css::uno::Sequence< css::beans::PropertyValue >&    lArguments ) throw( css::uno::RuntimeException );
130*cdf0e10cSrcweir         virtual void SAL_CALL addStatusListener   ( const css::uno::Reference< css::frame::XStatusListener >& xListener  ,
131*cdf0e10cSrcweir                                                     const css::util::URL&                                     aURL       ) throw( css::uno::RuntimeException );
132*cdf0e10cSrcweir         virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener  ,
133*cdf0e10cSrcweir                                                     const css::util::URL&                                     aURL       ) throw( css::uno::RuntimeException );
134*cdf0e10cSrcweir 
135*cdf0e10cSrcweir     /* internal */
136*cdf0e10cSrcweir     private:
137*cdf0e10cSrcweir 
138*cdf0e10cSrcweir         void impl_notifyResultListener(const css::uno::Reference< css::frame::XDispatchResultListener >& xListener,
139*cdf0e10cSrcweir                                        const sal_Int16                                                   nState   );
140*cdf0e10cSrcweir 
141*cdf0e10cSrcweir };      //  class SystemExec
142*cdf0e10cSrcweir 
143*cdf0e10cSrcweir }		//	namespace framework
144*cdf0e10cSrcweir 
145*cdf0e10cSrcweir #endif  //  #ifndef __FRAMEWORK_DISPATCH_SYSTEMEXEC_HXX_
146