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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_XSynchronousDispatch_idl__
  20 #define __com_sun_star_frame_XSynchronousDispatch_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/util/URL.idl>
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25
  26
  27 module com {  module sun {  module star {  module frame {
  28
  29 /** additional interfaces for dispatch objects: allow to execute with return value
  30     @since OOo 2.0
  31     @see XDispatch
  32  */
  33 published interface XSynchronousDispatch: com::sun::star::uno::XInterface
  34 {
  35     /** dispatches a URL synchronously and offers a return values
  36
  37         <p>
  38         After getting a dispatch object as a result of a queryDispatch call, this interface can
  39         be used to dispatch the URL synchronously and with a return value.
  40         </p>
  41
  42         @param URL
  43             full parsed URL which describe the feature which should be dispatched (executed)
  44
  45         @param Arguments
  46             optional arguments for this request
  47             They depend on the real implementation of the dispatch object.
  48      */
  49      any dispatchWithReturnValue(
  50         [in] com::sun::star::util::URL URL,
  51         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */