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, 136 insertions, 0 deletions

diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl
new file mode 100644
index 000000000..b25fdcdaf
--- /dev/null
+++ b/offapi/com/sun/star/frame/XDesktop.idl
@@ -0,0 +1,136 @@
+/* -*- 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_XDesktop_idl__
+#define __com_sun_star_frame_XDesktop_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/frame/XTerminateListener.idl>
+#include <com/sun/star/container/XEnumerationAccess.idl>
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/frame/XFrame.idl>
+
+
+
+ module com {  module sun {  module star {  module frame {
+
+/** This is the main interface of a desktop service.
+
+    <p>
+    A desktop is an environment for components which can be viewed in
+    frames. Frames are like frames in HTML framesets. This does not imply
+    that a desktop can handle framesets; the frames may be top frames
+    only.
+    </p>
+
+    @see Desktop
+ */
+published interface XDesktop: com::sun::star::uno::XInterface
+{
+    /** tries to terminate the desktop.
+
+        <p>
+        First, every terminate listener is called by his XTerminateListener::queryTermination() method.
+        Throwing of a TerminationVetoException can break the termination process and the listener how has
+        done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after
+        his own processes will be finished.
+        If nobody disagree with the termination request, every listener will be called by his
+        XTerminateListener::notifyTermination() method.
+        </p>
+
+        @return
+            `TRUE` If all listeners agree with this request
+            <br>
+            `FALSE` Otherwise
+
+        @see XTerminateListener
+        @see TerminationVetoException
+     */
+    boolean terminate();
+
+    /** registers an event listener to the desktop, which is called
+        when the desktop is queried to terminate, and when it really
+        terminates.
+
+        @param Listener
+            listener for termination events
+
+        @see XDesktop::removeTerminateListener()
+     */
+    void addTerminateListener( [in] XTerminateListener Listener );
+
+    /** unregisters an event listener for termination events.
+
+        @param Listener
+            listener which wishes to be deregistered
+
+        @see XDesktop::addTerminateListener()
+     */
+    void removeTerminateListener( [in] XTerminateListener Listener );
+
+    /** provides read access to collection of all currently loaded components
+        inside the frame tree
+
+        <p>
+        The component is, by definition, the model of the control which
+        is loaded into a frame, or if no model exists, into the control
+        itself.
+        The service Components which is available from this
+        method is a collection of all components of the desktop which are open
+        within a frame of the desktop.
+        </p>
+
+        @returns
+            the collection of all components
+
+        @see Components
+     */
+    com::sun::star::container::XEnumerationAccess getComponents();
+
+    /** provides read access to the component inside the tree which has the UI focus
+
+        <p>
+        Normally, the component is the model part of the
+        active component. If no model exists it is the active controller
+        (view) itself.
+        </p>
+
+        @returns
+            the component within the desktop environment which has the UI focus.
+
+        @see XDesktop::getCurrentFrame()
+     */
+    com::sun::star::lang::XComponent getCurrentComponent();
+
+    /** provides read access to the frame which contains the current component
+
+        @returns
+            the frame of the component which has the
+            UI focus within this desktop environment
+
+        @see XDesktop::getCurrentComponent()
+     */
+    XFrame getCurrentFrame();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */