Monitorizar eventos em documentos

Além de atribuir macros a eventos, você pode monitorizar eventos criados por documentos do LibreOffice. Os difusores da API (Application Programming Interface) são responsáveis pelas chamadas a macros de eventos. Diferente dos recetores que requerem a definição de todos os métodos suportados, mesmo que não utilizados, a monitorização de documentos requer somente dois métodos além dos scripts de eventos relacionados.

Ouvir eventos de documentos

A monitorização é ilustrada abaixo para as linguagens Basic e Python, utilizando programação orientada por objetos. Atribuir o script OnLoad ao evento OpenDocument é o suficiente para iniciar e terminar a monitorização de eventos do documento. Utilize o separador Eventos do menu Ferramentas - Personalizar, para atribuir ambos os scripts.

Intercetar eventos ajuda a definir pré-condições e pós-condições, tais como carregar e descarregar bibliotecas, ou rastrear o processamento de scripts em segundo plano. O módulo Access2Base Trace ilustra o segundo contexto.

Com Python

A monitorização de eventos começa da instanciação do objeto, e termina quando o Python liberta o objeto. Os eventos criados são reportados ao utilizar a consola do Access2Base.

note

Os eventos OnLoad e OnUnload podem ser utilizados para definir e libertar caminhos dos programas em Python. Eles são descritos como Abrir documento e Documento fechado.



         # -*- 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):
             """ Monitorizar eventos de documento """
             '''
             adaptado de 'Python script to monitor OnSave event' de
             https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
             '''
             def __init__(self):
                 """ Monitorizar eventos de documento """
                 ''' reportar utilizando a consola Access2Base.Trace OU
                 reportar na 1.ª folha, 1.ª coluna para documentos do Calc '''
                 ctx = uno.getComponentContext()
                 smgr = ctx.getServiceManager()
                 desktop = smgr.createInstanceWithContext(
                 'com.sun.star.frame.Desktop' , ctx)
                 self.doc = desktop.CurrentComponent
                 #self.row = 0  # remover comentário apenas em documentos do Calc
                 Console.setLevel("DEBUG")
                 self.listen()  # Começar a monitorizar eventos de documento
             
             @property
             def Filename(self) -> str:
                 sys_filename = uno.fileUrlToSystemPath(self.doc.URL)
                 return os.path.basename(sys_filename)
             
             def setCell(self, calcDoc, txt: str):
                 """ Saída dos eventos de doc. na 1.ª coluna de uma folha Calc """
                 sheet = calcDoc.getSheets().getByIndex(0)
                 sheet.getCellByPosition(0,self.row).setString(txt)
                 self.row = self.row + 1
             
             def listen(self, *args):  # OnLoad/OnNew o mais cedo
                 """ Começar monitorização de eventos de documento """
                 self.doc.addDocumentEventListener(self)
                 Console.log("INFO", "Os eventos de documento estão a ser registados", True)
             
             def sleep(self, *args):  # OnUnload por último (opcional)
                 """ Encerrar monitorização de eventos de documento """
                 self.doc.removeDocumentEventListener(self)
                 Console.log("INFO", "Os eventos de documento foram registados", True)
             
             def documentEventOccured(self, event: DocumentEvent):
                 """ Intercetar todos os eventos de documento """
                 #self.setCell(event.Source, event.EventName) # apenas em documentos do Calc
                 Console.log("DEBUG",
                     event.EventName+" in "+self.Filename,
                     False)
             
             def disposing(self, event: EventObject):
                 """ Libertar todas as atividades """
                 self.sleep()
                 Console.show()
             
         def OnLoad(*args):  # evento 'Abrir documento'
             listener = UiDocument()  # Initiates listening
             
         def OnUnload(*args):  # evento 'Documento foi fechado'
             pass  # (opcional) executado quando dispensado
             
         g_exportedScripts = (OnLoad,)
             
         from com.sun.star.script.provider import XScript
         class Console():
             """
             Consola para trás ou para a frente para reportar/registar execução de programa.
             """
             @staticmethod
             def trace(*args,**kwargs):
                 """ Imprimir lista de itens livre na consola """
                 scr = Console._a2bScript(script='DebugPrint', module='Compatible')
                 scr.invoke((args),(),())
             @staticmethod
             def log(level: str, text: str, msgBox=False):
                 """ Anexar mensagem de registo na consola, pergunta opcional ao utilizador """
                 scr = Console._a2bScript(script='TraceLog')
                 scr.invoke((level,text,msgBox),(),())
             @staticmethod
             def setLevel(logLevel: str):
                 """ Definir limite inferior em mensagens de registo """
                 scr = Console._a2bScript(script='TraceLevel')
                 scr.invoke((logLevel,),(),())
             @staticmethod
             def show():
                 """ Exibir o conteúdo ou diálogo da consola """
                 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
      
warning

Preste atenção ao erro no método documentEventOccured que herda um erro da LibreOffice Application Programming Interface (API).


Ícone da dica

Os eventos Iniciar aplicação e Fechar aplicaçãopodem ser respetivamente utilizados para definir e liberar o caminho Python para scripts de usuários no LibreOffice. De forma similar, bibliotecas e módulos Python em documentos podem ser carregados e libertados utilizando os eventos Abrir documento e Documento fechado. Consulte Importar módulos Python para mais informações.


Com LibreOffice Basic

O script Onload é atribuído ao evento Abrir documento, utilizando u Ferramentas - Personalizar. A monitorização de eventos inicia no momento em que um objeto ConsoleLogger é instanciado, e por último encerra quando o motor do Basic o liberta. O evento OnLoad carrega as bibliotecas Basic necessárias, enquanto que eventos capturados são reportados utilizando o módulo Access2Base.Trace.


          REM Módulo controller.Events
          Option Explicit
          Private _obj As Object ' instância controller.ConsoleLogger
              
          Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Abrir documento <<
              _obj = New ConsoleLogger : _obj.Start(evt)
          End Sub ' controller.OnLoad
          ' ----
          REM Módulo de classe controller.ConsoleLogger
          Option Explicit
          Option Compatible
          Option ClassModule
              
          ' objeto de padrão de design ADAPTER a ser instanciado no evento «Abrir documento»
          Private Const UI_PROMPT = True
          Private Const UI_NOPROMPT = False ' Set it to True to visualise documents events
              
          ' CONSTRUTOR/DESTRUTOR
          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
              ''' Nome de ficheiro dependente do 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
              
          ' METHODS
          Private Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
              ''' Monitorizar eventos de 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)
              ''' Inicializar registo de eventos de 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 & "-") & "Eventos de documento estão a ser registados", _
                  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)
              ''' Terminar registo de eventos de documento '''
              ThisComponent.removeDocumentEventListener( _evtAdapter )
              Access2Base.Trace.TraceLog("INFO", _
                  IIf(IsMissing(evt),"",evt.EventName & "-") & "Eventos de documento foram registados", _
                  UI_PROMPT)
              Access2Base.Trace.TraceConsole() ' Captured events dialog
          End Sub ' controller.ConsoleLogger._Stop
              
          ' EVENTS
          ' O seu código para tratar eventos segue aqui
      
warning

Preste atenção ao erro no método _documentEventOccured que herda um erro ortográfico da LibreOffice Application Programming Interface (API).


Descobrir eventos de documento

O objeto API emissor fornece a lista de eventos dos quais é responsável:

Com Python


         # -*- coding: utf-8 -*-
         from __future__ import unicode_literals
             
         import uno, apso_utils as ui
             
         def displayAvailableEvents():
             """ Exibir eventos de documento """
             '''
             adaptado de DisplayAvailableEvents() por 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,)
      
note

A extensão Alternative Python Script Organizer (APSO) é utilizada para mostrar informações de eventos no ecrã.


Com LibreOffice Basic


         Sub DisplayAvailableEvents
             ''' Exibir eventos de 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
      

Necessitamos da sua ajuda!