offapi/com/sun/star/frame/DispatchResultEvent.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 #ifndef __com_sun_star_frame_DispatchResultEvent_idl__
  21 #define __com_sun_star_frame_DispatchResultEvent_idl__
  22
  23 #include <com/sun/star/lang/EventObject.idl>
  24 #include <com/sun/star/util/URL.idl>
  25
  26
  27  module com {  module sun {  module star {  module frame {
  28
  29 /** contains the result of the dispatch action, if State is set to SUCCESS
  30
  31     <p>
  32     The type of the result is dispatch action dependent. The member State
  33     can be set to one of the values defined in DispatchResultState.
  34     If State is set to DispatchResultState::FAILURE, Result may
  35     specify the reason (or is empty). The type is also dispatch action dependent.
  36     If State is set to DispatchResultState::DONTKNOW, Result is empty.
  37     </p>
  38
  39     @see DispatchResultState
  40 */
  41 published struct DispatchResultEvent: com::sun::star::lang::EventObject
  42 {
  43     /** describes state of dispatch
  44      */
  45     short State;
  46
  47     /** describes result for given <var>State</var>
  48      */
  49     any Result;
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */