offapi/com/sun/star/frame/XDesktop.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module frame {
  23
  24 /** This is the main interface of a desktop service.
  25
  26     <p>
  27     A desktop is an environment for components which can be viewed in
  28     frames. Frames are like frames in HTML framesets. This does not imply
  29     that a desktop can handle framesets; the frames may be top frames
  30     only.
  31     </p>
  32
  33     @see Desktop
  34  */
  35 published interface XDesktop: com::sun::star::uno::XInterface
  36 {
  37     /** tries to terminate the desktop.
  38
  39         <p>
  40         First, every terminate listener is called by his XTerminateListener::queryTermination() method.
  41         Throwing of a TerminationVetoException can break the termination process and the listener how has
  42         done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after
  43         his own processes will be finished.
  44         If nobody disagree with the termination request, every listener will be called by his
  45         XTerminateListener::notifyTermination() method.
  46         </p>
  47
  48         @return
  49             `TRUE` If all listeners agree with this request
  50             <br>
  51             `FALSE` Otherwise
  52
  53         @see XTerminateListener
  54         @see TerminationVetoException
  55      */
  56     boolean terminate();
  57
  58     /** registers an event listener to the desktop, which is called
  59         when the desktop is queried to terminate, and when it really
  60         terminates.
  61
  62         @param Listener
  63             listener for termination events
  64
  65         @see XDesktop::removeTerminateListener()
  66      */
  67     void addTerminateListener( [in] XTerminateListener Listener );
  68
  69     /** unregisters an event listener for termination events.
  70
  71         @param Listener
  72             listener which wishes to be deregistered
  73
  74         @see XDesktop::addTerminateListener()
  75      */
  76     void removeTerminateListener( [in] XTerminateListener Listener );
  77
  78     /** provides read access to collection of all currently loaded components
  79         inside the frame tree
  80
  81         <p>
  82         The component is, by definition, the model of the control which
  83         is loaded into a frame, or if no model exists, into the control
  84         itself.
  85         The service Components which is available from this
  86         method is a collection of all components of the desktop which are open
  87         within a frame of the desktop.
  88         </p>
  89
  90         @returns
  91             the collection of all components
  92
  93         @see Components
  94      */
  95     com::sun::star::container::XEnumerationAccess getComponents();
  96
  97     /** provides read access to the component inside the tree which has the UI focus
  98
  99         <p>
 100         Normally, the component is the model part of the
 101         active component. If no model exists it is the active controller
 102         (view) itself.
 103         </p>
 104
 105         @returns
 106             the component within the desktop environment which has the UI focus.
 107
 108         @see XDesktop::getCurrentFrame()
 109      */
 110     com::sun::star::lang::XComponent getCurrentComponent();
 111
 112     /** provides read access to the frame which contains the current component
 113
 114         @returns
 115             the frame of the component which has the
 116             UI focus within this desktop environment
 117
 118         @see XDesktop::getCurrentComponent()
 119      */
 120     XFrame getCurrentFrame();
 121 };
 122
 123
 124 }; }; }; };
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */