office-gobmx/udkapi/com/sun/star/script/InterruptEngineEvent.idl
Oliver Bolte f5a5e310ea INTEGRATION: CWS sb18 (1.7.116); FILE MERGED
2004/05/21 15:10:15 sb 1.7.116.1: #i21150# Added published flag.
2004-06-03 15:21:20 +00:00

152 lines
5.5 KiB
Text

/*************************************************************************
*
* $RCSfile: InterruptEngineEvent.idl,v $
*
* $Revision: 1.8 $
*
* last change: $Author: obo $ $Date: 2004-06-03 16:21:20 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_script_InterruptEngineEvent_idl__
#define __com_sun_star_script_InterruptEngineEvent_idl__
#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif
#ifndef __com_sun_star_script_InterruptReason_idl__
#include <com/sun/star/script/InterruptReason.idl>
#endif
//=============================================================================
module com { module sun { module star { module script {
//=============================================================================
/** describes an interrupt which occurs in the scripting engine.
@deprecated
*/
published struct InterruptEngineEvent: com::sun::star::lang::EventObject
{
//-------------------------------------------------------------------------
/** fully qualified name to address the module or function affected by the event that
took place.
<p>If the module or function can't be addressed by name (for example, in case
that a runtime-generated eval-module is executed), this string is empty.</p>
*/
string Name;
//-------------------------------------------------------------------------
/** source code of the Module affected by the event that took place.
<p>If the source can
be accessed using the ModuleName, or if the source is unknown (executing compiled
code), this string can be empty.</p>
*/
string SourceCode;
//-------------------------------------------------------------------------
/** contains the first line in the module's source code that is affected
by the event that took place.
<p>If "name" addresses a function, all line and column values
are nevertheless given relative to the module's source. If
source code is not available, this value addresses a binary
position in the compiled code. </p>
@see XLibraryAccess::getModuleCode
@see XLibraryAccess::getFunctionCode
*/
long StartLine;
//-------------------------------------------------------------------------
/** contains the first column in the "StartLine" that is affected by the
event that took place.
*/
long StartColumn;
//-------------------------------------------------------------------------
/** contains the last line in the module's source code that is affected
by the event that took place.
*/
long EndLine;
//-------------------------------------------------------------------------
/** contains the first column in the "EndLine" which is NOT affected by
the event that took place.
*/
long EndColumn;
//-------------------------------------------------------------------------
/** error message.
<p>Only valid if Reason is RuntimeError or CompileError.</p>
*/
string ErrorMessage;
//-------------------------------------------------------------------------
/** contains the interrupt reason.
*/
com::sun::star::script::InterruptReason Reason;
};
//=============================================================================
}; }; }; };
#endif