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

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