Python: Overvåger Dokumenthændelser

Indhold
Indholdsfortegnelse 🔎︎

# Overvåger Dokumenthændelser

Udover at knytte makroer til hændelser kan man overvåge hændelser iværksat af LibreOffice-dokumenter. Applikations programmeringsgrænseflade (API) -sendere står for at kalde hændelses-scripts. I modsætning til listerners, som skal definere alle understøttede metoder, også ubrugte, behøver dokumentmonitorer samt krogede hændelses-scripts kun to metoder.

## Lytning til dokumenthændelser

Overvågning illustreres hermed for sprogene Basic og Python med objektorienteret programmering. Tildeling af skriptet OnLoad til hændelsen Open Document er tilstrækkelig til at begynde og afslutte overvågning af dokumenthændelser. Menuen Funktioner – Tilpas... fanebladet Events bruges til at tildele begge skripts.

Aflytning af hændelser letter indstilling af tilstande før og efter såsom ind- og udlæsning af biblioteker eller udførelse af sporingsskripts i baggrunden. Brug af Access2Base Trace-modulet illustrerer den sidstnævnte kontekst.

### Med Python

Overvågning af hændelser begynder med objektinstantiering og slutter i sidste ende, når Python frigiver objektet. Iværksatte hændelser rapporteres med Access2Base konsolen.

OnLoad- og OnUnload-hændelser kan bruges til henholdsvis at sætte og ophæve Pythons programsti. De er beskrevet som Open document og 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):
                 """ Overvåg dokumenthændelser """
                 '''
                 omformet fra 'Python-script til at overvåge OnSave-hændelse' på
                 https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
                 '''
                 def __init__(self):
                     """ Dokumenthændelses monitor """
                     ''' rapporter med Access2Base.Trace-konsolen ELLER
                     rapporter på Ark 1, første kolonne for Calc-dokumenter '''
                     ctx = uno.getComponentContext()
                     smgr = ctx.getServiceManager()
                     desktop = smgr.createInstanceWithContext(
                     'com.sun.star.frame.Desktop' , ctx)
                     self.doc = desktop.CurrentComponent
                     #self.row = 0  # udkommenter alene for Calc-dokumenter
                     Console.setLevel("DEBUG")
                     self.listen()  # Start overvågning af doc. events

                 @property
                 def Filename(self) -> str:
                     sys_filename = uno.fileUrlToSystemPath(self.doc.URL)
                     return os.path.basename(sys_filename)

                 def setCell(self, calcDoc, txt: str):
                     """ Vis dokumenthændelser i første kolonne af et Calc-regneark """
                     sheet = calcDoc.getSheets().getByIndex(0)
                     sheet.getCellByPosition(0,self.row).setString(txt)
                     self.row = self.row + 1

                 def listen(self, *args):  # OnLoad/OnNew som det tidligste
                     """ Start overvågning af dokumenthændelser """
                     self.doc.addDocumentEventListener(self)
                     Console.log("INFO", "Dokumenthændelser bliver logget", True)

                 def sleep(self, *args):  # OnUnload som det seneste (valgfri)
                     """ Stop overvågning af dokumenthændelser """
                     self.doc.removeDocumentEventListener(self)
                     Console.log("INFO", "Dokumenthændelser er blevet logget", True)

                 def documentEventOccured(self, event: DocumentEvent):
                     """ Overvåger alle dokumenthændelser """
                     #self.setCell(event.Source, event.EventName) # kun for Calc-dokumenter
                     Console.log("DEBUG",
                         event.EventName+" in "+self.Filename,
                         False)

                 def disposing(self, event: EventObject):
                     """ Frigiver alle aktiviteter """
                     self.sleep()
                     Console.show()

             def OnLoad(*args):  # 'Åbn dokument'-hændelse
                 listener = UiDocument()  # Initiates listening

             def OnUnload(*args):  # 'Dokument er blevet lukket'-hændelse
                 pass  # (valgfri) udført ved afslutning

             g_exportedScripts = (OnLoad,)

             from com.sun.star.script.provider import XScript
             class Console():
                 """
                 (Bag-/For-)grundskonsol til rapportering/logning af program.
                 """
                 @staticmethod
                 def trace(*args,**kwargs):
                     """ Skriv liste over fire elementer til konsolen """
                     scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                     scr.invoke((args),(),())
                 @staticmethod
                 def log(level: str, text: str, msgBox=False):
                     """ Tilføj logningsbesked til konsolen, valgfrit bruger-prompt """
                     scr = Console._a2bScript(script='TraceLog')
                     scr.invoke((level,text,msgBox),(),())
                 @staticmethod
                 def setLevel(logLevel: str):
                     """ Sæt nedre grænse for logningbeskeder lower limit """
                     scr = Console._a2bScript(script='TraceLevel')
                     scr.invoke((logLevel,),(),())
                 @staticmethod
                 def show():
                     """ Vis konsolindhold/-dialog """
                     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

