LibreOffice Module wizards (master) 1
Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
scriptforge.SFScriptForge.SF_Exception Class Reference
Inheritance diagram for scriptforge.SFScriptForge.SF_Exception:
[legend]
Collaboration diagram for scriptforge.SFScriptForge.SF_Exception:
[legend]

Public Member Functions

def Console (self, modal=True)
 
def ConsoleClear (self, keep=0)
 
def ConsoleToFile (self, filename)
 
def DebugDisplay (self, *args)
 
def DebugPrint (self, *args)
 
def PythonShell (cls, variables=None)
 
def RaiseFatal (cls, errorcode, *args)
 
- Public Member Functions inherited from scriptforge.SFServices
def __init__ (self, reference=-1, objtype=None, classmodule=0, name='')
 
def __getattr__ (self, name)
 
def __setattr__ (self, name, value)
 
def __repr__ (self)
 
def Dispose (self)
 
def ExecMethod (self, flags=0, methodname='', *args)
 
def GetProperty (self, propertyname, arg=None)
 
def Properties (self)
 
def basicmethods (self)
 
def basicproperties (self)
 
def SetProperty (self, propertyname, value)
 
- Public Member Functions inherited from scriptforge._Singleton
def __call__ (cls, *args, **kwargs)
 

Static Public Attributes

string serviceimplementation = 'basic'
 
string servicename = 'ScriptForge.Exception'
 
tuple servicesynonyms = ('exception', 'scriptforge.exception')
 
 serviceproperties = dict()
 
- Static Public Attributes inherited from scriptforge.SFServices
 vbGet
 
 vbLet
 
 vbMethod
 
 vbSet
 
int flgPost = 32
 
int flgDateArg = 64
 
int flgDateRet = 128
 
int flgArrayArg = 512
 
int flgArrayRet = 1024
 
int flgUno = 256
 
int flgObject = 2048
 
int flgHardCode = 4096
 
 moduleClass
 
 moduleStandard
 
bool forceGetProperty = False
 
dictionary propertysynonyms = {}
 
tuple internal_attributes
 
 SIMPLEEXEC = ScriptForge.InvokeSimpleScript
 
 EXEC = ScriptForge.InvokeBasicService
 
- Static Public Attributes inherited from scriptforge._Singleton
dictionary instances = {}
 

Private Member Functions

def _RaiseFatal (cls, sub, subargs, errorcode, *args)
 

Additional Inherited Members

- Public Attributes inherited from scriptforge.SFServices
 objectreference
 
 objecttype
 
 classmodule
 
 name
 
 internal
 
 localProperties
 
 serviceimplementation
 

Detailed Description

    The Exception service is a collection of methods for code debugging and error handling.

    The Exception service console stores events, variable values and information about errors.
    Use the console when the Python shell is not available, for example in Calc user defined functions (UDF)
    or during events processing.
    Use DebugPrint() method to aggregate additional user data of any type.

    Console entries can be dumped to a text file or visualized in a dialogue.

Definition at line 977 of file scriptforge.py.

Member Function Documentation

◆ _RaiseFatal()

def scriptforge.SFScriptForge.SF_Exception._RaiseFatal (   cls,
  sub,
  subargs,
  errorcode,
args 
)
private
    Wrapper of RaiseFatal(). Includes method and syntax of the failed Python routine
    to simulate the exact behaviour of the Basic RaiseFatal() method
    For INTERNAL USE only

Definition at line 1065 of file scriptforge.py.

References scriptforge.SFScriptForge.SF_Exception.RaiseFatal().

Referenced by scriptforge.SFScriptForge.SF_Exception.PythonShell().

◆ Console()

def scriptforge.SFScriptForge.SF_Exception.Console (   self,
  modal = True 
)

◆ ConsoleClear()

def scriptforge.SFScriptForge.SF_Exception.ConsoleClear (   self,
  keep = 0 
)

◆ ConsoleToFile()

def scriptforge.SFScriptForge.SF_Exception.ConsoleToFile (   self,
  filename 
)

◆ DebugDisplay()

def scriptforge.SFScriptForge.SF_Exception.DebugDisplay (   self,
args 
)

◆ DebugPrint()

def scriptforge.SFScriptForge.SF_Exception.DebugPrint (   self,
args 
)

◆ PythonShell()

def scriptforge.SFScriptForge.SF_Exception.PythonShell (   cls,
  variables = None 
)
    Open an APSO python shell window - Thanks to its authors Hanya/Tsutomu Uchino/Hubert Lambert
    :param variables: Typical use
                            PythonShell.({**globals(), **locals()})
                      to push the global and local dictionaries to the shell window

Definition at line 1019 of file scriptforge.py.

References scriptforge.SFScriptForge.SF_Exception._RaiseFatal().

◆ RaiseFatal()

def scriptforge.SFScriptForge.SF_Exception.RaiseFatal (   cls,
  errorcode,
args 
)
    Generate a run-time error caused by an anomaly in a user script detected by ScriptForge
    The message is logged in the console. The execution is STOPPED
    For INTERNAL USE only

Definition at line 1053 of file scriptforge.py.

References scriptforge.SFServices.SIMPLEEXEC.

Referenced by scriptforge.SFScriptForge.SF_Exception._RaiseFatal().

Member Data Documentation

◆ serviceimplementation

string scriptforge.SFScriptForge.SF_Exception.serviceimplementation = 'basic'
static

◆ servicename

string scriptforge.SFScriptForge.SF_Exception.servicename = 'ScriptForge.Exception'
static

◆ serviceproperties

scriptforge.SFScriptForge.SF_Exception.serviceproperties = dict()
static

◆ servicesynonyms

tuple scriptforge.SFScriptForge.SF_Exception.servicesynonyms = ('exception', 'scriptforge.exception')
static

Definition at line 991 of file scriptforge.py.


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