Überwachung von Dokumentereignissen

Neben dem Zuweisen von Makros zu Ereignissen können Ereignisse überwacht werden, die von LibreOffice-Dokumenten ausgelöst werden. API-Sender (Application Programming Interface) sind für den Aufruf von Ereignisskripten verantwortlich. Im Gegensatz zu Empfängern, die alle unterstützten Methoden definieren müssen, benötigen Dokumentmonitore, auch wenn sie nicht verwendet werden, nur zwei Methoden neben verknüpften Ereignisskripten.

Empfangen von Dokumentereignissen

Monitoring is illustrated herewith for Basic and Python languages using object-oriented programming. Assigning OnLoad script, to the Open Document event, suffices to initiate and terminate document event monitoring. Tools - Customize menu Events tab is used to assign either scripts.

Intercepting events helps setting scripts pre- and post-conditions such as loading and unloading libraries or track script processing in the background. Access2Base.Trace module usage is illustrating that second context.

Mit Python

Die Ereignisüberwachung beginnt mit der Instantiierung des Objekts und endet, wenn Python das Objekt wieder freigibt. Ausgelöste Ereignisse werden über die Konsole Access2Base berichtet.

note

OnLoad and OnUnload events can be used to respectively set and unset Python programs path. They are described as Open document and Document closed.



         # -*- coding: utf-8 -*-
         from __future__ import unicode_literals
             
         import os.path, uno, unohelper
         from com.sun.star.document import DocumentEvent, \
             XDocumentEventListener as AdapterPattern
         from com.sun.star.lang import EventObject
             
         class UiDocument(unohelper.Base, AdapterPattern):
             """ Dokumentereignisse überwachen """
             '''
             entsprechend dem 'Python-Skript zum Überwachen von OnSave-Ereignissen' unter
             https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
             '''
             def __init__(self):
                 """ Dokumentereignis-Monitor """
                 ''' Bericht über die Access2Base.Trace-Konsole ODER
                 Bericht in die 1. Spalte der 1. Tabelle eines Calc-Dokuments '''
                 ctx = uno.getComponentContext()
                 smgr = ctx.getServiceManager()
                 desktop = smgr.createInstanceWithContext(
                 'com.sun.star.frame.Desktop' , ctx)
                 self.doc = desktop.CurrentComponent
                 #self.row = 0 # Unkommentiert nur für Calc-Dokumente
                 Console.setLevel("DEBUG")
                 self.listen() # Startet die Überwachung von Dokumentereignissen
             
             @property
             def Filename(self) -> str:
                 sys_filename = uno.fileUrlToSystemPath(self.doc.URL)
                 return os.path.basename(sys_filename)
             
             def setCell(self, calcDoc, txt: str):
                 """ Ausgabe-Dokumentereignisse in der 1. Spalte einer Calc-Tabelle """
                 sheet = calcDoc.getSheets().getByIndex(0)
                 sheet.getCellByPosition(0,self.row).setString(txt)
                 self.row = self.row + 1
             
             def listen(self, *args): # OnLoad/OnNew frühestens
                 """ Startet die Dokument-Ereignisüberwachung """
                 self.doc.addDocumentEventListener(self)
                 Console.log("INFO", "Dokumentereignisse werden protokolliert", True)
             
             def sleep(self, *args): # OnUnload frühestens (optional)
                 """ Stoppt die Dokument-Ereignisüberwachung """
                 self.doc.removeDocumentEventListener(self)
                 Console.log("INFO", "Dokumentereignisse wurden protokolliert", True)
             
             def documentEventOccured(self, event: DocumentEvent):
                 """ Fängt alle Dokumentereignisse ab """
                 #self.setCell(event.Source, event.EventName) # nur für Calc-Dokumente
                 Console.log("DEBUG",
                     event.EventName+" in "+self.Filename,
                     False)
             
             def disposing(self, event: EventObject):
                 """ Alle Aktivitäten freigeben """
                 self.sleep()
                 Console.show()
             
         def OnLoad(*args): # Ereignis 'Dokument öffnen'
             listener = UiDocument()  # Initiates listening
             
         def OnUnload(*args): # Ereignis 'Dokument wurde geschlossen'
             pass # (optional) durchgeführt wenn angeordnet
             
         g_exportedScripts = (OnLoad,)
             
         from com.sun.star.script.provider import XScript
         class Console():
             """
             (Hinter/Vorder)-Grundkonsole zum Melden/Protokollieren der Programmausführung.
             """
             @staticmethod
             def trace(*args,**kwargs):
                 """ Freie Artikelliste auf Konsole ausgeben """
                 scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                 scr.invoke((args),(),())
             @staticmethod
             def log(level: str, text: str, msgBox=False):
                 """ Protokollnachricht an Konsole anhängen, optionale Benutzeraufforderung """
                 scr = Console._a2bScript(script='TraceLog')
                 scr.invoke((level,text,msgBox),(),())
             @staticmethod
             def setLevel(logLevel: str):
                 """ Untere Grenze für Protokollmeldungen festlegen """
                 scr = Console._a2bScript(script='TraceLevel')
                 scr.invoke((logLevel,),(),())
             @staticmethod
             def show():
                 """ Konsoleninhalt/Dialog anzeigen """
                 scr = Console._a2bScript(script='TraceConsole')
                 scr.invoke((),(),())
             @staticmethod
             def _a2bScript(script: str, library='Access2Base',
                 module='Trace') -> XScript:
                 ''' Grab application-based Basic script '''
                 sm = uno.getComponentContext().ServiceManager
                 mspf = sm.createInstanceWithContext(
                     "com.sun.star.script.provider.MasterScriptProviderFactory",
                     uno.getComponentContext())
                 scriptPro = mspf.createScriptProvider("")
                 scriptName = "vnd.sun.star.script:"+library+"."+module+"."+script+"?language=Basic&location=application"
                 xScript = scriptPro.getScript(scriptName)
                 return xScript
      
