Ακρόαση συμβάντων εγγράφου

Η ακρόαση συμβάντων εγγράφων μπορεί να βοηθήσει στις ακόλουθες περιπτώσεις:

Εκτός από την ανάθεση μακροεντολών σε συμβάντα, κάποιος μπορεί να παρακολουθήσει τα συμβάντα που εμφανίζονται από τα έγγραφα του Collabora Office. Οι διανομείς Application Programming Interface (API) είναι υπεύθυνοι για την κλήση δεσμών ενεργειών συμβάντων. Αντίθετα με τους ακροατές που απαιτούν καθορισμό όλων των υποστηριζόμενων μεθόδων, ακόμα και εάν δεν χρησιμοποιούνται, η παρακολούθηση εγγράφων απαιτεί μόνο δύο μεθόδους πέρα από τη συνδεμένη δέσμη ενεργειών συμβάντων.

Παρακολούθηση συμβάντων εγγράφων

Η παρακολούθηση απεικονίζεται εδώ για γλώσσες Basic και Python που χρησιμοποιούν αντικειμενοστραφή προγραμματισμό. Η αντιστοίχιση του σεναρίου OnLoad στο συμβάν Open Document, αρκεί για την έναρξη και τον τερματισμό της παρακολούθησης συμβάντων εγγράφου. Στο μενού Εργαλεία - Προσαρμογή η καρτέλα Συμβάντα χρησιμοποιείται για την ανάθεση σεναρίων.

Η παρεμπόδιση συμβάντων βοηθά στη ρύθμιση των σεναρίων προγενεστέρων και μεταγενέστερων συνθηκών, όπως η φόρτωση και η εκφόρτωση βιβλιοθηκών ή η παρακολούθηση της επεξεργασίας σεναρίων στο παρασκήνιο. Η χρήση της ενότητας Access2Base.Trace δείχνει αυτό το δεύτερο πλαίσιο.

Με Python

Η παρακολούθηση συμβάντων ξεκινά από την δημιουργία του αντικειμένου και σταματά τελικά όταν το Python απελευθερώνει το αντικείμενο. Τα προκαλούμενα συμβάντα αναφέρονται χρησιμοποιώντας την κονσόλα Access2Base.

note

Τα συμβάντα OnLoad και OnUnload μπορούν να χρησιμοποιηθούν για τον ορισμό και την απενεργοποίηση της διαδρομής προγραμμάτων Python αντίστοιχα. Περιγράφονται ως Άνοιγμα εγγράφου και Έγγραφο κλειστό.


# -*- 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):
    """ Παρακολούθηση συμβάντων εγγράφου """
    '''
    προσαρμοσμένο από το 'δέσμη ενεργειών Python για παρακολούθηση συμβάντος OnSave' στο
    https://forum.openoffice.org/en/forum/viewtopic.php?t=68887
    '''
    def __init__(self):
        """ Παρακολούθηση συμβάντων εγγράφου """
        ''' αναφορά χρησιμοποιώντας την κονσόλα Access2Base.Trace OR
        αναφορά στο 1ο φύλλο, 1η στήλη για έγγραφα Calc '''
        ctx = uno.getComponentContext()
        smgr = ctx.getServiceManager()
        desktop = smgr.createInstanceWithContext(
        'com.sun.star.frame.Desktop' , ctx)
        self.doc = desktop.CurrentComponent
        #self.row = 0  # κατάργηση σχολιασμού μόνο για έγγραφα Calc
        Console.setLevel("DEBUG")
        self.listen()  # Έναρξη παρακολούθησης συμβάντων του εγγράφου

    @property
    def Filename(self) -> str:
        sys_filename = uno.fileUrlToSystemPath(self.doc.URL)
        return os.path.basename(sys_filename)

    def setCell(self, calcDoc, txt: str):
        """ Έξοδος συμβάντων εγγράφου στην 1η στήλη υπολογιστικού φύλλου Calc """
        sheet = calcDoc.getSheets().getByIndex(0)
        sheet.getCellByPosition(0,self.row).setString(txt)
        self.row = self.row + 1

    def listen(self, *args):  # OnLoad/OnNew το νωρίτερο
        """ Έναρξη παρακολούθησης συμβάντων του εγγράφου """
        self.doc.addDocumentEventListener(self)
        Console.log("INFO", "Τα συμβάντα του εγγράφου καταγράφονται", True)

    def sleep(self, *args):  # OnUnload το αργότερο (προαιρετικό)
        """ Παύση παρακολούθησης συμβάντων του εγγράφου """
        self.doc.removeDocumentEventListener(self)
        Console.log("INFO", "Τα συμβάντα του εγγράφου έχουν καταγραφεί", True)

    def documentEventOccured(self, event: DocumentEvent):
        """ Διακόπτει όλα τα συμβάντα του εγγράφου """
        #self.setCell(event.Source, event.EventName) # μόνο για έγγραφα Calc
        Console.log("DEBUG",
            event.EventName+" in "+self.Filename,
            False)

    def disposing(self, event: EventObject):
        """ Δημοσίευση όλων των δραστηριοτήτων """
        self.sleep()
        Console.show()

