/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __FRAMEWORK_DISPATCH_STARTMODULEDISPATCHER_HXX_ #define __FRAMEWORK_DISPATCH_STARTMODULEDISPATCHER_HXX_ //_______________________________________________ // my own includes #include #include #include #include #include #include #include //_______________________________________________ // interface includes #include #include #include #include #include #include #include #include #include //_______________________________________________ // other includes #include #include //_______________________________________________ // namespace namespace framework{ //----------------------------------------------- /** @short helper to handle all URLs related to the StartModule */ class StartModuleDispatcher : public css::lang::XTypeProvider , public css::frame::XNotifyingDispatch // => XDispatch , public css::frame::XDispatchInformationProvider // baseclasses ... order is neccessary for right initialization! , private ThreadHelpBase , public ::cppu::OWeakObject { //------------------------------------------- // member private: //--------------------------------------- /** @short reference to an uno service manager, which can be used to create own needed uno resources. */ css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR; //--------------------------------------- /** @short our "context" frame. */ css::uno::WeakReference< css::frame::XFrame > m_xOwner; //--------------------------------------- /** @short the original queryDispatch() target. */ ::rtl::OUString m_sDispatchTarget; //--------------------------------------- /** @short list of registered status listener */ ListenerHash m_lStatusListener; //------------------------------------------- // native interface public: //--------------------------------------- /** @short connect a new StartModuleDispatcher instance to its "owner frame". @descr Such "owner frame" is used as context for all related operations. @param xSMGR an uno service manager, which is needed to create uno resource internaly. @param xFrame the frame where the corresponding dispatch was started. @param sTarget the original target information used for the related queryDispatch() call. */ StartModuleDispatcher(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR , const css::uno::Reference< css::frame::XFrame >& xFrame , const ::rtl::OUString& sTarget); //--------------------------------------- /** @short does nothing real. */ virtual ~StartModuleDispatcher(); //------------------------------------------- // uno interface public: //--------------------------------------- FWK_DECLARE_XINTERFACE FWK_DECLARE_XTYPEPROVIDER //--------------------------------------- // XNotifyingDispatch virtual void SAL_CALL dispatchWithNotification( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException); //--------------------------------------- // XDispatch virtual void SAL_CALL dispatch ( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments) throw(css::uno::RuntimeException); virtual void SAL_CALL addStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& xListener , const css::util::URL& aURL ) throw(css::uno::RuntimeException); virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener , const css::util::URL& aURL ) throw(css::uno::RuntimeException); //--------------------------------------- // XDispatchInformationProvider virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedCommandGroups ( ) throw (css::uno::RuntimeException); virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( sal_Int16 nCommandGroup ) throw (css::uno::RuntimeException); //------------------------------------------- // internal helper private: //--------------------------------------- /** @short check if StartModule can be shown. */ ::sal_Bool implts_isBackingModePossible(); //--------------------------------------- /** @short open the special BackingComponent (now StartModule) @return [bool] sal_True if operation was successfully. */ ::sal_Bool implts_establishBackingMode(); //--------------------------------------- /** @short notify a DispatchResultListener. @descr We check the listener reference before we use it. So this method can be called everytimes! @parama xListener the listener, which should be notified. Can be null! @param nState directly used as css::frame::DispatchResultState value. @param aResult not used yet realy ... */ void implts_notifyResultListener(const css::uno::Reference< css::frame::XDispatchResultListener >& xListener, sal_Int16 nState , const css::uno::Any& aResult ); }; // class StartModuleDispatcher } // namespace framework #endif // #ifndef __FRAMEWORK_DISPATCH_STARTMODULEDISPATCHER_HXX_