Python : suivi des événements de document

Contenu
Index 🔎︎

# Suivi des événements de documents

En plus de attribution de macros à des événements , vous pouvez suivre les événements générés par les documents LibreOffice. Les diffuseurs API (Application Programming Interface) sont responsables de l'appel des scripts d'événement. Contrairement aux écouteurs qui nécessitent de définir toutes les méthodes prises en charge, même s'ils ne sont pas utilisés, les analyses de document ne requièrent que deux méthodes à côté des scripts d'événement accrochés.

## Écouter les événements de document

Le suivi est illustré ci-après pour les langages Basic et Python à l'aide de la programmation orientée objet. L'affectation du script OnLoad à l'événement Open Document suffit pour lancer et mettre fin au suivi des événements de document. Le menu Outils - Personnaliser...Événements permet d'assigner les scripts.

L'interception d'événements permet de définir des conditions préalables et ultérieures pour les scripts, telles que le chargement et le déchargement de bibliothèques ou le traitement de scripts en arrière-plan. L'utilisation du module Access2Base Trace illustre ce second contexte.

### Avec Python

Le suivi des événements commence à partir de l'instanciation de l'objet et s'arrête lorsque Python publie l'objet. Les événements déclenchés sont signalés à l'aide de la console Access2Base.

Les événements OnLoad et OnUnload peuvent être utilisés pour définir ou non le chemin des programmes Python. Ils sont décrits comme Open document et 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) :
                 """ Suivre les événements du document """
                 '''
                 adapté de 'Script Python pour suivre l'événement OnSave' à
                 https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
                 '''
                 def __init__(self):
                     """ Suivi des événements du document """
                     ''' rapport utilisant la console Access2Base.Trace OR
                     rapport dans la 1ère feuille, 1ère colonne pour les documents Cacl '''
                     ctx = uno.getComponentContext()
                     smgr = ctx.getServiceManager()
                     desktop = smgr.createInstanceWithContext(
                     'com.sun.star.frame.Desktop' , ctx)
                     self.doc = desktop.CurrentComponent
                     #self.row = 0  # ne pas commenter pour les documents Calc uniqument
                     Console.setLevel("DEBUG")
                     self.listen()  # Commencer à suivre les événements du 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):
                     """ Sortir les événements du document sur la première colonne d'une feuille de calcul Calc """
                     sheet = calcDoc.getSheets().getByIndex(0)
                     sheet.getCellByPosition(0,self.row).setString(txt)
                     self.row = self.row + 1

                 def listen(self, *args):  # OnLoad/OnNew au plus tôt
                     """ Commencer le suivi des événements du document """
                     self.doc.addDocumentEventListener(self)
                     Console.log("INFO", "Les événements du document sont journalisés", True)

                 def sleep(self, *args):  # OnUnload au plus tard (facultatif)
                     """ Arrêter le suivi des événements du document """
                     self.doc.removeDocumentEventListener(self)
                     Console.log("INFO", "Les événements du document ont été journalisés", True)

                 def documentEventOccured(self, event: DocumentEvent):
                     """ Intercepte tous les événements du document """
                     #self.setCell(event.Source, event.EventName) # uniquement pour les documents Calc
                     Console.log("DEBUG",
                         event.EventName+" in "+self.Filename,
                         False)

                 def disposing(self, event: EventObject):
                     """ Publier toutes les activités """
                     self.sleep()
                     Console.show()

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

             def OnUnload(*args):  # évènement "Document has been closed"
                 pass  # (facultatif) effectué lors de la suppression

             g_exportedScripts = (OnLoad,)

             from com.sun.star.script.provider import XScript
             class Console():
                 """
                 Mise en (arrière/avant)-plan de la console pour enregistrer la progression de l'exécution du programme
                 """
                 @staticmethod
                 def trace(*args,**kwargs):
                     """ Imprimer une liste d'items quelconque dans la console """
                     scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                     scr.invoke((args),(),())
                 @staticmethod
                 def log(level: str, text: str, msgBox=False):
                     """ Ajout d'un message de journal à la console, invite utilisateur optionnelle """
                     scr = Console._a2bScript(script='TraceLog')
                     scr.invoke((level,text,msgBox),(),())
                 @staticmethod
                 def setLevel(logLevel: str):
                     """ Définir la limite inférieure des messages du journal """
                     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

Observez la méthode documentEventOccured mal orthographiée qui hérite d’une faute de frappe de l’API LibreOffice.

Les événements Start application et Close application peuvent respectivement être utilisés pour définir et désactiver le chemin Python des scripts utilisateur ou LibreOffice. De la même manière, des bibliothèques ou modules Python basés sur des documents peuvent être chargés et publiés à l'aide des événements Open document et Document closed. Reportez-vous à Import de modules Python pour plus d'informations.

### Avec LibreOffice Basic

Le script Onload est assigné à l'événement Open document en utilisant le menu Outils - Personnaliser... onglet Événement. La surveillance des événements commence à partir du moment où un objet ConsoleLogger est instancié et s’arrête lorsque le moteur de base le libère. L'événement OnLoad charge les bibliothèques de base nécessaires, tandis que les événements capturés sont signalés à l'aide du module Access2Base.Trace.

              REM controller.Events module
              Option Explicit
              Instance Private _obj As Object ' controller.ConsoleLogger

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

              'Objet de modèle de conception ADAPTER à instancier dans l'événement « 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

              ' 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
              ' Votre code pour gérer les événements vient ici

Observez la méthode _documentEventOccured mal orthographiée qui hérite d’une faute de frappe de l’API LibreOffice.

## Découvrir les événements de documents

L'objet API du diffuseur fournit la liste des événements dont il est responsable :

### Avec Python

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

             import uno, apso_utils as ui

             def displayAvailableEvents():
                 """ Display document events """
                 '''
                 adapté de DisplayAvailableEvents() par 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'extension Alternative Python Script Organizer (APSO) est utilisée pour afficher les informations de l'événement à l'écran

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

Rubriques connexes

Creating Event Listeners

Importer des modules Python

Exemples de programmation Python

Programming with Python Scripts