offapi/com/sun/star/frame/XNotifyingDispatch.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: XNotifyingDispatch.idl,v $
  10  * $Revision: 1.5 $
  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_XNotifyingDispatch_idl__
  31 #define __com_sun_star_frame_XNotifyingDispatch_idl__
  32
  33 #ifndef __com_sun_star_frame_XDispatch_idl__
  34 #include <com/sun/star/frame/XDispatch.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XDispatchResultListener_idl__
  38 #include <com/sun/star/frame/XDispatchResultListener.idl>
  39 #endif
  40 //=============================================================================
  41
  42 module com {  module sun {  module star {  module frame {
  43
  44 //=============================================================================
  45 /** dispatch with guaranteed notify (instead of <type>XDispatch</type>)
  46
  47     @see XDispatch
  48     @see XStatusListener
  49  */
  50 published interface XNotifyingDispatch: XDispatch
  51 {
  52     //-------------------------------------------------------------------------
  53     /** Do the same like <member>XDispatch::dispatch()</member> but notifies
  54         listener in every case. Should be used if result must be known.
  55
  56         @param URL
  57             full parsed URL describes the feature which should be dispatched (executed)
  58
  59         @param Arguments
  60             optional arguments for this request
  61             (see <type scope="com::sun::star::document">MediaDescriptor</type>)
  62
  63         @param Listener
  64             optional listener for guaranteed notifications of this request
  65     */
  66     [oneway] void dispatchWithNotification(
  67         [in] com::sun::star::util::URL URL,
  68         [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
  69         [in] XDispatchResultListener Listener);
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif