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