Python: monitoratge d'esdeveniments dels documents

Contingut
Índex 🔎︎

# Monitoratge d'esdeveniments dels documents

Al costat de assignar macros als esdeveniments, es poden monitoritzar els esdeveniments llençats pels documents LibreOffice. Els emissors de la interfície de programació d'aplicacions (API) són responsables de cridar als scripts dels esdeveniments. A diferència dels oients que requereixen definir tots els mètodes suportats, encara que no s'utilitzin, els monitors de documents només requereixen dos mètodes junt amb els scripts dels esdeveniments connectats.

## Escolta els esdeveniments del document

El monitoratge s'il·lustra amb els llenguatges Basic i Python utilitzant la programació orientada a objectes. Assignant l'script OnLoad a l'esdeveniment Obrir document és suficient per iniciar i finalitzar el monitoratge d'esdeveniments del document. La pestanya Esdeveniments del menú Menú - personalitza... s'utilitza per assignar qualsevol dels scripts.

Interceptar esdeveniments ajuda a establir pre i post condicions als scripts, com ara carregar i descarregar llibreries o fer un seguiment pel processament de scripts en segon pla. L'ús del mòdul Traça access2Base s'il·lustra en aquest segon context.

### Amb el Python

El monitoratge d'esdeveniments comença des de la instanciació de l'objecte i finalment s'atura quan Python allibera l'objecte. Els informes dels esdeveniments es llencen utilitzant la consola d'Access2Base.

Els esdeveniments OnLoad i OnUnload es poden utilitzar per establir i desestablir la ruta dels programes Python. Es descriuen com Obre un document i S'ha tancat el document.

             # -*- 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):
                 """Monitoritza esdeveniments de documents"""
                 '''
                 adaptat de l'script 'Python per monitoritzar l'esdeveniment OnSave' a
                 https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
                 '''
                 def __init__(self):
                     """Monitor d’esdeveniments de documents"""
                     '''informa usant la consola Access2Base.Trace o
                     informa al 1r full, 1a columna per a documents del Calc'''
                     ctx = uno.getComponentContext()
                     smgr = ctx.getServiceManager()
                     desktop = smgr.createInstanceWithContext(
                     'com.sun.star.frame.Desktop' , ctx)
                     self.doc = desktop.CurrentComponent
                     #self.row = 0 # descomentar només pels documents del Calc
                     Console.setLevel("DEBUG")
                     auto.listen() # Inicia el monitoreig d'esdeveniments de documents.

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

                 def setCell(self, calcDoc, txt: str):
                     """Sortida dels esdeveniments del document a la primera columna d'un full de càlcul"""
                     sheet = calcDoc.getSheets().getByIndex(0)
                     sheet.getCellByPosition(0,self.row).setString(txt)
                     self.row = self.row + 1

                 def listen(self, *args):  # OnLoad/OnNew la primera vegada
                     """Inicia el seguiment d'esdeveniments del document """
                     self.doc.addDocumentEventListener(self)
                     Console.log("INFO" "Els esdeveniments del document s'estan registrant", True)

                 def sleep(self *args) # OnUnload la darrera (opcional)
                     """Atura el seguiment dels esdeveniments del document"""
                     self.doc.removeDocumentEventListener(self)
                     Console.log("INFO" "Els esdeveniments del document s'han registrat", True)

                 def documentEventOccured(self, event: DocumentEvent):
                     """Intercepta tots els esdeveniments del document""
                     #self.setCell(event.Source event.EventName) # només per a documents del Calc
                     Console.log("DEBUG",
                         event.EventName+" in "+self.Filename,
                         False)

                 def disposing(self, event: EventObject):
                     """Allibera totes les activitats"""
                     self.sleep()
                     Console.show()

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

             def OnUnload(*args) # Esdeveniment 'El document s'ha tancat'
                 pass # (opcional) realitzat durant la supressió

             g_exportedScripts = (OnLoad,)

             from com.sun.star.script.provider import XScript
             class Console():
                 """
                 Consola (Fons/Primer pla) per informar/registrar l'execució de programes.
                 """
                 @staticmethod
                 def trace(*args,**kwargs):
                     """ Imprimeix la llista d'elements lliures a la consola """
                     scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                     scr.invoke((args),(),())
                 @staticmethod
                 def log(level: str, text: str, msgBox=False):
                     """ Afegeix el missatge de registre a la consola, sol·licitud d'usuari opcional """
                     scr = Console._a2bScript(script='TraceLog')
                     scr.invoke((level,text,msgBox),(),())
                 @staticmethod
                 def setLevel(logLevel: str):
                     """ Estableix el límit inferior per als missatges de registre ""
                     scr = Console._a2bScript(script='TraceLevel')
                     scr.invoke((logLevel,),(),())
                 @staticmethod
                 def show():
                     """ Mostra el contingut de la consola/diàleg ""
                     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

