offapi/com/sun/star/frame/XDispatchProviderInterceptor.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 intercept request of XDispatch.
  25
  26     <p>
  27     Can be registered as an interceptor by using interface XDispatchProviderInterception.
  28     </p>
  29
  30     @see XDispatchProviderInterception
  31  */
  32 published interface XDispatchProviderInterceptor: XDispatchProvider
  33 {
  34     /** access to the slave XDispatchProvider of this interceptor
  35
  36         @returns
  37             the slave of this interceptor
  38
  39         @see XDispatchProviderInterceptor::setSlaveDispatchProvider()
  40      */
  41     XDispatchProvider getSlaveDispatchProvider();
  42
  43     /** sets the slave XDispatchProvider to which calls to
  44         XDispatchProvider::queryDispatch() can be forwarded
  45         under control of this dispatch provider.
  46
  47         @param NewDispatchProvider
  48             the new slave of this interceptor
  49
  50         @see XDispatchProviderInterceptor::getSlaveDispatchProvider()
  51      */
  52     void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider );
  53
  54     /** access to the master XDispatchProvider of this interceptor
  55
  56         @returns
  57             the master of this interceptor
  58
  59         @see XDispatchProviderInterceptor::setMasterDispatchProvider()
  60      */
  61     XDispatchProvider getMasterDispatchProvider();
  62
  63     /** sets the master XDispatchProvider, which may forward
  64         calls to its XDispatchProvider::queryDispatch()
  65         to this dispatch provider.
  66
  67         @param NewSupplier
  68             the master of this interceptor
  69
  70         @see XDispatchProviderInterceptor::getMasterDispatchProvider()
  71      */
  72     void setMasterDispatchProvider( [in] XDispatchProvider NewSupplier );
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */