1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef __FRAMEWORK_DISPATCH_LOADDISPATCHER_HXX_ 25*b1cdbd2cSJim Jagielski #define __FRAMEWORK_DISPATCH_LOADDISPATCHER_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski //_______________________________________________ 28*b1cdbd2cSJim Jagielski // my own includes 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #include <loadenv/loadenv.hxx> 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski //_______________________________________________ 33*b1cdbd2cSJim Jagielski // interface includes 34*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XNotifyingDispatch.hpp> 35*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XSynchronousDispatch.hpp> 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski //_______________________________________________ 38*b1cdbd2cSJim Jagielski // other includes 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski #include <cppuhelper/implbase2.hxx> 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski //_______________________________________________ 43*b1cdbd2cSJim Jagielski // namespace 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski namespace framework{ 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski namespace css = ::com::sun::star; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski //_______________________________________________ 50*b1cdbd2cSJim Jagielski // exported const 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski //_______________________________________________ 53*b1cdbd2cSJim Jagielski // exported definitions 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski /** @short implements a dispatch object which can be used to load 56*b1cdbd2cSJim Jagielski non-visible components (by using the mechanism of ContentHandler) 57*b1cdbd2cSJim Jagielski or visible-components (by using the mechanism of FrameLoader). 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski @author as96863 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski class LoadDispatcher : private ThreadHelpBase 62*b1cdbd2cSJim Jagielski , public ::cppu::WeakImplHelper2< css::frame::XNotifyingDispatch, // => XDispatch => XInterface 63*b1cdbd2cSJim Jagielski css::frame::XSynchronousDispatch > 64*b1cdbd2cSJim Jagielski { 65*b1cdbd2cSJim Jagielski //___________________________________________ 66*b1cdbd2cSJim Jagielski // member 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski private: 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski /** @short can be used to create own needed services on demand. */ 71*b1cdbd2cSJim Jagielski css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski /** @short TODO document me */ 74*b1cdbd2cSJim Jagielski css::uno::WeakReference< css::frame::XFrame > m_xOwnerFrame; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** @short TODO document me */ 77*b1cdbd2cSJim Jagielski ::rtl::OUString m_sTarget; 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski /** @short TODO document me */ 80*b1cdbd2cSJim Jagielski sal_Int32 m_nSearchFlags; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski /** @short TODO document me */ 83*b1cdbd2cSJim Jagielski LoadEnv m_aLoader; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski //___________________________________________ 86*b1cdbd2cSJim Jagielski // native interface 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski public: 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** @short creates a new instance and initialize it with all neccessary parameters. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @descr Every instance of such LoadDispatcher can be used for the specified context only. 93*b1cdbd2cSJim Jagielski That means: It can be used to load any further requested content into tzhe here(!) 94*b1cdbd2cSJim Jagielski specified target frame. 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @param xSMGR 97*b1cdbd2cSJim Jagielski will be used to create own needed services on demand. 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski @param xOwnerFrame 100*b1cdbd2cSJim Jagielski used as startpoit to locate the right target frame. 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski @param sTargetName 103*b1cdbd2cSJim Jagielski the name or the target frame for loading or a special qualifier 104*b1cdbd2cSJim Jagielski which define such target. 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski @param nSearchFlags 107*b1cdbd2cSJim Jagielski used in case sTargetFrame isnt a special one. 108*b1cdbd2cSJim Jagielski */ 109*b1cdbd2cSJim Jagielski LoadDispatcher(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR , 110*b1cdbd2cSJim Jagielski const css::uno::Reference< css::frame::XFrame >& xOwnerFrame , 111*b1cdbd2cSJim Jagielski const ::rtl::OUString sTargetName , 112*b1cdbd2cSJim Jagielski sal_Int32 nSearchFlags); 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski //_______________________________________ 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** @short used to free internal resources. 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski virtual ~LoadDispatcher(); 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski //___________________________________________ 121*b1cdbd2cSJim Jagielski // uno interface 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski public: 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski // XNotifyingDispatch 126*b1cdbd2cSJim Jagielski virtual void SAL_CALL dispatchWithNotification(const css::util::URL& aURL , 127*b1cdbd2cSJim Jagielski const css::uno::Sequence< css::beans::PropertyValue >& lArguments, 128*b1cdbd2cSJim Jagielski const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) 129*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski // XDispatch 132*b1cdbd2cSJim Jagielski virtual void SAL_CALL dispatch(const css::util::URL& aURL , 133*b1cdbd2cSJim Jagielski const css::uno::Sequence< css::beans::PropertyValue >& lArguments) 134*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski virtual void SAL_CALL addStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener, 137*b1cdbd2cSJim Jagielski const css::util::URL& aURL ) 138*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener, 141*b1cdbd2cSJim Jagielski const css::util::URL& aURL ) 142*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski // XSynchronousDispatch 145*b1cdbd2cSJim Jagielski virtual css::uno::Any SAL_CALL dispatchWithReturnValue( const css::util::URL& aURL , 146*b1cdbd2cSJim Jagielski const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) 147*b1cdbd2cSJim Jagielski throw( css::uno::RuntimeException ); 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski private: 150*b1cdbd2cSJim Jagielski css::uno::Any impl_dispatch( const css::util::URL& rURL, 151*b1cdbd2cSJim Jagielski const css::uno::Sequence< css::beans::PropertyValue >& lArguments, 152*b1cdbd2cSJim Jagielski const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ); 153*b1cdbd2cSJim Jagielski }; // class LoadDispatcher 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski } // namespace framework 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski #endif // #ifndef __FRAMEWORK_DISPATCH_LOADDISPATCHER_HXX_ 158