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

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