def OnLoad(*args):  # Συμβάν 'Open Document'
    listener = UiDocument()  # Αρχικοποιεί την ακρόαση

def OnUnload(*args):  # Συμβάν 'Document has been closed'
    pass  # (προαιρετικό) εκτελείται όταν διατίθεται

g_exportedScripts = (OnLoad,)

from com.sun.star.script.provider import XScript
class Console():
    """
    Κονσόλα (παρα/προ)σκηνίου για αναφορά/καταγραφή εκτέλεσης του προγράμματος.
    """
    @staticmethod
    def trace(*args,**kwargs):
        """ Εκτύπωση ελεύθερου καταλόγου στοιχείων στην κονσόλα """
        scr = Console._a2bScript(script='DebugPrint', module='Compatible')
        scr.invoke((args),(),())
    @staticmethod
    def log(level: str, text: str, msgBox=False):
        """ Προσάρτηση μηνύματος καταγραφής στην κονσόλα, προαιρετική πρόσκληση χρήστη """
        scr = Console._a2bScript(script='TraceLog')
        scr.invoke((level,text,msgBox),(),())
    @staticmethod
    def setLevel(logLevel: str):
        """ Ορισμός κάτω ορίου μηνυμάτων καταγραφής """
        scr = Console._a2bScript(script='TraceLevel')
        scr.invoke((logLevel,),(),())
    @staticmethod
    def show():
        """ Εμφάνιση περιεχομένου/διαλόγου κονσόλας """
        scr = Console._a2bScript(script='TraceConsole')
        scr.invoke((),(),())
    @staticmethod
    def _a2bScript(script: str, library='Access2Base',
        module='Trace') -> XScript:
        "" Λήψη σεναρίου Basic βασισμένου σε εφαρμογή ""
        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

Θυμηθείτε την εσφαλμένη μέθοδο documentEventOccured που κληρονομεί ένα τυπογραφικό λάθος από την Application Programming Interface (API) του Collabora Office.


Εικονίδιο συμβουλής

Τα συμβάντα Έναρξη εφαρμογής και Κλείσιμο εφαρμογής μπορούν αντίστοιχα να χρησιμοποιηθούν για τον ορισμό και την κατάργηση της διαδρομής Python για σενάρια χρήστη ή σενάρια Collabora Office. Με παρόμοιο τρόπο, βιβλιοθήκες ή λειτουργικές μονάδες Python που βασίζονται σε έγγραφα μπορούν να φορτωθούν και να κυκλοφορήσουν χρησιμοποιώντας συμβάντα Άνοιγμα εγγράφου και Έγγραφο κλειστό. Ανατρέξτε στο Εισαγωγή λειτουργικών μονάδων Python για περισσότερες πληροφορίες.


Με Basic του Collabora Office

