LibreOffice
LibreOffice 24.2 SDK API Reference
Public Attributes | List of all members
InterruptEngineEvent Struct Referencepublished

describes an interrupt which occurs in the scripting engine. More...

import"InterruptEngineEvent.idl";

Inheritance diagram for InterruptEngineEvent:
EventObject

Public Attributes

string Name
 fully qualified name to address the module or function affected by the event that took place. More...
 
string SourceCode
 source code of the Module affected by the event that took place. More...
 
long StartLine
 contains the first line in the module's source code that is affected by the event that took place. More...
 
long StartColumn
 contains the first column in the "StartLine" that is affected by the event that took place. More...
 
long EndLine
 contains the last line in the module's source code that is affected by the event that took place. More...
 
long EndColumn
 contains the first column in the "EndLine" which is NOT affected by the event that took place. More...
 
string ErrorMessage
 error message. More...
 
com::sun::star::script::InterruptReason Reason
 contains the interrupt reason. More...
 
- Public Attributes inherited from EventObject
com::sun::star::uno::XInterface Source
 refers to the object that fired the event. More...
 

Detailed Description

describes an interrupt which occurs in the scripting engine.

Deprecated:

Member Data Documentation

◆ EndColumn

long EndColumn

contains the first column in the "EndLine" which is NOT affected by the event that took place.

◆ EndLine

long EndLine

contains the last line in the module's source code that is affected by the event that took place.

◆ ErrorMessage

string ErrorMessage

error message.

Only valid if Reason is RuntimeError or CompileError.

◆ Name

string Name

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.

◆ Reason

contains the interrupt reason.

◆ SourceCode

string SourceCode

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.

◆ StartColumn

long StartColumn

contains the first column in the "StartLine" that is affected by the event that took place.

◆ StartLine

long StartLine

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

The documentation for this struct was generated from the following file: