xref: /aoo42x/main/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
#define __com_sun_star_frame_XDispatchProviderInterceptor_idl__

#ifndef __com_sun_star_frame_XDispatchProvider_idl__
#include <com/sun/star/frame/XDispatchProvider.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** makes it possible to intercept request of <type>XDispatch</type>.

    <p>
    Can be registered as an interceptor by using interface <type>XDispatchProviderInterception</type>.
    </p>

    @see XDispatchProviderInterception
 */
published interface XDispatchProviderInterceptor: XDispatchProvider
{
	//-------------------------------------------------------------------------
    /** access to the slave <type>XDispatchProvider</type> of this interceptor

        @returns
            the slave of this interceptor

        @see XDispatchProviderInterceptor::setSlaveDispatchProvider()
	 */
    XDispatchProvider getSlaveDispatchProvider();

	//-------------------------------------------------------------------------
	/** sets the slave <type>XDispatchProvider</type> to which calls to
        <member>XDispatchProvider::queryDispatch()</member> can be forwarded
		under control of this dispatch provider.

        @param xNewDispatchProvider
            the new slave of this interceptor

        @see XDispatchProviderInterceptor::getSlaveDispatchProvider()
	 */
    void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider );

	//-------------------------------------------------------------------------
    /** access to the master <type>XDispatchProvider</type> of this interceptor

        @returns
            the master of this interceptor

        @see XDispatchProviderInterceptor::setMasterDispatchProvider()
	 */
    XDispatchProvider getMasterDispatchProvider();

	//-------------------------------------------------------------------------
	/** sets the master <type>XDispatchProvider</type>, which may forward
        calls to its <member>XDispatchProvider::queryDispatch()</member>
		to this dispatch provider.

        @param NewSupplier
            the master of this interceptor

        @see XDispatchProviderInterceptor::getMasterDispatchProvider()
	 */
    void setMasterDispatchProvider( [in] XDispatchProvider NewSupplier );

};

//=============================================================================

}; }; }; };

#endif