Python : monitoraggio degli eventi del documento

Contenuto
Indice 🔎︎

# Monitoraggio degli eventi del documento

Accanto all'assegnazione di macro agli eventi, un utente può monitorare gli eventi generati dai documenti LibreOffice. Le emittenti API (Application Programming Interface) sono responsabili delle chiamate degli script degli eventi. A differenza dei listener, che richiedono di definire tutti i metodi supportati, anche se non utilizzati, i monitor degli eventi richiedono solo due metodi accanto agli script degli eventi collegati.

## Ascolto degli eventi del documento

Il monitoraggio viene qui illustrato per i linguaggi Basic e Python che utilizzano la programmazione orientata agli oggetti (OOP). Assegnazione dello script OnLoad, all'evento Open Document, è sufficiente per iniziare e terminare il monitoraggio degli eventi del document. La scheda Eventi del menu Strumenti – Personalizza viene utilizzata per assegnare uno qualunque degli script.

L'intercettazione degli eventi aiuta a impostare le pre- e post-condizioni degli script, come il caricamento o il rilascio di librerie o la tracciatura in sottofondo dell'elaborazione degli script. L'uso del modulo Access2Base.Trace illustra questo secondo contesto.

### Con Python

Il monitoraggio degli eventi parte dall'istanziazione dell'oggetto e si ferma quando Python lo pubblica. Gli eventi generati vengono riportati utilizzando la console Access2Base.

Gli eventi OnLoad e OnUnload si possono utilizzare rispettivamente per impostare e de-impostare il percorso dei programmi Python. Essi sono descritti come Open document e 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):
                 """ Monitora gli eventi del documento """
                 '''
                 adattato da 'Python script to monitor OnSave event' in
                 https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
                 '''
                 def __init__(self):
                     """ Monitor degli eventi del documento """
                     ''' rapporto utilizzando la console Access2Base.Trace OR
                     rapporto nel 1° foglio, 1^ colonna per i documenti Calc '''
                     ctx = uno.getComponentContext()
                     smgr = ctx.getServiceManager()
                     desktop = smgr.createInstanceWithContext(
                     'com.sun.star.frame.Desktop' , ctx)
                     self.doc = desktop.CurrentComponent
                     #self.row = 0  # decommenta solo per i documenti Calc
                     Console.setLevel("DEBUG")
                     self.listen()  # Avvia il monitoraggio degli eventi dei doc.

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

                 def setCell(self, calcDoc, txt: str):
                     """ Mostra il risultato degli eventi dei doc. sulla 1^ colonna di un foglio elettronico Calc """
                     sheet = calcDoc.getSheets().getByIndex(0)
                     sheet.getCellByPosition(0,self.row).setString(txt)
                     self.row = self.row + 1

                 def listen(self, *args):  # OnLoad/OnNew al più presto
                     """ Avvia il monitoraggio degli eventi del doc. """
                     self.doc.addDocumentEventListener(self)
                     Console.log("INFO", "Si stanno registrando gli eventi del documento", True)

                 def sleep(self, *args): # OnUnload al più tardi (opzionale)
                     """ Ferma il monitoraggio degli eventi del doc. """
                     self.doc.removeDocumentEventListener(self)
                     Console.log("INFO", "Gli eventi del documento sono stati registrati", True)

                 def documentEventOccured(self, event: DocumentEvent):
                     """ Intercetta tutti gli eventi del doc. """
                     #self.setCell(event.Source, event.EventName) # solo per i documenti Calc
                     Console.log("DEBUG",
                         event.EventName+" in "+self.Filename,
                         False)

                 def disposing(self, event: EventObject):
                     """ Pubblica tutte le attività """
                     self.sleep()
                     Console.show()

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

             def OnUnload(*args):  # Evento 'Document has been closed'
                 pass  # (facoltativo) eseguito durante la cancellazione

             g_exportedScripts = (OnLoad,)

             from com.sun.star.script.provider import XScript
             class Console():
                 """
                 Console in primo/secondo piano per riportare/registrare l'esecuzione del programma.
                 """
                 @staticmethod
                 def trace(*args,**kwargs):
                     """ Stampa elenco degli elementi liberi nella console """
                     scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                     scr.invoke((args),(),())
                 @staticmethod
                 def log(level: str, text: str, msgBox=False):
                     """ Allega messaggio di registro alla console, richiesta utente facoltativa """
                     scr = Console._a2bScript(script='TraceLog')
                     scr.invoke((level,text,msgBox),(),())
                 @staticmethod
                 def setLevel(logLevel: str):
                     """ Imposta limite inferiore per messaggi registro """
                     scr = Console._a2bScript(script='TraceLevel')
                     scr.invoke((logLevel,),(),())
                 @staticmethod
                 def show():
                     """ Mostra finestra di dialogo/contenuto console """
                     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