warning

Beachten Sie die falsch geschriebene Methode documentEventOccured, die einen Tippfehler der LibreOffice API (Application Programming Interface) übernimmt.


Tippsymbol

Start application and Close application events can respectively be used to set and to unset Python path for user scripts or LibreOffice scripts. In a similar fashion, document based Python libraries or modules can be loaded and released using Open document and Document closed events. Refer to Importing Python Modules for more information.


Mit LibreOffice Basic

The Onload script is assigned to Open document event using Tools - Customize menu Events tab. Events monitoring starts from the moment a ConsoleLogger object is instantiated and ultimately stops when Basic engine releases it. OnLoad event loads necessary Basic libraries, while caught events are reported using Access2Base.Trace module.


          REM Modul controller.Events
          Option Explicit
          Private _obj As Object ' Instanz controller.ConsoleLogger
              
          Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Dokument öffnen <<
              _obj = New ConsoleLogger : _obj.Start(evt)
          End Sub ' controller.OnLoad
          ' ----
          REM Klassenmodul controller.ConsoleLogger
          Option Explicit
          Option Compatible
          Option ClassModule
              
          ' ADAPTER-Entwurfsmusterobjekt, das im Ereignis "Dokument öffnen" instanziiert werden soll
          Private Const UI_PROMPT = True
          Private Const UI_NOPROMPT = False ' Set it to True to visualise documents events
              
          ' KONSTRUKTOR/DESTRUKTOR
          Private Sub Class_Initialize()
          End Sub ' controller.ConsoleLogger.Initialize
          Private Sub Class_Terminate()
          End Sub ' controller.ConsoleLogger.Terminate
              
          ' MITGLIEDER
          Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster
              
          ' PROPERTIES
          Private Property Get FileName As String
              ''' Systemabhängiger Dateiname '''
              Const _LIBRARY = "Tools" : With GlobalScope.BasicLibraries
                  If Not .IsLibraryLoaded(_LIBRARY) Then .LoadLibrary(_LIBRARY)
              End With
              Filename = Tools.Strings.FilenameOutofPath(ThisComponent.URL)
          End Property ' controller.ConsoleLogger.Filename
              
          ' METHODEN
          Private Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
              ''' Dokumentereignisse überwachen '''
              Access2Base.Trace.TraceLog("DEBUG", _
                  evt.EventName &" in "& Filename(evt.Source.URL), _
                  UI_NOPROMPT)
              Select Case evt.EventName
                  Case "OnUnload" : _Stop(evt)
              End Select
          End Sub ' controller.ConsoleLogger._documentEventOccured
              
          Private Sub _disposing(evt As com.sun.star.lang.EventObject)
          End Sub ' controller.ConsoleLogger.disposing
              
          Public Sub Start(Optional evt As com.sun.star.document.DocumentEvent)
              ''' Protokollierung von Dokumentereignissen initialisieren '''
              Const _LIBRARY = "Access2Base" : With GlobalScope.BasicLibraries
                  If Not .IsLibraryLoaded(_LIBRARY) Then .LoadLibrary(_LIBRARY)
              End With : Access2Base.Trace.TraceLevel("DEBUG")
              Access2Base.Trace.TraceLog("INFO", _
                  IIf(IsMissing(evt),"",evt.EventName & "-") & "Dokumentereignisse werden protokolliert", _
                  UI_PROMPT)
              
              _evtAdapter = CreateUnoListener( "_", "com.sun.star.document.XDocumentEventListener" )
              ThisComponent.addDocumentEventListener( _evtAdapter )
          End Sub ' controller.ConsoleLogger.Start
              
          Private Sub _Stop(Optional evt As com.sun.star.document.DocumentEvent)
              ''' Protokollierung von Dokumentereignissen beenden '''
              ThisComponent.removeDocumentEventListener( _evtAdapter )
              Access2Base.Trace.TraceLog("INFO", _
                  IIf(IsMissing(evt),"",evt.EventName & "-") & "Dokumentereignisse wurden protokolliert", _
                  UI_PROMPT)
              Access2Base.Trace.TraceConsole() ' Captured events dialog
          End Sub ' controller.ConsoleLogger._Stop
              
          ' EVENTS
          ' Ihren Code für verarbeitete Ereignisse finden Sie hier
      