Observeu l'error que hi ha al mètode documentEventOccured, que ha heretat una falta d'ortografia de la interfície de programació d'aplicacions (API, segles en anglès) del LibreOffice.

Els esdeveniments Inicia l'aplicació i Tanca l'aplicació es poden utilitzar per activar i desactivar el camí de Python cap als scripts d'usuari o els scripts del LibreOffice. De manera similar, els documents basats en llibreries o mòduls Pythones poden carregar i alliberar utilitzant els events Obre un document i Tanca un document. Consulteu Importar mòduls Python per a més informació.

### Amb el LibreOffice Basic

L0script Onload s'assigna a l'esdeveniment Obre un document mitjançant el menú Eines – Personalitza... pestanya Esdeveniments.El monitoratge dels esdeveniments s'inicia en el moment en que s'instàncua l'objecte ConsoleLogger i finalitzas quan el motor de Basic l'allibera. L'esdeveniment OnLoad carrega les llibreries necessàries de Basic, mentre els esdeveniments capturats es reporten mitjançant el mòdul Access2Base.Trace.

              REM Mòdul controller.Events
              Option Explicit
              Private _obj As Object ' instància de controller.ConsoleLogger

              Sub OnLoad(evt As com.sun.star.document.DocumentEvent)' >> Obre document <<
                  _obj = New ConsoleLogger : _obj.Start(evt)
              End Sub ' controller.OnLoad
              ' ----
              REM controller.ConsoleLogger mòdul de classe
              Option Explicit
              Option Compatible
              Option ClassModule

              ' Objecte del model de disseny ADAPTER que s'instanciarà a l'esdeveniment "Obre un 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

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

              ' PROPERTIES
              Private Property Get FileName As String
                  ''' nom de fitxer depenent del 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

              ' MÈTODES
              Private Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
                  ''' Monitorització dels esdeveniments del document '''
                  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)
                  ''' Inicialitza el registre d'esdeveniments del document '''
                  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 "-")  & "Els esdeveniments del document estan sent registrats"
                      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)
                  ''' Finalitza el registre d'esdeveniments del document '''
                  ThisComponent.removeDocumentEventListener( _evtAdapter )
                  Access2Base.Trace.TraceLog("INFO", _
                      IIf(IsMissing(evt),"",evt.EventName & "-") & "Els esdeveniments del document s'han registrat"
                      UI_PROMPT)
                  Access2Base.Trace.TraceConsole() ' Captured events dialog
              End Sub ' controller.ConsoleLogger._Stop

              ' EVENTS
              ' El codi pel gestor d'esdeveniments va aquí

Tingueu en compte el mètode _documentEventOccuredmal escri, que hereta un error tipogràfic de l'API LibreOffice.

## S'estan descobrint els esdeveniments del document

L'API de l'objecte locutor proporciona la llista d'esdeveniments dels quals és responsable:

### Amb Python

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

             import uno, apso_utils as ui

             def displayAvailableEvents():
                 """ Mostra els esdeveniments del document """
                 '''
                 adaptat de DisplayAvailableEvents() per 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'extensió Organitzador de l'script Python alternatiu (OSPA) s'utilitza per renderitzar informació dels esdeveniments sobre la pantalla

### Amb el LibreOffice Basic

             Sub DisplayAvailableEvents
                 ''' Mostra els esdeveniments del document '''
                 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

Temes relacionats

Crea oients d'esdeveniments

Importació de mòduls Python

Crea un controlador de diàleg

Exemples de programació en Python

Programació amb scripts en Python

Crida a macros bàsiques des de Python