#79955# move to dispatch dir

1 files changed, 448 insertions, 0 deletions

diff --git a/framework/inc/dispatch/menudispatcher.hxx b/framework/inc/dispatch/menudispatcher.hxx
new file mode 100644
index 0000000000..e6726b8c21
--- /dev/null
+++ b/framework/inc/dispatch/menudispatcher.hxx
@@ -0,0 +1,448 @@
+/*************************************************************************
+ *
+ *  $RCSfile: menudispatcher.hxx,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: as $ $Date: 2001-07-02 13:22:14 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __FRAMEWORK_DISPATCH_MENUDISPATCHER_HXX_
+#define __FRAMEWORK_DISPATCH_MENUDISPATCHER_HXX_
+
+//_________________________________________________________________________________________________________________
+//	my own includes
+//_________________________________________________________________________________________________________________
+
+#ifndef __FRAMEWORK_CLASSES_TASKCREATOR_HXX_
+#include <classes/taskcreator.hxx>
+#endif
+
+#ifndef __FRAMEWORK_SERVICES_FRAME_HXX_
+#include <services/frame.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
+#include <macros/generic.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
+#include <macros/xinterface.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
+#include <macros/xtypeprovider.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
+#include <macros/debug.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
+#include <threadhelp/threadhelpbase.hxx>
+#endif
+
+#ifndef __FRAMEWORK_CLASSES_MENUMANAGER_HXX_
+#include <classes/menumanager.hxx>
+#endif
+
+#ifndef __FRAMEWORK_GENERAL_H_
+#include <general.h>
+#endif
+
+#ifndef __FRAMEWORK_STDTYPES_H_
+#include <stdtypes.h>
+#endif
+
+//_________________________________________________________________________________________________________________
+//	interface includes
+//_________________________________________________________________________________________________________________
+
+#ifndef _COM_SUN_STAR_LANG_XTYPEPROVIDER_HPP_
+#include <com/sun/star/lang/XTypeProvider.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XDISPATCH_HPP_
+#include <com/sun/star/frame/XDispatch.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_UTIL_URL_HPP_
+#include <com/sun/star/util/URL.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_DISPATCHDESCRIPTOR_HPP_
+#include <com/sun/star/frame/DispatchDescriptor.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
+#include <com/sun/star/beans/PropertyValue.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XSTATUSLISTENER_HPP_
+#include <com/sun/star/frame/XStatusListener.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XFRAMELOADER_HPP_
+#include <com/sun/star/frame/XFrameLoader.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XLOADEVENTLISTENER_HPP_
+#include <com/sun/star/frame/XLoadEventListener.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XDESKTOP_HPP_
+#include <com/sun/star/frame/XDesktop.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XTASK_HPP_
+#include <com/sun/star/frame/XTask.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_FEATURESTATEEVENT_HPP_
+#include <com/sun/star/frame/FeatureStateEvent.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XFRAMEACTIONLISTENER_HPP_
+#include <com/sun/star/frame/XFrameActionListener.hpp>
+#endif
+
+//_________________________________________________________________________________________________________________
+//	other includes
+//_________________________________________________________________________________________________________________
+
+#ifndef _CPPUHELPER_WEAK_HXX_
+#include <cppuhelper/weak.hxx>
+#endif
+
+#ifndef _CPPUHELPER_WEAKREF_HXX_
+#include <cppuhelper/weakref.hxx>
+#endif
+
+#ifndef _CPPUHELPER_INTERFACECONTAINER_H_
+#include <cppuhelper/interfacecontainer.h>
+#endif
+
+//_________________________________________________________________________________________________________________
+//	namespace
+//_________________________________________________________________________________________________________________
+
+namespace framework{
+
+
+//_________________________________________________________________________________________________________________
+//	exported const
+//_________________________________________________________________________________________________________________
+
+//_________________________________________________________________________________________________________________
+//	exported definitions
+//_________________________________________________________________________________________________________________
+
+/*-************************************************************************************************************//**
+    We must save informations about our listener and URL for listening.
+    We implement this as a hashtable for strings.
+*//*-*************************************************************************************************************/
+
+typedef ::cppu::OMultiTypeInterfaceContainerHelperVar<	::rtl::OUString			,
+                                                        OUStringHashCode		,
+                                                        std::equal_to< ::rtl::OUString > > IMPL_ListenerHashContainer;
+
+
+/*-************************************************************************************************************//**
+    @short			helper for desktop only(!) to create new tasks on demand for dispatches
+    @descr			Use this class as member only! Never use it as baseclass.
+                    XInterface will be ambigous and we hold a weakcss::uno::Reference to ouer OWNER - not to ouer SUPERCLASS!
+
+    @implements		XInterface
+                    XDispatch
+                    XLoadEventListener
+                    XFrameActionListener
+                    XEventListener
+    @base			ThreadHelpBase
+                    OWeakObject
+
+    @devstatus		ready to use
+*//*-*************************************************************************************************************/
+class MenuDispatcher   :   // interfaces
+                                public css::lang::XTypeProvider			,
+                                public css::frame::XDispatch			,
+                                public css::frame::XFrameActionListener	,
+                                // baseclasses
+                                // Order is neccessary for right initialization!
+                                public ThreadHelpBase						,
+                                public cppu::OWeakObject
+{
+    //-------------------------------------------------------------------------------------------------------------
+    //	public methods
+    //-------------------------------------------------------------------------------------------------------------
+
+    public:
+
+        //---------------------------------------------------------------------------------------------------------
+        //	constructor / destructor
+        //---------------------------------------------------------------------------------------------------------
+
+        /*-****************************************************************************************************//**
+            @short		standard ctor
+            @descr		These initialize a new instance of ths class with needed informations for work.
+
+            @seealso	using at owner
+
+            @param		"xFactory"	, css::uno::Reference to servicemanager for creation of new services
+            @param		"xOwner"	, css::uno::Reference to our owner, the Desktop!!!
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        MenuDispatcher(    const   css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory    ,
+                            const	css::uno::Reference< css::frame::XFrame >&				xOwner		);
+
+        //---------------------------------------------------------------------------------------------------------
+        //	XInterface
+        //---------------------------------------------------------------------------------------------------------
+
+        DECLARE_XINTERFACE
+        DECLARE_XTYPEPROVIDER
+
+        //---------------------------------------------------------------------------------------------------------
+        //	XDispatch
+        //---------------------------------------------------------------------------------------------------------
+
+        /*-****************************************************************************************************//**
+            @short      dispatch URL with arguments
+            @descr		Every dispatch create a new task. If load of URL failed task will deleted automaticly!
+
+            @seealso	-
+
+            @param		"aURL"			, URL to dispatch.
+            @param		"seqArguments"	, list of optional arguments.
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        virtual void SAL_CALL dispatch(	const	css::util::URL&										aURL			,
+                                        const	css::uno::Sequence< css::beans::PropertyValue >&	seqProperties	) throw( css::uno::RuntimeException );
+
+        /*-****************************************************************************************************//**
+            @short      add listener for state events
+            @descr		You can add a listener to get information about status of dispatch: OK or Failed.
+
+            @seealso	method loadFinished()
+            @seealso	method loadCancelled()
+
+            @param		"xControl"	, css::uno::Reference to a valid listener for state events.
+            @param		"aURL"		, URL about listener will be informed, if something occured.
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        virtual void SAL_CALL addStatusListener(	const	css::uno::Reference< css::frame::XStatusListener >&	xControl,
+                                                    const	css::util::URL&										aURL	) throw( css::uno::RuntimeException );
+
+        /*-****************************************************************************************************//**
+            @short      remove listener for state events
+            @descr		You can remove a listener if information of dispatch isn't important for you any longer.
+
+            @seealso	method loadFinished()
+            @seealso	method loadCancelled()
+
+            @param		"xControl"	, css::uno::Reference to a valid listener.
+            @param		"aURL"		, URL on which listener has registered.
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        virtual void SAL_CALL removeStatusListener(	const	css::uno::Reference< css::frame::XStatusListener >&	xControl,
+                                                    const	css::util::URL&										aURL	) throw( css::uno::RuntimeException );
+
+
+        //---------------------------------------------------------------------------------------------------------
+        //	 XFrameActionListener
+        //---------------------------------------------------------------------------------------------------------
+
+        virtual void SAL_CALL frameAction( const css::frame::FrameActionEvent& aEvent ) throw ( css::uno::RuntimeException );
+
+        //---------------------------------------------------------------------------------------------------------
+        //	 XEventListener
+        //---------------------------------------------------------------------------------------------------------
+
+        /*-****************************************************************************************************//**
+            @short		dispose current instance
+            @descr		If service helper isn't required any longer call this method to release all used ressources.
+
+            @seealso	-
+
+            @param		"aEvent", information about source of this event.
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        void SAL_CALL disposing( const EVENTOBJECT& aEvent ) throw( css::uno::RuntimeException );
+
+    //-------------------------------------------------------------------------------------------------------------
+    //	protected methods
+    //-------------------------------------------------------------------------------------------------------------
+
+    protected:
+
+        /*-****************************************************************************************************//**
+            @short		standard destructor
+            @descr		This method destruct an instance of this class and clear some member.
+                        This method is protected, because its not allowed to use an instance of this class as a member!
+                        You MUST use a pointer.
+
+            @seealso	-
+
+            @param		-
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        virtual ~MenuDispatcher();
+
+    //-------------------------------------------------------------------------------------------------------------
+    //	private methods
+    //-------------------------------------------------------------------------------------------------------------
+
+    private:
+
+        /*-****************************************************************************************************//**
+            @short		-
+            @descr		-
+
+            @seealso	-
+
+            @param		-
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        void impl_sendStatusEvent(	const	css::uno::Reference< XFRAME >&	xEventSource	,
+                                    const	::rtl::OUString&		sURL			,
+                                            sal_Bool    			bLoadState		);
+
+
+        /*-****************************************************************************************************//**
+            @short		-
+            @descr		-
+
+            @seealso	-
+
+            @param		-
+            @return		-
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+        sal_Bool impl_setMenuBar( MenuBar* pMenuBar, sal_Bool bMenuFromResource = sal_False );
+
+    //-------------------------------------------------------------------------------------------------------------
+    //	debug methods
+    //	(should be private everyway!)
+    //-------------------------------------------------------------------------------------------------------------
+
+        /*-****************************************************************************************************//**
+            @short		debug-method to check incoming parameter of some other mehods of this class
+            @descr		The following methods are used to check parameters for other methods
+                        of this class. The return value is used directly for an ASSERT(...).
+
+            @seealso	ASSERTs in implementation!
+
+            @param		css::uno::References to checking variables
+            @return		sal_False on invalid parameter<BR>
+                        sal_True  otherway
+
+            @onerror	-
+        *//*-*****************************************************************************************************/
+
+    #ifdef ENABLE_ASSERTIONS
+
+    private:
+
+        static sal_Bool impldbg_checkParameter_MenuDispatcher      (   const   css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory        ,
+                                                                        const	css::uno::Reference< css::frame::XFrame >&				xOwner			);
+        static sal_Bool impldbg_checkParameter_dispatch				(	const	css::util::URL&											aURL			,
+                                                                        const	css::uno::Sequence< css::beans::PropertyValue >&		seqArguments	);
+        static sal_Bool impldbg_checkParameter_addStatusListener	(	const	css::uno::Reference< css::frame::XStatusListener >&		xControl		,
+                                                                        const	css::util::URL&											aURL			);
+        static sal_Bool impldbg_checkParameter_removeStatusListener	(	const	css::uno::Reference< css::frame::XStatusListener >&		xControl		,
+                                                                        const	css::util::URL&											aURL			);
+    #endif	// #ifdef ENABLE_ASSERTIONS
+
+    //-------------------------------------------------------------------------------------------------------------
+    //	variables
+    //	(should be private everyway!)
+    //-------------------------------------------------------------------------------------------------------------
+
+    private:
+
+        css::uno::WeakReference< css::frame::XFrame >			m_xOwnerWeak		;	/// css::uno::WeakReference to owner (Don't use a hard css::uno::Reference. Owner can't delete us then!)
+        css::uno::Reference< css::lang::XMultiServiceFactory >	m_xFactory			;	/// factory shared with our owner to create new services!
+        IMPL_ListenerHashContainer								m_aListenerContainer;	/// hash table for listener at specified URLs
+        sal_Bool												m_bAlreadyDisposed	;	/// Protection against multiple disposing calls.
+        sal_Bool												m_bActivateListener ;	/// dispatcher is listener for frame activation
+        MenuManager*											m_pMenuManager		;	/// menu manager controlling menu dispatches
+
+};      //  class MenuDispatcher
+
+}		//	namespace framework
+
+#endif  //  #ifndef __FRAMEWORK_DISPATCH_MENUDISPATCHER_HXX_