offapi/com/sun/star/frame/XSynchronousDispatch.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: XSynchronousDispatch.idl,v $
  10  * $Revision: 1.7 $
  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_XSynchronousDispatch_idl__
  31 #define __com_sun_star_frame_XSynchronousDispatch_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_URL_idl__
  38 #include <com/sun/star/util/URL.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_PropertyValue_idl__
  42 #include <com/sun/star/beans/PropertyValue.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module frame {
  48
  49 //=============================================================================
  50 /** additional interfaces for dispatch objects: allow to execute with return value
  51     @since OOo 2.0.0
  52     @see XDispatch
  53  */
  54 published interface XSynchronousDispatch: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57     /** dispatches a URL synchronously and offers a return values
  58
  59         <p>
  60         After getting a dispatch object as a result of a queryDispatch call, this interface can
  61         be used to dispatch the URL synchronously and with a return value.
  62         </p>
  63
  64         @param URL
  65             full parsed URL wich describe the feature which should be dispatched (executed)
  66
  67         @param Arguments
  68             optional arguments for this request
  69             They depend on the real implementation of the dispatch object.
  70      */
  71      any dispatchWithReturnValue(
  72         [in] com::sun::star::util::URL URL,
  73         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif