summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/DispatchResultEvent.idl
blob: cb2d4c5b8cc3ff511c674f5d35bbef1cd9547d28 (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
/* -*- 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 .
 */


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

/** contains the result of the dispatch action, if State is set to SUCCESS

    <p>
    The type of the result is dispatch action dependent. The member State
    can be set to one of the values defined in DispatchResultState.
    If State is set to DispatchResultState::FAILURE, Result may
    specify the reason (or is empty). The type is also dispatch action dependent.
    If State is set to DispatchResultState::DONTKNOW, Result is empty.
    </p>

    @see DispatchResultState
*/
published struct DispatchResultEvent: com::sun::star::lang::EventObject
{
    /** describes state of dispatch
     */
    short State;

    /** describes result for given <var>State</var>
     */
    any Result;
};


}; }; }; };

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