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