Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: script ::

deprecated struct InterruptEngineEvent
Base Hierarchy
InterruptEngineEvent
 ┗ ::com::sun::star::lang::EventObject
Usage Restrictions
deprecated
Description
describes an interrupt which occurs in the scripting engine.

Elements' Summary
Name fully qualified name to address the module or function affected by the event that took place.  
SourceCode source code of the Module affected by the event that took place.  
StartLine contains the first line in the module's source code that is affected by the event that took place.  
StartColumn contains the first column in the "StartLine" that is affected by the event that took place.  
EndLine contains the last line in the module's source code that is affected by the event that took place.  
EndColumn contains the first column in the "EndLine" which is NOT affected by the event that took place.  
ErrorMessage error message.  
Reason contains the interrupt reason.  
Elements' Details
Name
string Name;
Description
fully qualified name to address the module or function affected by the event that took place.

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.

SourceCode
string SourceCode;
Description
source code of the Module affected by the event that took place.

If the source can be accessed using the ModuleName, or if the source is unknown (executing compiled code), this string can be empty.

StartLine
long StartLine;
Description
contains the first line in the module's source code that is affected by the event that took place.

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.

See also
XLibraryAccess::getModuleCode, XLibraryAccess::getFunctionCode
StartColumn
long StartColumn;
Description
contains the first column in the "StartLine" that is affected by the event that took place.
EndLine
long EndLine;
Description
contains the last line in the module's source code that is affected by the event that took place.
EndColumn
long EndColumn;
Description
contains the first column in the "EndLine" which is NOT affected by the event that took place.
ErrorMessage
string ErrorMessage;
Description
error message.

Only valid if Reason is RuntimeError or CompileError.

Reason
InterruptReason Reason;
Description
contains the interrupt reason.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.