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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_frame_DispatchResultEvent_idl__
  29 #define __com_sun_star_frame_DispatchResultEvent_idl__
  30
  31 #ifndef __com_sun_star_lang_EventObject_idl__
  32 #include <com/sun/star/lang/EventObject.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_util_URL_idl__
  36 #include <com/sun/star/util/URL.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module frame {
  42
  43 //=============================================================================
  44 /** contains the result of the dispatch action, if State is set to SUCCESS
  45
  46     <p>
  47     The type of the result is dispatch action dependend. The member State
  48     can be set to one of the values defined in <type>DispatchResultState</type>.
  49     If State is set to <const>DispatchResultState::FAILURE</const>, Result may
  50     specify the reason (or is empty). The type is also dispatch action dependend.
  51     If State is set to <const>DispatchResultState::DONTKNOW</const>, Result is empty.
  52     </p>
  53
  54     @see DispatchResultState
  55 */
  56 published struct DispatchResultEvent: com::sun::star::lang::EventObject
  57 {
  58     //-------------------------------------------------------------------------
  59     /** describes state of dispatch
  60      */
  61     short State;
  62
  63     //-------------------------------------------------------------------------
  64     /** describes result for given <var>State</var>
  65      */
  66     any Result;
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif