Introduce com.sun.star.frame.theGlobalEventBroadcaster singleton

...to supersede com.sun.star.frame.GlobalEventBroadcaster single-instance
service.

Change-Id: I74ecaadadb4c600d39979aa7c13b6389bed38fd7

4 files changed, 52 insertions, 6 deletions

diff --git a/offapi/UnoApi_offapi.mk b/offapi/UnoApi_offapi.mk
index 66d1b6e5b435..bd38826bea31 100755
--- a/offapi/UnoApi_offapi.mk
+++ b/offapi/UnoApi_offapi.mk
@@ -200,6 +200,7 @@ $(eval $(call gb_UnoApi_add_idlfiles_nohdl,offapi,com/sun/star/frame,\
     StartModule \
     TaskCreator \
 	UICommandDescription \
+	theGlobalEventBroadcaster \
 ))
 $(eval $(call gb_UnoApi_add_idlfiles_nohdl,offapi,com/sun/star/graphic,\
 	GraphicObject \
diff --git a/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl b/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl
index 6fe6af8eb54a..47fbc9e842c3 100644
--- a/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl
+++ b/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl
@@ -25,12 +25,11 @@
 module com {  module sun {  module star {  module frame {
 
 /**
-    This service offers the document event functionality that can be found at any
-    com::sun::star::document::OfficeDocument, but it does it for all existing documents.
-    So it is a single place where a listener can be registered for all events in all
-    documents.
- */
+   A legacy (single-instance) service-variant of theGlobalEventBroadcaster
+   singleton.
 
+   @deprecated Use theGlobalEventBroadcaster singleton instead.
+*/
 service GlobalEventBroadcaster : XGlobalEventBroadcaster;
 
 
diff --git a/offapi/com/sun/star/frame/XGlobalEventBroadcaster.idl b/offapi/com/sun/star/frame/XGlobalEventBroadcaster.idl
index ca5d9fd11eef..e4b6043f2894 100644
--- a/offapi/com/sun/star/frame/XGlobalEventBroadcaster.idl
+++ b/offapi/com/sun/star/frame/XGlobalEventBroadcaster.idl
@@ -28,7 +28,7 @@
 module com {  module sun {  module star {  module frame {
 
 /**
-   Provides a unified interface for the GlobalEventBroadcaster service to implement.
+   Provides the unified interface of theGlobalEventBroadcaster singleton.
 
    @since LibreOffice 4.0
  */
diff --git a/offapi/com/sun/star/frame/theGlobalEventBroadcaster.idl b/offapi/com/sun/star/frame/theGlobalEventBroadcaster.idl
new file mode 100644
index 000000000000..b802a1385bc6
--- /dev/null
+++ b/offapi/com/sun/star/frame/theGlobalEventBroadcaster.idl
@@ -0,0 +1,46 @@
+/* -*- 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_GLOBALEVENTBROADCASTER_IDL
+#define COM_SUN_STAR_FRAME_GLOBALEVENTBROADCASTER_IDL
+
+#include <com/sun/star/frame/XGlobalEventBroadcaster.idl>
+
+module com { module sun { module star { module frame {
+
+/**
+    This singleton offers the document event functionality that can be found at
+    any com::sun::star::document::OfficeDocument, but it does it for all
+    existing documents.
+
+    So it is a single place where a listener can be registered for all events in
+    all documents.
+
+    Prior to LibreOffice 4.3, this singleton was only available as a
+    (single-instance) GlobalEventBroadcaster service.
+
+    @since LibreOffice 4.3
+*/
+singleton theGlobalEventBroadcaster: XGlobalEventBroadcaster;
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */