Aide LibreOffice 7.3
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.
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.
Monitoring is illustrated herewith for Basic and Python languages using object-oriented programming. Assigning OnLoad script, to the event, suffices to initiate and terminate document event monitoring. menu tab is used to assign either 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.
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.
OnLoad and OnUnload events can be used to respectively set and unset Python programs path. They are described as and .
# -*- 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 Calc '''
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():
""" Afficher la boîte de dialogue/Contenu de la 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
Observez la méthode documentEventOccured mal orthographiée qui hérite d’une coquille de l’API LibreOffice.
Importing Python Modules for more information.
and 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 and events. Refer toUsing ConsoleLogger initialisation. _documentEventOccured routine - set by ConsoleLogger - serves as a unique entry point to trap all document events.
menu tab, the event fires a
Option Explicit
Global _obj As Object ' controller.ConsoleLogger instance
Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Ouvrir le 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
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
' 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
' MEMBERS
Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster
Private _txtMsg As String ' text message to log in console
' PROPERTIES
Private Property Get FileName As String
''' Nom du fichier selon la plate-forme '''
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
Public Sub DocumentEventOccurs(evt As com.sun.star.document.DocumentEvent)
''' Surveiller les événements de 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)
''' Initialiser la trace des évènements du 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)
''' Terminer la trace des évènements du 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() ' Captured events dialog
End Sub ' controller.ConsoleLogger._StopAdapter
' 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.
L'objet API du diffuseur fournit la liste des événements dont il est responsable :
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import uno, apso_utils as ui
def displayAvailableEvents():
""" Afficher les événements de document"""
'''
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
Sub DisplayAvailableEvents
''' Afficher les événements de 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