1 files changed, 87 insertions, 0 deletions
diff --git a/forms/source/inc/controlfeatureinterception.hxx b/forms/source/inc/controlfeatureinterception.hxx
new file mode 100644
index 000000000..1e58ffb63
--- /dev/null
+++ b/forms/source/inc/controlfeatureinterception.hxx
@@ -0,0 +1,87 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <com/sun/star/frame/XDispatchProviderInterceptor.hpp>
+#include <com/sun/star/uno/XComponentContext.hpp>
+
+#include <memory>
+
+#include "urltransformer.hxx"
+
+
+namespace frm
+{
+
+
+    class UrlTransformer;
+
+    //= ControlFeatureInterception
+
+    /** helper class for controls which allow some of their features to be intercepted
+        by external instances
+
+        For using this class, instantiate it as member, derive yourself from
+        <type scope="css::frame">XDispatchProviderInterception</type>, and forward all
+        respective methods to this member.
+
+        Additionally, don't forget to call <member>dispose</member> when your class is disposed itself.
+    */
+    class ControlFeatureInterception
+    {
+    private:
+        css::uno::Reference< css::frame::XDispatchProviderInterceptor >
+                                              m_xFirstDispatchInterceptor;
+        ::std::unique_ptr< UrlTransformer >   m_pUrlTransformer;
+
+    public:
+        /** retrieves our URL transformer, so our clients may use it, too
+        */
+        const UrlTransformer& getTransformer() const { return *m_pUrlTransformer; }
+
+    public:
+        ControlFeatureInterception( const css::uno::Reference< css::uno::XComponentContext >& _rxORB );
+
+        // XDispatchProviderInterception
+        /// @throws css::uno::RuntimeException
+        void registerDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& Interceptor );
+        /// @throws css::uno::RuntimeException
+        void releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& Interceptor );
+
+        // XComponent
+        void dispose();
+
+        /** queries the interceptor chain for the given dispatch, with a blank target frame and no frame search flags
+        */
+        css::uno::Reference< css::frame::XDispatch >
+            queryDispatch( const css::util::URL& _rURL );
+
+        /** queries the interceptor chain for the URL given as ASCII string,
+            with a blank target frame and no frame search flags
+        */
+        css::uno::Reference< css::frame::XDispatch >
+            queryDispatch( const char* _pAsciiURL );
+    };
+
+
+} // namespace frm
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */