Contingut
Índex 🔎︎

# Listening to Document Events

Listening to document events can help in the following situations:

- Identify a new document at opening time, as opposed to existing ones, and perform a dedicated setup.

- Control the processing of document save, document copy, print or mailmerge requests.

- Recalculate table of contents, indexes or table entries of a Writer document when document is going to be closed

- Import math Python packages before opening a Calc document. Release these packages when the document closes.

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.

## Monitoratge dels esdeveniments del document

Monitoring is illustrated herewith for Basic and Python languages using object-oriented programming. Assigning OnLoad script, to the Open Document event, suffices to initiate and terminate document event monitoring. Tools - Customize menu Events tab is used to assign either scripts.

Intercepting events helps setting scripts pre- and post-conditions such as loading and unloading libraries or track script processing in the background. Access2Base.Trace module usage is illustrating that second 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.

OnLoad and OnUnload events can be used to respectively set and unset Python programs path. They are described as Open document and 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):
                 """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 monitoratge d'esdeveniments del document

                 @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.

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.

### Amb el LibreOffice Basic

Using Tools - Customize menu Events tab, the Open document event fires a ConsoleLogger initialisation. _documentEventOccured routine - set by ConsoleLogger - serves as a unique entry point to trap all document events.

#### Mòdul controller.Events

            Option Explicit

            Global _obj As Object ' controller.ConsoleLogger instance

            Sub OnLoad(evt As com.sun.star.document.DocumentEvent)' >> Obre document <<
                _obj = New ConsoleLogger : _obj.StartAdapter(evt)
            End Sub ' controller.OnLoad
            Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
                ''' ConsoleLogger unique entry point '''
                 _obj.DocumentEventOccurs(evt)
            End Sub ' controller._documentEventOccured

#### controller.ConsoleLogger class module

Events monitoring starts from the moment a ConsoleLogger object is instantiated and ultimately stops upon document closure. StartAdapter routine loads necessary Basic libraries, while caught events are reported using Access2Base.Trace module.

              Option Explicit
              Option Compatible
              Option ClassModule

              'Objecte patró de disseny ADAPTER que instanciarà l'esdeveniment "Obre document"
              Private Const UI_PROMPT = True
              Private Const UI_NOPROMPT = False ' Set it to True to visualise documents events

              ' MEMBRES
              Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster
              Private _txtMsg As String ' missatge de text a registrar a la consola

              ' PROPIETATS
              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
              Public Sub DocumentEventOccurs(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" : _StopAdapter(evt)
                  End Select
              End Sub ' controller.ConsoleLogger.DocumentEventOccurs

              Public Sub StartAdapter(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")
                  If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"
                  Access2Base.Trace.TraceLog("INFO", _txtMsg & "Document events are being logged", 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)
                  ''' Finalitza el registre d'esdeveniments del document '''
                  ThisComponent.removeDocumentEventListener( _evtAdapter )
                  If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"
                  Access2Base.Trace.TraceLog("INFO", _txtMsg & "Document events have been logged", UI_PROMPT)
                  Access2Base.Trace.TraceConsole() ' Diàleg amb els esdeveniments capturats
              End Sub ' controller.ConsoleLogger._StopAdapter

              ' ESDEVENIMENTS
              ' El codi per al gestor d'esdeveniments va aquí

Pareu atenció al mètode mal escrit _documentEventOccured, la grafia del qual és heretada de la interfície de programació d'aplicacions (API) del LibreOffice.

## Descobriment dels 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