offapi/com/sun/star/frame/XDispatchProviderInterception.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 /** makes it possible to register an XDispatchProvider which
  25     intercepts all requests of XDispatch to this instance.
  26
  27     <p>
  28     Note: Nobody can guarantee order of used interceptor objects if more than ones exist.
  29     Later registered ones will be used at first. But it's possible to increase the chance
  30     for that by providing the optional interface XInterceptorInfo.
  31     </p>
  32
  33     @see XDispatchProvider
  34     @see XDispatch
  35     @see XInterceptorInfo
  36  */
  37 published interface XDispatchProviderInterception: com::sun::star::uno::XInterface
  38 {
  39     /** registers an XDispatchProviderInterceptor, which will become
  40         the first interceptor in the chain of registered interceptors.
  41
  42         @param Interceptor
  43             the interceptor which wishes to be registered
  44
  45         @see XDispatchProviderInterception::releaseDispatchProviderInterceptor()
  46      */
  47     void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
  48
  49     /** removes an XDispatchProviderInterceptor which was previously registered
  50
  51         <p>
  52         The order of removals is arbitrary. It is not necessary to remove the last
  53         registered interceptor first.
  54         </p>
  55
  56         @param Interceptor
  57             the interceptor which wishes to be unregistered
  58
  59         @see XDispatchProviderInterception::registerDispatchProviderInterceptor()
  60      */
  61     void releaseDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
  62 };
  63
  64
  65 }; }; }; };
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */