offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
  28 #define __com_sun_star_frame_XDispatchProviderInterceptor_idl__
  29
  30 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  31 #include <com/sun/star/frame/XDispatchProvider.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module frame {
  38
  39 //=============================================================================
  40 /** makes it possible to intercept request of <type>XDispatch</type>.
  41
  42     <p>
  43     Can be registered as an interceptor by using interface <type>XDispatchProviderInterception</type>.
  44     </p>
  45
  46     @see XDispatchProviderInterception
  47  */
  48 published interface XDispatchProviderInterceptor: XDispatchProvider
  49 {
  50     //-------------------------------------------------------------------------
  51     /** access to the slave <type>XDispatchProvider</type> of this interceptor
  52
  53         @returns
  54             the slave of this interceptor
  55
  56         @see XDispatchProviderInterceptor::setSlaveDispatchProvider()
  57      */
  58     XDispatchProvider getSlaveDispatchProvider();
  59
  60     //-------------------------------------------------------------------------
  61     /** sets the slave <type>XDispatchProvider</type> to which calls to
  62         <member>XDispatchProvider::queryDispatch()</member> can be forwarded
  63         under control of this dispatch provider.
  64
  65         @param xNewDispatchProvider
  66             the new slave of this interceptor
  67
  68         @see XDispatchProviderInterceptor::getSlaveDispatchProvider()
  69      */
  70     void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider );
  71
  72     //-------------------------------------------------------------------------
  73     /** access to the master <type>XDispatchProvider</type> of this interceptor
  74
  75         @returns
  76             the master of this interceptor
  77
  78         @see XDispatchProviderInterceptor::setMasterDispatchProvider()
  79      */
  80     XDispatchProvider getMasterDispatchProvider();
  81
  82     //-------------------------------------------------------------------------
  83     /** sets the master <type>XDispatchProvider</type>, which may forward
  84         calls to its <member>XDispatchProvider::queryDispatch()</member>
  85         to this dispatch provider.
  86
  87         @param NewSupplier
  88             the master of this interceptor
  89
  90         @see XDispatchProviderInterceptor::getMasterDispatchProvider()
  91      */
  92     void setMasterDispatchProvider( [in] XDispatchProvider NewSupplier );
  93
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif