MWS_SRX644: migrate branch mws_srx644 -> HEAD

1 files changed, 213 insertions, 0 deletions

diff --git a/framework/inc/services/dispatchhelper.hxx b/framework/inc/services/dispatchhelper.hxx
new file mode 100644
index 000000000000..9656e7912d43
--- /dev/null
+++ b/framework/inc/services/dispatchhelper.hxx
@@ -0,0 +1,213 @@
+/*************************************************************************
+ *
+ *  $RCSfile: dispatchhelper.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2003-03-25 18:19:51 $
+ *
+ *  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_SERVICES_DISPATCHHELPER_HXX_
+#define __FRAMEWORK_SERVICES_DISPATCHHELPER_HXX_
+
+//_______________________________________________
+// my own includes
+
+#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
+#include <threadhelp/threadhelpbase.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
+#include <macros/generic.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
+#include <macros/debug.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_XSERVICEINFO_HXX_
+#include <macros/xserviceinfo.hxx>
+#endif
+
+#ifndef __FRAMEWORK_GENERAL_H_
+#include <general.h>
+#endif
+
+//_______________________________________________
+// interface includes
+
+#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XDISPATCHHELPER_HPP_
+#include <com/sun/star/frame/XDispatchHelper.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XDISPATCHRESULTLISTENER_HPP_
+#include <com/sun/star/frame/XDispatchResultListener.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_DISPATCHRESULTEVENT_HPP_
+#include <com/sun/star/frame/DispatchResultEvent.hpp>
+#endif
+
+//_______________________________________________
+// other includes
+
+#ifndef _CPPUHELPER_WEAK_HXX_
+#include <cppuhelper/weak.hxx>
+#endif
+
+#ifndef _OSL_CONDITN_HXX_
+#include <osl/conditn.hxx>
+#endif
+
+//_______________________________________________
+// namespace
+
+namespace framework{
+
+//_______________________________________________
+// exported const
+
+//_______________________________________________
+// exported definitions
+
+/**
+    @short      implements an easy way for dispatches
+    @descr      Dispatches are splitted into different parts:
+                    - parsing of the URL
+                    - searching for a dispatcgh object
+                    - dispatching of the URL
+                All these steps are done inside one method call here.
+*/
+
+class DispatchHelper : public css::lang::XTypeProvider
+                     , public css::lang::XServiceInfo
+                     , public css::frame::XDispatchHelper
+                     , public css::frame::XDispatchResultListener // => XEventListener
+                     , public ThreadHelpBase                      // must be the first base class!
+                     , public ::cppu::OWeakObject                 // => XInterface, XWeak
+{
+
+    //-------------------------------------------
+    // member
+
+    private:
+
+        /** global uno service manager.
+            Can be used to create own needed services. */
+        css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
+
+        /** used to wait for asynchronous listener callbacks. */
+        ::osl::Condition m_aBlock;
+
+        css::uno::Any m_aResult;
+
+        css::uno::Reference< css::uno::XInterface > m_xBroadcaster;
+
+    //-------------------------------------------
+    // interface
+
+    public:
+
+        //---------------------------------------
+        // ctor/dtor
+
+                 DispatchHelper( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR );
+        virtual ~DispatchHelper(                                                                     );
+
+        //---------------------------------------
+        // XInterface, XTypeProvider, XServiceInfo
+
+        DECLARE_XINTERFACE
+        DECLARE_XTYPEPROVIDER
+        DECLARE_XSERVICEINFO
+
+        //---------------------------------------
+        // XDispatchHelper
+        virtual css::uno::Any SAL_CALL executeDispatch(
+                                        const css::uno::Reference< css::frame::XDispatchProvider >& xDispatchProvider ,
+                                        const ::rtl::OUString&                                      sURL              ,
+                                        const ::rtl::OUString&                                      sTargetFrameName  ,
+                                              sal_Int32                                             nSearchFlags      ,
+                                        const css::uno::Sequence< css::beans::PropertyValue >&      lArguments        )
+        throw(css::uno::RuntimeException);
+
+        //---------------------------------------
+        // XDispatchResultListener
+        virtual void SAL_CALL dispatchFinished(
+                                const css::frame::DispatchResultEvent& aResult )
+        throw(css::uno::RuntimeException);
+
+        //---------------------------------------
+        // XEventListener
+        virtual void SAL_CALL disposing(
+                                const css::lang::EventObject& aEvent )
+        throw(css::uno::RuntimeException);
+};
+
+}
+
+#endif