offapi/com/sun/star/frame/DispatchProvider.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 module com {  module sun {  module star {  module frame {
  22
  23 /** provides XDispatch objects for certain functions which
  24     are useful at the UI
  25
  26     <p>
  27     Such dispatch objects must be queried explicitly and used for
  28     queried purposes only. They can handle requests with guaranteed
  29     notifications (XNotifyingDispatch) or with possible
  30     (but not guaranteed) notifications (XDispatch).
  31     </p>
  32
  33     @see XNotifyingDispatch
  34     @see XDispatch
  35     @see XControlNotificationListener
  36  */
  37 published service DispatchProvider
  38 {
  39     /** provides handling of dispatches with defined result state
  40
  41         <p>
  42         Base interface of XNotifyingDispatch is XDispatch
  43         and can be called for requests if result isn't necessary for dispatch operation.
  44         </p>
  45
  46         @see XDispatch
  47      */
  48     interface XDispatchProvider;
  49
  50     /** provides dispatch interception
  51
  52         <p>
  53         It makes it possible to register an XDispatchProvider which
  54         intercepts all requests of XDispatch to this instance.
  55         </p>
  56      */
  57     [optional] interface XDispatchProviderInterception;
  58 };
  59
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */