summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/DispatchProvider.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/DispatchProvider.idl')
-rw-r--r--offapi/com/sun/star/frame/DispatchProvider.idl70
1 files changed, 70 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/DispatchProvider.idl b/offapi/com/sun/star/frame/DispatchProvider.idl
new file mode 100644
index 000000000..b2c9bbe6f
--- /dev/null
+++ b/offapi/com/sun/star/frame/DispatchProvider.idl
@@ -0,0 +1,70 @@
+/* -*- 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_DispatchProvider_idl__
+#define __com_sun_star_frame_DispatchProvider_idl__
+
+#include <com/sun/star/frame/XDispatchProvider.idl>
+#include <com/sun/star/frame/XDispatchProviderInterception.idl>
+
+
+module com { module sun { module star { module frame {
+
+/** provides XDispatch objects for certain functions which
+ are useful at the UI
+
+ <p>
+ Such dispatch objects must be queried explicitly and used for
+ queried purposes only. They can handle requests with guaranteed
+ notifications (XNotifyingDispatch) or with possible
+ (but not guaranteed) notifications (XDispatch).
+ </p>
+
+ @see XNotifyingDispatch
+ @see XDispatch
+ @see XControlNotificationListener
+ */
+published service DispatchProvider
+{
+ /** provides handling of dispatches with defined result state
+
+ <p>
+ Base interface of XNotifyingDispatch is XDispatch
+ and can be called for requests if result isn't necessary for dispatch operation.
+ </p>
+
+ @see XDispatch
+ */
+ interface XDispatchProvider;
+
+ /** provides dispatch interception
+
+ <p>
+ It makes it possible to register an XDispatchProvider which
+ intercepts all requests of XDispatch to this instance.
+ </p>
+ */
+ [optional] interface XDispatchProviderInterception;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */