diff options
author | Michael Hönnig <mi@openoffice.org> | 2000-11-06 11:26:02 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2000-11-06 11:26:02 +0000 |
commit | a9d45660290c8c420e1e2b85c3e8b8f522796202 (patch) | |
tree | 8239b03a233017ef2501159cc23654b91b3506c7 /udkapi/com/sun/star/script/InterruptEngineEvent.idl | |
parent | f29044cdce4c2bc10f2806b2ea86de7bee41f778 (diff) |
moved from api
Diffstat (limited to 'udkapi/com/sun/star/script/InterruptEngineEvent.idl')
-rw-r--r-- | udkapi/com/sun/star/script/InterruptEngineEvent.idl | 197 |
1 files changed, 197 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/script/InterruptEngineEvent.idl b/udkapi/com/sun/star/script/InterruptEngineEvent.idl new file mode 100644 index 000000000..f461d546f --- /dev/null +++ b/udkapi/com/sun/star/script/InterruptEngineEvent.idl @@ -0,0 +1,197 @@ +/************************************************************************* + * + * $RCSfile: InterruptEngineEvent.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 12:21:53 $ + * + * 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 { + +//============================================================================= + +// DocMerge from xml: struct com::sun::star::script::InterruptEngineEvent +/** describes an interrupt which occurs in the scripting engine. + */ +struct InterruptEngineEvent: com::sun::star::lang::EventObject +{ + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR InterruptEngineEvent::Name + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::Name + /** 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; + + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR InterruptEngineEvent::SourceCode + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::SourceCode + /** 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; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::StartLine + /** 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(string) + @see XLibraryAccess::getFunctionCode(string) + */ + long StartLine; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::StartColumn + /** contains the first column in the "StartLine" that is affected by the + event that took place. + */ + long StartColumn; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::EndLine + /** contains the last line in the module's source code that is affected + by the event that took place. + */ + long EndLine; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::EndColumn + /** contains the first column in the "EndLine" which is NOT affected by + the event that took place. + */ + long EndColumn; + + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR InterruptEngineEvent::ErrorMessage + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::ErrorMessage + /** error message. + <p>Only valid if Reason is RuntimeError or CompileError.</p> + + <p>Only valid if Reason is RuntimeError or CompileError.</p> + */ + string ErrorMessage; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::Reason + /** contains the interrupt reason. + */ + com::sun::star::script::InterruptReason Reason; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1 2000/11/03 15:07:34 mi + moved from api module + + Revision 1.1.1.1 2000/09/18 23:35:35 hjs + initial import + + Revision 1.5 2000/09/11 11:52:38 mi + documentation merged from XML + + Revision 1.3 2000/04/20 14:14:35 mm + #74031# better documentation + + Revision 1.2 2000/02/07 11:24:51 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:45 jsc + new + + +=============================================================================*/ +#endif |