Dokumentereignisse überwachen
Die Überwachung von Dokumentereignissen kann in folgenden Situationen hilfreich sein:
-
Identifiziert ein neues Dokument zum Zeitpunkt des Öffnens, im Gegensatz zu existierenden, und führt eine entsprechende Konfiguration durch.
-
Steuern Sie die Verarbeitung von Dokumentenspeicher-, Dokumentkopier-, Druck- oder Seriendruckanforderungen.
-
Aktualisiert das Inhaltsverzeichnisses, die Indexe oder die Tabelleneinträge eines Writer-Dokuments, wenn das Dokument geschlossen werden soll
-
Importiert mathematische Python-Pakete vor dem Öffnen eines Calc-Dokuments. Gibt diese Pakete frei, wenn das Dokument geschlossen wird.
Neben dem Zuweisen von Makros zu Ereignissen können Ereignisse überwacht werden, die von Collabora Office-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.
Überwachung von Dokumentenereignissen
Die Überwachung wird für Basic- und Python-Sprachen unter Verwendung objektorientierter Programmierung veranschaulicht. Das Zuweisen des Skripts OnLoad zum Ereignis reicht aus, um die Dokumentereignis-Überwachung zu beginnen und zu beenden. Wählen Sie Register: , um Skripte zuzuweisen.
Das Abfangen von Ereignissen erleichtert das Festlegen von Skripten vor und nach dem Laden und Entladen von Bibliotheken oder das Verfolgen der Skriptverarbeitung im Hintergrund. Die Verwendung des Moduls Access2Base Trace veranschaulicht diesen zweiten Kontext.
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.
Die Ereignisse OnLoad und OnUnload können verwendet werden, um den Python-Programmpfad festzulegen beziehungsweise aufzuheben. Sie werden als und bezeichnet.
# -*- 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 spätestens (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() # Beginnt die Überwachung
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:
''' Anwendungsbasiertes Basic-Skript abrufen '''
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
Beachten Sie die falsch geschriebene Methode documentEventOccured, die einen Tippfehler der Collabora Office API (Application Programming Interface) übernimmt.
Mit den Ereignissen und können Sie den Python-Pfad für Benutzerskripte oder Collabora Office-Skripte festlegen und deaktivieren. In ähnlicher Weise können dokumentbasierte Python-Bibliotheken oder -Module mit den Ereignissen und geladen und freigegeben werden. Weitere Informationen finden Sie unter Importieren von Python-Modulen.
Mit Collabora Office Basic
Bei der Verwendung des Menüs – Register: startet das Ereignis die Initialisierung von ConsoleLogger. Die Routine _documentEventOccured – festgelegt von ConsoleLogger – dient als eindeutiger Einstiegspunkt, um alle Dokumentereignisse abzufangen.
Modul controller.Events
Option Explicit
Global _obj As Object ' Instanz controller.ConsoleLogger
Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Dokument öffnen <<
_obj = New ConsoleLogger : _obj.StartAdapter(evt)
End Sub ' controller.OnLoad
Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
''' Eindeutiger Einstiegspunkt für ConsoleLogger '''
_obj.DocumentEventOccurs(evt)
End Sub ' controller._documentEventOccured
Klassenmodul controller.ConsoleLogger
Die Überwachung von Ereignissen beginnt in dem Moment, in dem ein Objekt ConsoleLogger erzeugt wird, und endet schließlich mit dem Schließen des Dokuments. Die Routine StartAdapter lädt die benötigten Basic-Bibliotheken, während abgefangene Ereignisse mithilfe des Moduls Access2Base.Trace angezeigt werden.
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 ' Legen Sie es auf "True" fest, um Dokumentereignisse anzuzeigen
' MITGLIEDER
Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster
Private _txtMsg As String ' Textnachricht zum Aufzeichnen in der Konsole
' EIGENSCHAFTEN
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
Public Sub DocumentEventOccurs(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" : _StopAdapter(evt)
End Select
End Sub ' controller.ConsoleLogger.DocumentEventOccurs
Public Sub StartAdapter(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")
If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"
Access2Base.Trace.TraceLog("INFO", _txtMsg & "Dokumentereignisse werden protokolliert", UI_PROMPT)
_evtAdapter = CreateUnoListener( "_", "com.sun.star.document.XDocumentEventListener" )
ThisComponent.addDocumentEventListener( _evtAdapter )
End Sub ' controller.ConsoleLogger.StartAdapter
Private Sub _StopAdapter(Optional evt As com.sun.star.document.DocumentEvent)
''' Protokollierung von Dokumentereignissen beenden '''
ThisComponent.removeDocumentEventListener( _evtAdapter )
If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"
Access2Base.Trace.TraceLog("INFO", _txtMsg & "Dokumentereignisse wurden protokolliert", UI_PROMPT)
Access2Base.Trace.TraceConsole() ' Dialog „Erfasste Ereignisse“
End Sub ' controller.ConsoleLogger._StopAdapter
' EREIGNISSE
' Ihren Code für verarbeitete Ereignisse finden Sie hier
Beachten Sie die falsch geschriebene Methode _documentEventOccured, die einen Tippfehler der Collabora Office 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,)
Die Erweiterung Alternative Python Script Organizer (APSO) wird zum Rendern von Ereignisinformationen auf dem Bildschirm verwendet.
Mit Collabora Office 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