1 files changed, 82 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/ProtocolHandler.idl b/offapi/com/sun/star/frame/ProtocolHandler.idl
new file mode 100644
index 000000000..ffdaa3155
--- /dev/null
+++ b/offapi/com/sun/star/frame/ProtocolHandler.idl
@@ -0,0 +1,82 @@
+/* -*- 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 __com_sun_star_frame_ProtocolHandler_idl__
+#define __com_sun_star_frame_ProtocolHandler_idl__
+
+#include <com/sun/star/frame/XDispatchProvider.idl>
+#include <com/sun/star/lang/XInitialization.idl>
+
+
+ module com {  module sun {  module star {  module frame {
+
+/** special dispatch provider registered for URL protocols
+
+    <p>
+    The generic dispatch mechanism on a Frame
+    search for such registered protocol handler and use it if it agrees with
+    the dispatched URL.
+    </p>
+
+    <p>
+    Supported URLs must match follow format:
+    <code><i>protocol scheme</i>:<i>protocol specific part</i></code>
+    If a handler provides optional arguments ("?") or jump marks ("#") depends from his
+    definition and implementation. The generic dispatch provider will use registered
+    URL pattern to detect right handler.
+    </p>
+ */
+published service ProtocolHandler
+{
+        /** used from the generic dispatch mechanism of the frame, to ask ProtocolHandler
+            for his agreement for the dispatched URL
+
+        <p>
+        Such asked handler can agree by returning itself or a special sub dispatch object, which
+        can handle the given URL. Of course he can disagree with it by returning an empty reference.
+        </p>
+        */
+        interface XDispatchProvider;
+
+        /** initialize the new handler instance with some context information
+
+        <p>
+        Sometimes it can be useful for a handler object, to know something about the
+        environment, in which it runs - especially the frame. For this case the generic
+        code (which uses the handler) will ask for this optional interface and use it, if it exist.
+        Following parameters are passed to the service:
+        <ul>
+        <li>sequence< any >[0] => the frame for which this ProtocolHandler was created [com.sun.star.frame.XFrame]</li>
+        </ul>
+        </p>
+
+        <p>
+        Please note: if this mechanism is used it seems not useful (nor possible) to implement a ProtocolHandler
+        as a singleton. Otherwise the implementation can't distinguish between different environments
+        and her corresponding dispatch requests.
+        </p>
+        */
+        [optional] interface ::com::sun::star::lang::XInitialization;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */