OvervÄking av dokumenthendingar
I tillegg til Ä knytte makroar til hendingar kan ein overvÄke hendingar iverksett frÄ LibreOffice-dokument. API (Application Programming Interface)-sendarane er ansvarlÞege for Ä kalla opp hendings-skript. I motsetning til lyarane som skal definer alle stÞtta metoder, ogsÄ ubrukte, krev dokumentovervÄkarane berre to metodar ved sida av skript for hekta hendingar.
Lytting til dokumenthendingar
OvervÄkinga vert vist her for sprÄka Basic og Python med objektorientert programmering. Tildeling av skriptet OnLoad til hendinga Open Document er nok for Ä byrja og avslutta overvÄkinga. Fana i menyen vert brukt for Ä ta i bruk begge skripta.
Innhenting av hendingar gjer det enklare Ä setja skript fÞr og etter vilkÄra, for eksempel inn- og utlesing av bibliotek eller sporing av skripthandsaming i bakgrunnen. Bruken av modulen Access2Base Trace viser denne sistnemnde samanhengen.
Med Python
OvervÄkinga av hendingar byrjar med opprettinga av objekt og sluttar nÄr Python gjev objektet fri. Hendingar som er registrerte, vert rapporterte ved hjelp av Access2Base -konsollen.
Hendingane OnLoad og OnUnload kan brukast til Ă„ setja og oppheva programstien for Python. Dei er omtalte som Open document og 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):
""" OvervÄk dokumenthendingar """
'''
omforma frÄ «Python-script til Ä overvÄke OnSave-hendingar» pÄ
https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
'''
def __init__(self):
""" OvervÄking av dokumenthendingar """
''' rapporter med Access2Base.Trace-konsollen ELLER
rapporter pÄ Ark 1, fÞrste kolonne for Calc-dokument '''
ctx = uno.getComponentContext()
smgr = ctx.getServiceManager()
desktop = smgr.createInstanceWithContext(
'com.sun.star.frame.Desktop' , ctx)
self.doc = desktop.CurrentComponent
#self.row = 0 # avkommenterer berre for Calc-dokument
Console.setLevel("DEBUG")
self.listen() # Start overvÄking av doc.-hendingar
@property
def Filename(self) -> str:
sys_filename = uno.fileUrlToSystemPath(self.doc.URL)
return os.path.basename(sys_filename)
def setCell(self, calcDoc, txt: str):
""" Vis dokumenthendingar i fĂžrste kolonne i eit Calc-rekneark """
sheet = calcDoc.getSheets().getByIndex(0)
sheet.getCellByPosition(0,self.row).setString(txt)
self.row = self.row + 1
def listen(self, *args): # OnLoad/OnNew fĂžrst
""" Start overvÄking av dokumenthendingar """
self.doc.addDocumentEventListener(self)
Console.log("INFO", "Dokumenthendingar vert logga", True)
def sleep(self, *args): # OnUnload sist (valfri)
""" Stopp overvÄking av dokumenthendingar """
self.doc.removeDocumentEventListener(self)
Console.log("INFO", "Dokumenthendingar vert logga", True)
def documentEventOccured(self, event: DocumentEvent):
""" OvervÄkar alle dokumenthendingar """
#self.setCell(event.Source, event.EventName) # berre for Calc-dokument
Console.log("DEBUG",
event.EventName+" in "+self.Filename,
False)
def disposing(self, event: EventObject):
""" Release all activities """
self.sleep()
Console.show()
def OnLoad(*args): # 'Open Document' event
listener = UiDocument() # Initiates listening
def OnUnload(*args): # 'Document has been closed' event
pass # (optional) performed when disposed
g_exportedScripts = (OnLoad,)
from com.sun.star.script.provider import XScript
class Console():
"""
(Back/Fore)ground console to report/log program execution.
"""
@staticmethod
def trace(*args,**kwargs):
""" Print free item list to console """
scr = Console._a2bScript(script='DebugPrint', module='Compatible')
scr.invoke((args),(),())
@staticmethod
def log(level: str, text: str, msgBox=False):
""" Append log message to console, optional user prompt """
scr = Console._a2bScript(script='TraceLog')
scr.invoke((level,text,msgBox),(),())
@staticmethod
def setLevel(logLevel: str):
""" Set log messages lower limit """
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
Ver merksam pÄ den feilstava documentEventOccured-metoden som arvar ein trykfeil frÄ LibreOffice API (Application Programming Interface, grensesnittet for programmet).
Hendingane Start application og Close application kan brukast for Ä setja og frigjera Python-stien til brukar-skript eller LibreOffice-skript. PÄ same mÄte kan dokumentbaserte Python-bibliotek setjast eller frigjevast med Open document- og Document closed-hÊndelser. Du finn meir om dette pÄ Importing Python Modules.
Med LibreOffice Basic
Onload-skriptet vert knytt til Open document-hendinga med fana i menyen . OvervÄkinga av hendinga byrjar straks eit ConsoleLogger-objekt vert aktivert og vert avslutta nÄr det vert sett fri av Basic-motoren. Ei OnLoad-hendinge lest inn dei nÞdvendige Basic-biblioteka, medan oppfanga hendingar vert rapporterte medAccess2Base.Trace-modulen.
REM controller.Events-modul
Option Explicit
Private _obj As Object ' controller.ConsoleLogger-fĂžrekomst
Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Open Document <<
_obj = New ConsoleLogger : _obj.Start(evt)
End Sub ' controller.OnLoad
' ----
REM controller.ConsoleLogger class module
Option Explicit
Option Compatible
Option ClassModule
' ADAPTER design pattern object to be instantiated in « Open Document » event
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
' Your code for handled events goes here
Mind the misspelled _documentEventOccured method that inherits a typo from LibreOffice Application Programming Interface (API).
Discovering Documents Events
The broadcaster API object provides the list of events it is responsible for:
With Python
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import uno, apso_utils as ui
def displayAvailableEvents():
""" Display document events """
'''
adapted from DisplayAvailableEvents() by 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,)
The Alternative Python Script Organizer (APSO) extension is used to render events information on screen.
With 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