Χρησιμοποιώντας την καρτέλα Εργαλεία - Προσαρμογή μενού Συμβάντα, το συμβάν Άνοιγμα εγγράφου ενεργοποιεί μια προετοιμασία ConsoleLogger. Η ρουτίνα _documentEventOccured - που ορίζεται από το ConsoleLogger - χρησιμεύει ως μοναδικό σημείο εισόδου για την παγίδευση όλων των συμβάντων του εγγράφου.

controller.Events module

Option Explicit

Global _obj As Object ' στιγμιότυπο controller.ConsoleLogger

Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Open Document <<
    _obj = New ConsoleLogger : _obj.StartAdapter(evt)
End Sub ' controller.OnLoad
Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)
    ''' Μοναδικό σημείο εισόδου ConsoleLogger '''
     _obj.DocumentEventOccurs(evt)
End Sub ' controller._documentEventOccured

λειτουργική μονάδα κλάσης controller.ConsoleLogger

Η παρακολούθηση συμβάντων ξεκινά από τη στιγμή που δημιουργείται ένα αντικείμενο ConsoleLogger και σταματάει τελικά με το κλείσιμο του εγγράφου. Η ρουτίνα StartAdapter φορτώνει τις απαραίτητες βιβλιοθήκες Basic, ενώ τα συμβάντα που συλλαμβάνονται αναφέρονται μέσω της λειτουργικής μονάδας Access2Base.Trace.

Option Explicit
Option Compatible
Option ClassModule

' Αντικείμενο μοτίβου σχεδίασης ADAPTER που πρόκειται να δημιουργηθεί στο συμβάν "Open Document".
Private Const UI_PROMPT = True
Private Const UI_NOPROMPT = False ' Ορίστε το σε True για οπτικοποίηση συμβάντων εγγράφων

'ΜΕΛΗ
Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster
Private _txtMsg As String 'μήνυμα κειμένου για να συνδεθείτε στην κονσόλα

' ΙΔΙΟΤΗΤΕΣ
Private Property Get FileName As String
    ''' Συστημαεξαρτώμενο όνομα αρχείου '''
    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

'ΜΕΘΟΔΟΙ
Public Sub DocumentEventOccurs(evt As com.sun.star.document.DocumentEvent)
    ''' Παρακολούθηση συμβάντων εγγράφου '''
    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)
    ''' Έναρξη εγγράφου καταγραφής συμβάντων '''
    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 & "Τα συμβάντα του εγγράφου συνδέονται", 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)
    ''' Τερματισμός εγγράφου καταγραφής συμβάντων '''
    ThisComponent.removeDocumentEventListener( _evtAdapter )
    If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"
    Access2Base.Trace.TraceLog("INFO", _txtMsg & "Τα συμβάντα εγγράφου έχουν συνδεθεί", UI_PROMPT)
    Access2Base.Trace.TraceConsole() 'Διάλογος των συμβάντων που καταγράφηκαν
End Sub ' controller.ConsoleLogger._StopAdapter

' ΣΥΜΒΑΝΤΑ
' Ο κώδικάς σας για τον χειρισμό συμβάντων πηγαίνει εδώ
warning

Θυμηθείτε την εσφαλμένη μέθοδο _documentEventOccured που κληρονομεί ένα τυπογραφικό λάθος από την Application Programming Interface (API) του Collabora Office.


Ανακάλυψη συμβάντων εγγράφων

Ο διανομέας αντικειμένου API που παρέχει τον κατάλογο συμβάντων είναι υπεύθυνος για:

Με Python

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

import uno, apso_utils as ui

def displayAvailableEvents():
    """ Display document events """
    '''
    προσαρμοσμένο από το DisplayAvailableEvents() του 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

Η επέκταση Alternative Python Script Organizer (APSO) χρησιμοποιείται για να αποδώσει πληροφορίες συμβάντων στην οθόνη.


Με Basic του Collabora Office

Sub DisplayAvailableEvents
    ''' Εμφάνιση συμβάντων εγγράφου '''
    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

Παρακαλούμε, υποστηρίξτε μας!