Einen Dialog-Handler erstellen

Neben Zuweisen von Makros zu Ereignissen oder Erstellen von Ereignis-Listenern können Sie Dialog-Handler verwenden, deren Prinzip darin besteht, UNO-Schlüsselwörter oder -Methoden zu definieren, die Ereignissen zugeordnet sind, auf die geachtet werden soll. Die Ereignisbehandlungsroutine ist für die Ausführung von Methoden unter Verwendung des Protokolls vnd.sun.star.UNO: <method_name> verantwortlich. Im Gegensatz zu Listenern, die alle unterstützten Methoden definieren müssen, benötigen Dialog-Handler nur zwei Methoden zusätzlich zu den beabsichtigten Kontroll-Hook-Skripten.

Die Vorteile dieses Ansatzes sind:

• Es packt den Code, der Ereignis-gesteuerte Makros verarbeitet,

• es dekorreliert Ereignisse von Makronamen, was die Wartung oder Aktualisierung erleichtert, insbesondere beim Verschieben von Makros oder Modulen.

Dieser Mechanismus wird hiermit für Basic- und Python-Sprachen anhand einer importierten Kopie des Dialogs Access2Base dlgTrace veranschaulicht. Ausnahmebehandlung und Lokalisierung sind aus Gründen der Übersichtlichkeit weggelassen.

Zuweisen von Dialogmethoden

Exportiert den Dialog Access2Base dlgTrace und importiert ihn in die Anwendungsbibliothek MyLib.

Verwenden Sie im Bereich der Steuerelement-Eigenschaften des Dialogeditors das Register Ereignisse, um Makrozuweisungen durch Komponentenzuweisungen zu ersetzen, und geben Sie den vorgesehenen Methodennamen ein:

• Setzt den Methodennamen der Dialogschaltflächenkomponente Dump to file auf _dump2File

• Optionally define txtTracelog key pressed and mouse button pressed events component method names as _openHelp

• Optionally define Ok button receiving focus event component method name as onOkHasfocus

Ereignisse, denen Aktionen zugeordnet sind, sollten das Protokoll vnd.sun.star.UNO: erwähnen.

Handler erstellen

createDialogWithHandler method of com.sun.star.awt.DialogProvider2 service is used to set the dialog and its handler. The handler is responsible for implementing com.sun.star.awt.XDialogEventHandler interface.

Bei Verwendung eines Dialog-Handlers müssen alle Komponentenmethodennamen explizit deklariert werden.

Mit Python

Bei diesem Beispiel befindet sich der Dialog auf dem 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):
    """ Access2Base Console Handler """
    ''' adaptiert von « Créer un dialogue avec gestionnaire d'événements » von 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):
        """ Einen Dialog von seinem Standort aus erstellen """
        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=''):
    ''' Ugly MsgBox '''
    import msgbox
    mb = msgbox.MsgBox(uno.getComponentContext())
    mb.addButton('Howdy')
    mb.show(prompt,0,title)

def ConsoleHandler():
    Console().show()

g_exportedScripts = (ConsoleHandler,)

Wie erwartet, löst die fehlende Methode onOkHasFocus eine Ausnahme aus.

Siehe Python-Aufrufe an Collabora Office Basic für die Routinenbeschreibung getBasicScript und Details zur sprachübergreifenden Skriptausführung.

Mit Collabora Office Basic

In diesem Beispiel ist der Dialog in ein Dokument eingebettet und kann sich ebenfalls auf dem Computer befinden.

' <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)) ' if doc-embedded dialog
    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) if computer-based dialog
        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

' adapted from « Créer un dialogue avec gestionnaire d'événements » by JM Zambon
' https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler

As expected, onOkHasFocus missing method throws an exception.