Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 123 insertions, 0 deletions

diff --git a/include/framework/dispatchhelper.hxx b/include/framework/dispatchhelper.hxx
new file mode 100644
index 000000000..d767b1345
--- /dev/null
+++ b/include/framework/dispatchhelper.hxx
@@ -0,0 +1,123 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   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 .
+ */
+
+#ifndef INCLUDED_FRAMEWORK_INC_SERVICES_DISPATCHHELPER_HXX
+#define INCLUDED_FRAMEWORK_INC_SERVICES_DISPATCHHELPER_HXX
+
+#include <config_options.h>
+#include <com/sun/star/frame/XDispatchHelper.hpp>
+#include <com/sun/star/frame/XDispatchResultListener.hpp>
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/uno/Any.hxx>
+
+#include <cppuhelper/implbase.hxx>
+#include <framework/fwedllapi.h>
+#include <osl/conditn.hxx>
+
+namespace com::sun::star::lang
+{
+class XMultiServiceFactory;
+}
+namespace com::sun::star::lang
+{
+class XSingleServiceFactory;
+}
+namespace com::sun::star::uno
+{
+class XComponentContext;
+}
+
+namespace framework
+{
+/**
+    @short      implements an easy way for dispatches
+    @descr      Dispatches are split into different parts:
+                    - parsing of the URL
+                    - searching for a dispatch object
+                    - dispatching of the URL
+                All these steps are done inside one method call here.
+*/
+class UNLESS_MERGELIBS(FWE_DLLPUBLIC) DispatchHelper final
+    : public ::cppu::WeakImplHelper<css::lang::XServiceInfo, css::frame::XDispatchHelper,
+                                    css::frame::XDispatchResultListener>
+{
+    // member
+
+private:
+    osl::Mutex m_mutex;
+
+    /** global uno service manager.
+            Can be used to create own needed services. */
+    css::uno::Reference<css::uno::XComponentContext> m_xContext;
+
+    /** 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::uno::XComponentContext>& xContext);
+    virtual ~DispatchHelper() override;
+
+    // XServiceInfo
+    virtual OUString SAL_CALL getImplementationName() override;
+    virtual sal_Bool SAL_CALL supportsService(const OUString& sServiceName) override;
+    virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
+
+    static css::uno::Sequence<OUString> impl_getStaticSupportedServiceNames();
+    static OUString impl_getStaticImplementationName();
+    // Helper for initialization of service by using own reference!
+    void impl_initService();
+
+    // Helper for registry
+    /// @throws css::uno::Exception
+    static css::uno::Reference<css::uno::XInterface> SAL_CALL impl_createInstance(
+        const css::uno::Reference<css::lang::XMultiServiceFactory>& xServiceManager);
+    static css::uno::Reference<css::lang::XSingleServiceFactory>
+    impl_createFactory(const css::uno::Reference<css::lang::XMultiServiceFactory>& xServiceManager);
+
+    // XDispatchHelper
+    virtual css::uno::Any SAL_CALL
+    executeDispatch(const css::uno::Reference<css::frame::XDispatchProvider>& xDispatchProvider,
+                    const OUString& sURL, const OUString& sTargetFrameName, sal_Int32 nSearchFlags,
+                    const css::uno::Sequence<css::beans::PropertyValue>& lArguments) override;
+
+    // not a public XDispatchHelper-method, need in sfx2/source/control/statcach.cxx for extensions
+    /// @throws css::uno::RuntimeException
+    css::uno::Any executeDispatch(const css::uno::Reference<css::frame::XDispatch>& xDispatch,
+                                  const css::util::URL& aURL, bool SyncronFlag,
+                                  const css::uno::Sequence<css::beans::PropertyValue>& lArguments);
+
+    // XDispatchResultListener
+    virtual void SAL_CALL dispatchFinished(const css::frame::DispatchResultEvent& aResult) override;
+
+    // XEventListener
+    virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
+};
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */