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
  20
  21 module com {  module sun {  module star {  module frame {
  22
  23 /** additional interfaces for dispatch objects: allow to execute with return value
  24     @since OOo 2.0
  25     @see XDispatch
  26  */
  27 published interface XSynchronousDispatch: com::sun::star::uno::XInterface
  28 {
  29     /** dispatches a URL synchronously and offers a return values
  30
  31         <p>
  32         After getting a dispatch object as a result of a queryDispatch call, this interface can
  33         be used to dispatch the URL synchronously and with a return value.
  34         </p>
  35
  36         @param URL
  37             full parsed URL which describe the feature which should be dispatched (executed)
  38
  39         @param Arguments
  40             optional arguments for this request
  41             They depend on the real implementation of the dispatch object.
  42      */
  43      any dispatchWithReturnValue(
  44         [in] com::sun::star::util::URL URL,
  45         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
  46 };
  47
  48
  49 }; }; }; };
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */