/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DispatchResultEvent.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:58:42 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_frame_DispatchResultEvent_idl__
#define __com_sun_star_frame_DispatchResultEvent_idl__

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif

#ifndef __com_sun_star_util_URL_idl__
#include <com/sun/star/util/URL.idl>
#endif

//=============================================================================

 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 dependend. The member State
    can be set to one of the values defined in <type>DispatchResultState</type>.
    If State is set to <const>DispatchResultState::FAILURE</const>, Result may
    specify the reason (or is empty). The type is also dispatch action dependend.
    If State is set to <const>DispatchResultState::DONTKNOW</const>, 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;
};

//=============================================================================

}; }; }; };

#endif
