INTEGRATION: CWS filtercfg (1.1.2); FILE ADDED

2003/08/21 11:10:43 as 1.1.2.1: #102620# first revision

1 files changed, 191 insertions, 0 deletions

diff --git a/framework/source/inc/dispatch/loaddispatcher.hxx b/framework/source/inc/dispatch/loaddispatcher.hxx
new file mode 100644
index 000000000000..1e30590cf26a
--- /dev/null
+++ b/framework/source/inc/dispatch/loaddispatcher.hxx
@@ -0,0 +1,191 @@
+/*************************************************************************
+ *
+ *  $RCSfile: loaddispatcher.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2004-01-28 14:35:08 $
+ *
+ *  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_LOADDISPATCHER_HXX_
+#define __FRAMEWORK_DISPATCH_LOADDISPATCHER_HXX_
+
+//_______________________________________________
+// my own includes
+
+#ifndef __FRAMEWORK_LOADENV_LOADENV_HXX_
+#include <loadenv/loadenv.hxx>
+#endif
+
+//_______________________________________________
+// interface includes
+
+#ifndef _COM_SUN_STAR_FRAME_XNOTIFYINGDISPATCH_HPP_
+#include <com/sun/star/frame/XNotifyingDispatch.hpp>
+#endif
+
+//_______________________________________________
+// other includes
+
+#ifndef _CPPUHELPER_IMPLBASE1_HXX_
+#include <cppuhelper/implbase1.hxx>
+#endif
+
+//_______________________________________________
+// namespace
+
+namespace framework{
+
+namespace css = ::com::sun::star;
+
+//_______________________________________________
+// exported const
+
+//_______________________________________________
+// exported definitions
+
+/** @short      implements a dispatch object which can be used to load
+                non-visible components (by using the mechanism of ContentHandler)
+                or visible-components (by using the mechanism of FrameLoader).
+
+    @author     as96863
+ */
+class LoadDispatcher : private ThreadHelpBase
+                     , public  ::cppu::WeakImplHelper1< css::frame::XNotifyingDispatch > // => XDispatch => XInterface
+{
+    //___________________________________________
+    // member
+
+    private:
+
+        /** @short  can be used to create own needed services on demand. */
+        css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
+
+        /** @short  TODO document me */
+        css::uno::WeakReference< css::frame::XFrame > m_xOwnerFrame;
+
+        /** @short  TODO document me */
+        ::rtl::OUString m_sTarget;
+
+        /** @short  TODO document me */
+        sal_Int32 m_nSearchFlags;
+
+        /** @short  TODO document me */
+        LoadEnv m_aLoader;
+
+    //___________________________________________
+    // native interface
+
+    public:
+
+        /** @short  creates a new instance and initialize it with all neccessary parameters.
+
+            @descr  Every instance of such LoadDispatcher can be used for the specified context only.
+                    That means: It can be used to load any further requested content into tzhe here(!)
+                    specified target frame.
+
+            @param  xSMGR
+                    will be used to create own needed services on demand.
+
+            @param  xOwnerFrame
+                    used as startpoit to locate the right target frame.
+
+            @param  sTargetName
+                    the name or the target frame for loading or a special qualifier
+                    which define such target.
+
+            @param  nSearchFlags
+                    used in case sTargetFrame isnt a special one.
+         */
+        LoadDispatcher(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR       ,
+                       const css::uno::Reference< css::frame::XFrame >&              xOwnerFrame ,
+                       const ::rtl::OUString                                         sTargetName ,
+                             sal_Int32                                               nSearchFlags);
+
+        //_______________________________________
+
+        /** @short  used to free internal resources.
+         */
+        virtual ~LoadDispatcher();
+
+    //___________________________________________
+    // uno interface
+
+    public:
+
+        // 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);
+
+}; // class LoadDispatcher
+
+} // namespace framework
+
+#endif // #ifndef __FRAMEWORK_DISPATCH_LOADDISPATCHER_HXX_