Tenete presente il metodo documentEventOccured ortograficamente errato che eredita un errore dall'API (Application Programming Interface) di LibreOffice.

Gli eventi Start application e Close applicationsi possono utilizzare rispettivamente per impostare e de-impostare il percorso Python per gli script degli utenti o di LibreOffice. In modo simile, le librerie o i moduli di Python basate su documenti possono essere caricate e pubblicate utilizzando gli eventi Open document e Document closed. Per ulteriori informazioni, consultate Importazione di moduli Python.

### Con LibreOffice Basic

Lo script Onload viene assegnato all'evento Open document utilizzando la scheda Eventi nel menu Strumenti – Personalizza. Il monitoraggio degli eventi inizia dal momento in cui un oggetto ConsoleLogger viene istanziato e si ferma quando il motore Basic lo pubblica. L'evento OnLoad carica le librerie Basic necessarie, mentre gli eventi catturati sono registrati utilizzando il modulo Access2Base.Trace.

              REM Modulo controller.Events
              Option Explicit
              Istanza Private _obj As Object ' controller.ConsoleLogger

              Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Apri documento <<
                  _obj = New ConsoleLogger : _obj.Start(evt)
              End Sub ' controller.OnLoad
              ' ----
              REM Modulo di classe controller.ConsoleLogger
              Option Explicit
              Option Compatible
              Option ClassModule

              ' oggetto del modello di progettazione ADAPTER da istanziarsi nell'evento "Open Document"
              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

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

              ' PROPERTIES
              Private Property Get FileName As String
                  ''' Nome file dipendente dal sistema '''
                  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

              ' METODI
              Private Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
                  ''' Monitora gli eventi del documento '''
                  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)
                  ''' Inizializza il registro degli eventi del documento '''
                  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 & "-") & "Si stanno registrando gli eventi del documento", _
                      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)
                  ''' Termina la registrazione degli eventi del documento '''
                  ThisComponent.removeDocumentEventListener( _evtAdapter )
                  Access2Base.Trace.TraceLog("INFO", _
                      IIf(IsMissing(evt),"",evt.EventName & "-") & "Gli eventi del documento sono stati registrati", _
                      UI_PROMPT)
                  Access2Base.Trace.TraceConsole() ' Captured events dialog
              End Sub ' controller.ConsoleLogger._Stop

              ' EVENTS
              ' Il vostro codice per gli eventi gestiti va qui

Tenete presente il metodo _documentEventOccured ortograficamente errato che eredita un errore dall'API (Application Programming Interface) di LibreOffice.

## Scoperta degli eventi del documento

L'oggetto API emittente fornisce l'elenco degli eventi di cui è responsabile:

### Con Python

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

             import uno, apso_utils as ui

             def displayAvailableEvents():
                 """ Mostra gli eventi del documento """
                 '''
                 adattato da DisplayAvailableEvents() di 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,)

L'estensione Alternative Python Script Organizer (APSO) viene utilizzata per restituire le informazioni degli eventi sullo schermo.

### Con LibreOffice Basic

             Sub DisplayAvailableEvents
                 ''' Mostra gli eventi del documento '''
                 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

Argomenti correlati

Creazione di listener di eventi

Importazione dei moduli Python

D'oh! You found a bug (text/sbasic/python/python_handler.xhp#pythonhandler_h1 not found).

Esempi di programmazione in Python

Programmare con script Python

Richiamare macro Basic da Python