Създаване на обработчик на диалог

Освен присвояването на макроси на събития и създаването на слушатели за събития, може да се използват и обработчици на диалози, които работят чрез дефиниране на ключови думи или методи на UNO, съпоставени на следените събития. Обработчикът на диалог отговаря за изпълнението на методи чрез протокола vnd.sun.star.UNO:<method_name>. За разлика от слушателите, при които се изисква дефиниране на всички поддържани методи, дори да не се използват, обработчиците на диалози изискват само два метода извън желаните скриптове, свързани със събития на контроли.

Предимствата на този подход са следните:

• Той прави по-компактен кода, който обработва управляваните от събития макроси.

• Той прави ненужно съответствието между събития и имена на макроси, улеснявайки поддръжката и актуализациите, особено когато трябва да се преместват макроси или модули.

Този механизъм е показан тук за езиците Basic и Python чрез импортирано копие на диалога dlgTrace на Access2Base. За яснота са пропуснати обработката на изключения и локализацията.

Присвояване на методи към диалози

Експортирайте диалога на Access2Base dlgTrace и го импортирайте в приложната библиотека MyLib.

В панела за свойства на контроли на редактора на диалози използвайте раздела „Събития“, за да замените присвояването на макроси с присвояване на компоненти и въведете желаните имена на методи:

• Задайте _dump2File като име на метод за компонента на бутона Dump to file.

• По желание дефинирайте имената на компонентни методи за събитията натиснат клавиш и натиснат бутон на мишката на txtTracelog като _openHelp.

• По желание задайте името на компонентния метод за събитието получаване на фокуса на бутона Ok като onOkHasfocus.

За събитията, на които са присвоени действия, трябва да е посочен протоколът vnd.sun.star.UNO:.

Създаване на обработчика

За задаване на диалога и обработчика му се използва методът createDialogWithHandler на услугата com.sun.star.awt.DialogProvider2. Обработчикът отговаря за реализирането на интерфейса com.sun.star.awt.XDialogEventHandler.

При използване на обработчик на диалог всички имена на компонентни методи трябва да са декларирани явно.

С Python

В този пример диалогът се намира в компютъра.

# -*- 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 """
    ''' адаптиран от « Créer un dialogue avec gestionnaire d'événements » от 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):
        """ Създаваме диалог по местоположението му """
        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=''):
    ''' Грозен MsgBox '''
    import msgbox
    mb = msgbox.MsgBox(uno.getComponentContext())
    mb.addButton('Howdy')
    mb.show(prompt,0,title)

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

g_exportedScripts = (ConsoleHandler,)

Както се очаква, липсващият метод onOkHasFocus предизвиква изключение.

Вижте страницата Обръщения от Python към Collabora Office Basic за описание на подпрограмата getBasicScript и подробности относно многоезичното изпълнение на скриптове.

С Collabora Office Basic

В този пример диалогът е вграден в документ, но може да се намира и в компютъра.

' <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)) ' ако диалогът е вграден в документ
    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) ако диалогът е базиран на компютъра
        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

' адаптирано от « Créer un dialogue avec gestionnaire d'événements » от JM Zambon
' https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler

Както се очаква, липсващият метод onOkHasFocus предизвиква изключение.