Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

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

1 files changed, 96 insertions, 0 deletions

diff --git a/offapi/com/sun/star/frame/XUIControllerRegistration.idl b/offapi/com/sun/star/frame/XUIControllerRegistration.idl
new file mode 100644
index 000000000..17ebbfeb8
--- /dev/null
+++ b/offapi/com/sun/star/frame/XUIControllerRegistration.idl
@@ -0,0 +1,96 @@
+/* -*- 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_XUIControllerRegistration_idl__
+#define __com_sun_star_frame_XUIControllerRegistration_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module frame {
+
+
+/** is used to query, register and unregister user interface controller.
+
+    <p>
+    A user interface controller can be registered for a command URL. A certain user
+    interface controller will be created when a user interface element contains a
+    registered command URL.
+
+    @see PopupMenuControllerFactory
+    </p>
+
+    @since OOo 2.0
+ */
+
+published interface XUIControllerRegistration : com::sun::star::uno::XInterface
+{
+    /** function to check if an user interface controller is registered
+        for a command URL and optional module.
+
+        @returns
+            true if a controller was registered for the combination of command URL
+            and model name.
+
+        @param aCommandURL
+            a command URL which specifies an action.
+
+        @param aModelName
+            an optional name of an OpenOffice model service. This value can remain empty if
+            no model service name was specified.
+    */
+    boolean hasController( [in] string aCommandURL, [in] string aModelName );
+
+    /** function to create an association between a user interface controller implementation
+        and a command URL and optional module.
+
+        @param aCommandURL
+            a command URL which specifies an action which should be associated with a user
+            interface controller.
+
+        @param aModelName
+            an optional name of an OpenOffice model service. This value can remain empty if
+            no model service name was specified.
+
+        @param aControllerImplementationName
+            a UNO implementation name that can be used to create a user interface controller
+            with the OpenOffice service manager.
+    */
+    void registerController( [in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName );
+
+    /** function to remove a previously defined association between a user interface controller
+        implementation and a command URL and optional module.
+
+        @param aCommandURL
+            a command URL which specifies an action which should be associated with a user
+            interface controller.
+
+        @param aModelName
+            an optional name of an OpenOffice model service. This value can remain empty if
+            no model service name was specified.
+    */
+    void deregisterController( [in] string aCommandURL, [in] string aModelName );
+};
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */