summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/XSynchronousDispatch.idl
blob: 48b207bf7b039a31774083f3c960f29e7bcfe7cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#ifndef __com_sun_star_frame_XSynchronousDispatch_idl__
#define __com_sun_star_frame_XSynchronousDispatch_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/util/URL.idl>
#include <com/sun/star/beans/PropertyValue.idl>


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

/** additional interfaces for dispatch objects: allow to execute with return value
    @since OOo 2.0
    @see XDispatch
 */
published interface XSynchronousDispatch: com::sun::star::uno::XInterface
{
    /** dispatches a URL synchronously and offers a return values

        <p>
        After getting a dispatch object as a result of a queryDispatch call, this interface can
        be used to dispatch the URL synchronously and with a return value.
        </p>

        @param URL
            full parsed URL which describe the feature which should be dispatched (executed)

        @param Arguments
            optional arguments for this request
            They depend on the real implementation of the dispatch object.
     */
     any dispatchWithReturnValue(
        [in] com::sun::star::util::URL URL,
        [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */