Creare un gestore eventi per le finestre di dialogo
Oltre all'assegnazione di macro agli eventi o alla creazione di listener di eventi si possono impiegare gestori di finestre di dialogo, il cui principio consiste nel definire parole chiave UNO, o metodi mappati agli eventi da osservare. Il gestore di eventi è responsabile dell'esecuzione dei metodi tramite il protocollo vnd.sun.star.UNO:<method_name>. A differenza dei listener, che richiedono di definire tutti i metodi supportati, anche se non utilizzati, i gestori di dialogo ne richiedono solo due, oltre agli script degli eventi collegati previsti.
I vantaggi di questo approccio sono i seguenti:
impacchetta il codice per la gestione delle macro controllate da eventi
consente la decorrelazione degli eventi dai nomi delle macro, agevolandone la manutenzione o l'aggiornamento, in particolare nel caso di spostamento delle macro o dei moduli.
Questo meccanismo è illustrato qui di seguito per i linguaggi Basic e Python mediante una copia importata della finestra di dialogo Access2Base dlgTrace. Per chiarezza vengono omesse la gestione e la localizzazione delle eccezioni.
Assegnare metodi di dialogo
Esportate la finestra di dialogo Access2Base dlgTrace e importatela nella libreria delle applicazioni MyLib.
All'interno del pannello delle proprietà dei controlli, nell'editor delle finestre di dialogo, utilizzate la scheda Eventi per sostituire le assegnazioni delle macro con le assegnazioni dei componenti, quindi digitate i nomi dei metodi desiderati:
Impostate a _dump2File il nome del metodo del componente pulsante della finestra di dialogo Dump to file.
Eventualmente potete definire come _openHelp i nomi del metodo dei componenti eventi tasto premuto e pulsante del mouse premuto txtTracelog.
Facoltativamente potete definire come onOkHasfocus il nome del metodo del componente evento di messa a fuoco del pulsante Ok
Gli eventi assegnati alle azioni devono menzionare il protocollo vnd.sun.star.UNO:.
Creare il gestore
Il metodo createDialogWithHandler del servizio com.sun.star.awt.DialogProvider2 viene utilizzato per impostare la finestra di dialogo e il relativo gestore. Il gestore è responsabile dell'implementazione dell'interfaccia com.sun.star.awt.XDialogEventHandler.
Tutti i nomi dei metodi dei componenti devono essere dichiarati esplicitamente se si usa un gestore eventi per le finestre di dialogo.
Con Python
In questo esempio la finestra di dialogo si trova sul computer.
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import uno, unohelper
from com.sun.star.awt import XDialogEventHandler
_DLG_PROVIDER = "com.sun.star.awt.DialogProvider2"
class Console(unohelper.Base, XDialogEventHandler):
""" Gestore console Access2Base """
''' tratto da « Créer un dialogue avec gestionnaire d'événements » di JM Zambon
https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler '''
def show(self):
dialog = self.getDialog("MyLib.dlgTrace", embedded=True)
dialog.Title = "Konsole"
dialog.execute()
def callHandlerMethod(self, dialog, event, method):
if method == '_dump2File':
event.Source.setLabel("dump requested")
scr = getBasicScript(script="_DumpToFile", module="Trace",
library='Access2Base')
scr.invoke((event,), (), ())
elif method == '_openHelp':
_msgbox('Not yet implemented')
dialog.endDialog(1)
else:
return False
def getSupportedMethodNames(self):
return ('_dump2File', '_openHelp')
def getDialog(self, libr_dlg: str, embedded=False):
""" Creare una finestra di dialogo dalla sua posizione """
smgr = XSCRIPTCONTEXT.getComponentContext().ServiceManager
if embedded:
model = XSCRIPTCONTEXT.getDocument()
dp = smgr.createInstanceWithArguments(_DLG_PROVIDER, (model,))
location = "?location=document"
else:
dp = smgr.createInstanceWithContext(_DLG_PROVIDER, ctx)
location = "?location=application"
dlg = dp.createDialogWithHandler("vnd.sun.star.script:"+libr_dlg+location, self)
return dlg
# def getBasicScript() # see note
def _msgbox(prompt='', title=''):
''' Pessimo MsgBox '''
import msgbox
mb = msgbox.MsgBox(uno.getComponentContext())
mb.addButton('Howdy')
mb.show(prompt,0,title)
def ConsoleHandler():
Console().show()
g_exportedScripts = (ConsoleHandler,)
Come previsto, il metodo mancante suOkHasFocus lancia un'eccezione.
Fate riferimento alla pagina Chiamate da script Python a Collabora Office macro Basic per la descrizione della routine getBasicScript e per dettagli sull'esecuzione di scripting in più linguaggi.
Con Collabora Office Basic
In questo esempio la finestra di dialogo è incorporata in un documento e può anche trovarsi sul computer.
' <MyLib>.<Handler> module
Public Sub Console_Show()
Dim dp as Object ' com.sun.star.awt.DialogProvider2
Dim dialog As Object ' com.sun.star.awt.XDialog, com.sun.star.awt.XDialogEventHandler
Dim eventHandler As Object ' com.sun.star.awt.XDialogEventHandler
dp = CreateUnoService("com.sun.star.awt.DialogProvider2")
dp.Initialize(Array(ThisComponent)) ' se finestra di dialogo integrata nel documento
eventHandler = CreateUnoListener("Console_", "com.sun.star.awt.XDialogEventHandler")
dialog = dp.createDialogWithHandler("vnd.sun.star.script:MyLib.dlgTrace?location=document", eventHandler)
dialog.Title = "Konsole"
dialog.execute()
End Sub ' <Handler>.Console_Show()
Private Function Console_callHandlerMethod(dialog as Object, _
event As com.sun.star.document.DocumentEvent, _
method As String) As Boolean
''' Intercept dialog events using .UNO protocol '''
Console_callHandlerMethod = True
Select Case method
Case "_dump2File"
event.Source.setLabel("dump requested")
With GlobalScope.BasicLibraries
If Not .IsLibraryLoaded("Access2Base") Then .LoadLibrary("Access2Base")
End With
Access2Base.Trace._DumpToFile
Case "_openHelp"
MsgBox "Not yet implemented",0 , "Howdy"
'dialog.endDialog(1) se finestra di dialogo basata su computer
Case Else : Console_callHandlerMethod = False
End Select
End Function ' <Handler>.Console_callHandlerMethod
Private Function Console_getSupportedMethodNames()
Console_getSupportedMethodNames = Array("_dump2File", "_openHelp")
End Function ' <Handler>.Console _getSupportedMethodNames
' tratto da « Créer un dialogue avec gestionnaire d'événements » di JM Zambon
' https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler
Come previsto, il metodo mancante suOkHasFocus lancia un'eccezione.