warning

Beachten Sie die falsch geschriebene Methode _documentEventOccured, die einen Tippfehler der LibreOffice API (Application Programming Interface) übernimmt.


Erkennen von Dokumentenereignissen

Das Broadcaster-API-Objekt enthält die Liste der Ereignisse, für die es verantwortlich ist:

Mit Python


         # -*- coding: utf-8 -*-
         from __future__ import unicode_literals
             
         import uno, apso_utils as ui
             
         def displayAvailableEvents():
             """ Dokumentereignisse anzeigen """
             '''
             Adaptiert von DisplayAvailableEvents() von A. Pitonyak
             https://forum.openoffice.org/en/forum/viewtopic.php?&t=43689
             '''
             ctx = XSCRIPTCONTEXT.getComponentContext()
             smgr = ctx.ServiceManager
             geb = smgr.createInstanceWithContext(
                 "com.sun.star.frame.GlobalEventBroadcaster", ctx)
             events = geb.Events.getElementNames()
             ui.msgbox('; '.join(events))
             
         g_exportedScripts = (displayAvailableEvents,)
      
note

Die Erweiterung Alternative Python Script Organizer (APSO) wird zum Rendern von Ereignisinformationen auf dem Bildschirm verwendet.


Mit LibreOffice Basic


         Sub DisplayAvailableEvents
             ''' Dokumentereignisse anzeigen '''
             Dim geb As Object ' com.sun.star.frame.GlobalEventBroadcaster
             Dim events() As String
             geb = CreateUnoService("com.sun.star.frame.GlobalEventBroadcaster")
             events = geb.Events.ElementNames()
             MsgBox Join(events, "; ")
         End Sub
      

Bitte unterstützen Sie uns!