Python : Overvåking av dokumenthendelser

Innhold
Innholdsliste 🔎︎

# Overvåke Dokumenthendelser

Ved siden av tilordne makroer til hendelser , kan man overvåke LibreOffice-dokumenthendelser. Applikasjonsprogrammeringsgrensesnitt (API) kringkastere er ansvarlige for å kalle opp hendelsesskript. I motsetning til lyttere som må ha definert alle støttede metoder, selv om de ikke brukes, krever dokumentovervåkere bare to metoder ved siden av lenkede hendelseskript.

## Lytter til Dokumenthendelser

Overvåking illustreres her for Basic og Python ved hjelp av objektorientert programmering. Å tilordne OnLoad script, til Åpne Dokument hendelsen, er nok til å starte og avslutte dokumentovervåking. Verktøy - Tilpass ... -menyen Hendelser -fanen brukes til å tilordne begge skriptene.

Å avskjære hendelser hjelper deg med å sette skript før og etter forhold, for eksempel å laste inn og laste ned biblioteker eller spore skriptbehandling i bakgrunnen. Access2Base Sporing modulbruk illustrerer den andre konteksten.

### Med Python

Overvåkning av hendelser starter fra objektinstansering og stopper til slutt når Python slipper objektet. Hevede hendelser rapporteres ved å bruke Access2Base konsollen.

OnLoad og OnUnload -hendelser kan benyttes til å angi og deaktivere Python-programbanen. De beskrives som Åpne dokumenter og Dokument lukket .

             # -*- 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

             klasse UiDocument(unohelper.Base, AdapterPattern):
                 ""Overvåk dokumenthendelser""
                 '''
                 tilpasset fra 'Python script for å overvåke OnSave event' ved
                 https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
                 '''
                 def __init__(self):
                     "" "Overvåkning av dokumenthendelser" ""
                     '' 'rapport ved bruk av Access2Base.Sporings-konsoll ELLER
                     rapport i 1. ark, 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   # avkommenter for Calc-dokumenter
                     Console.setLevel("DEBUG")
                     self.listen ()    # Begynn å overvåke dok. hendelser

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

                 def setCell(self, calcDoc, txt: str):
                     """Output doc. Hendelser i første kolonne i 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 tidligst
                     """Start dokument. Overvåkning av hendelser"""
                     self.doc.addDocumentEventListener(self)
                     Console.log ("INFO", "Dokumenthendelser logges", Aktiv)

                 def sleep(self, *args):  # OnUnload at the latest (optional)
                     """ Stop doc. events monitoring """
                     self.doc.removeDocumentEventListener(self)
                     Console.log("INFO", "Document events have been logged", True)

                 def documentEventOccured(self, event: DocumentEvent):
                     """ Intercepts all doc. events """
                     #self.setCell(event.Source, event.EventName) # only for Calc docs
                     Console.log("DEBUG",
                         event.EventName+" in "+self.Filename,
                         False)

                 def disposing(self, event: EventObject):
                     """ Release all activities """
                     self.sleep()
                     Console.show()

             def OnLoad(*args):  # 'Open Document' event
                 listener = UiDocument()  # Initiates listening

             def OnUnload(*args):  # 'Document has been closed' event
                 pass  # (optional) performed when disposed

             g_exportedScripts = (OnLoad,)

             from com.sun.star.script.provider import XScript
             class Console():
                 """
                 (Back/Fore)ground console to report/log program execution.
                 """
                 @staticmethod
                 def trace(*args,**kwargs):
                     """ Print free item list to console """
                     scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                     scr.invoke((args),(),())
                 @staticmethod
                 def log(level: str, text: str, msgBox=False):
                     """ Append log message to console, optional user prompt """
                     scr = Console._a2bScript(script='TraceLog')
                     scr.invoke((level,text,msgBox),(),())
                 @staticmethod
                 def setLevel(logLevel: str):
                     """ Set log messages lower limit """
                     scr = Console._a2bScript(script='TraceLevel')
                     scr.invoke((logLevel,),(),())
                 @staticmethod
                 def show():
                     """ Display console content/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

Mind the misspelled documentEventOccured method that inherits a typo from LibreOffice Application Programming Interface (API).

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.

### With LibreOffice Basic

The Onload script is assigned to Open document event using Tools – Customise... 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 controller.Events module
              Option Explicit
              Private _obj As Object ' controller.ConsoleLogger instance

              Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Open Document <<
                  _obj = New ConsoleLogger : _obj.Start(evt)
              End Sub ' controller.OnLoad
              ' ----
              REM controller.ConsoleLogger class module
              Option Explicit
              Option Compatible
              Option ClassModule

              ' ADAPTER design pattern object to be instantiated in « Open Document » event
              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-dependent filename '''
                  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

              ' METHODS
              Private Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
                  ''' Monitor document events '''
                  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)
                  ''' Initialize document events logging '''
                  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 & "-") & "Document events are being logged", _
                      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)
                  ''' Terminate document events logging '''
                  ThisComponent.removeDocumentEventListener( _evtAdapter )
                  Access2Base.Trace.TraceLog("INFO", _
                      IIf(IsMissing(evt),"",evt.EventName & "-") & "Document events have been logged", _
                      UI_PROMPT)
                  Access2Base.Trace.TraceConsole() ' Captured events dialog
              End Sub ' controller.ConsoleLogger._Stop

              ' EVENTS
              ' Your code for handled events goes here

Mind the misspelled _documentEventOccured method that inherits a typo from LibreOffice Application Programming Interface (API).

## Discovering Documents Events

The broadcaster API object provides the list of events it is responsible for:

### With Python

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

             import uno, apso_utils as ui

             def displayAvailableEvents():
                 """ Display document events """
                 '''
                 adapted from DisplayAvailableEvents() by 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,)

The Alternative Python Script Organizer (APSO) extension is used to render events information on screen.

### With LibreOffice Basic

             Sub DisplayAvailableEvents
                 ''' Display document events '''
                 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

Lignende emner

Creating Event Listeners

Importerer Phyton Moduler

Creating a Dialog Handler

Pythonprogrammering, eksempel

Programmering med Python-skript

Calling Basic Macros from Python