Pas på den fejlstavede documentEventOccured-metode, som arver en trykfejl fra LibreOffice API (Applikations programmerings brugerflade)

Hændelserne Start application og Close application kan bruges til henholdvis at sætte og frigive Python-stien til bruger-scripts eller LibreOffice-scripts. På samme måde kan dokumentbaserede Python-biblioteker sættes eller frigives med Open document- og Document closed-hændelser. Find mere information i Importing Python Modules (på engelsk).

### Med LibreOffice Basic

Onload-scriptet knyttes til Open document-hændelsen med Funktioner – Tilpas...-menuens faneblad Hændelser. Overvågning af hændelser begynder, såsnart et ConsoleLogger-objekt bliver instantieret og slutter endeligt, når Basic-motoren frigiver det. En OnLoad-hændelse indlæser de nødvendige Basic-biblioteker, mens opfangede hændelser rapporteres med Access2Base.Trace-modulet.

              REM controller.Events-modul
              Option Explicit
              Private _obj As Object ' controller.ConsoleLogger-forkomst

              Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Åbn dokument <<
                  _obj = New ConsoleLogger : _obj.Start(evt)
              End Sub ' controller.OnLoad
              ' ----
              REM controller.ConsoleLogger klasse-modul
              Option Explicit
              Option Compatible
              Option ClassModule

              ' ADAPTER-designmønster-objekt, der skal instatieres i « Åbn dokument »-hændelsen
              Private Const UI_PROMPT = True
              Private Const UI_NOPROMPT = False ' Set it to True to visualise documents events

              ' CONSTRUCTOR/DESTRUCTOR
              Private Sub Class_Initialize()
              End Sub ' controller.ConsoleLogger.Initialize
              Private Sub Class_Terminate()
              End Sub ' controller.ConsoleLogger.Terminate

              ' MEMBERS
              Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster

              ' PROPERTIES
              Private Property Get FileName As String
                  ''' System-afhængigt filnavn '''
                  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

              ' METODER
              Private Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
                  ''' Overvåg dokumenthændelser '''
                  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)
                  ''' Initialisér logning af dokumenthændelser '''
                  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 & "-") & "Dokumenthændelser bliver logget", _
                      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)
                  ''' Afslut logning af dokumenthændelser '''
                  ThisComponent.removeDocumentEventListener( _evtAdapter )
                  Access2Base.Trace.TraceLog("INFO", _
                      IIf(IsMissing(evt),"",evt.EventName & "-") & "Dokumenthændelser er blevet logget", _
                      UI_PROMPT)
                  Access2Base.Trace.TraceConsole() ' Captured events dialog
              End Sub ' controller.ConsoleLogger._Stop

              ' EVENTS
              ' Din kode til håndterede hændelser skrives her

På på den fejlstavede _documentEventOccured-metode, som arver en trykfejl fra LibreOffice API (Applikations programerings-brugerflade).

## Opdagelse af dokumenthændelser

Senderen API-objekt omfatter listen over de hændelser den er ansvarlig for:

### Med Python

             # -*- coding: utf-8 -*-
             from __future__ import unicode_literals

             import uno, apso_utils as ui

             def displayAvailableEvents():
                 """ Vis dokumenthændelser """
                 '''
                 tilpasset efter DisplayAvailableEvents() af 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,)

Udvidelsen Alternative Python Script Organizer (APSO = Alternativ Python-Script Organisator) bruges til at levere hændelsesinformation på skærmen.

### Med LibreOffice Basic

             Sub DisplayAvailableEvents
                 ''' Vis dokumenthændelser '''
                 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

Relaterede emner

Oprettelse af Hændelses-Aflyttere

Import af Pythonmoduler

Python programmeringseksempler

Programmering med Python-scripts