Tworzenie okna dialogowego z modułem obsługi

Spis treści
Indeks 🔎︎

# Creating a Dialog Handler

Next to assigning macros to events or creating event listeners, one can use dialog handlers, whose principle is to define UNO keywords, or methods, that are mapped to events to watch for. The event handler is responsible for executing methods using the vnd.sun.star.UNO:<method_name> protocol. Unlike listeners that require to define all supported methods, even if unused, dialog handlers require only two methods on top of intended control hook scripts.

Zalety tego podejścia to:

- Grupuje kod zawierający makra sterowane zdarzeniami,

- dekoreluje zdarzenia z nazw makr, co ułatwia konserwację lub aktualizacje, w szczególności podczas przenoszenia makr lub modułów.

Ten mechanizm jest tutaj zilustrowany dla języków Basic i Python przy użyciu zaimportowanej kopii okna dialogowego Access2Base dlgTrace. Dla przejrzystości pominięto obsługę wyjątków i lokalizację.

## Przypisywanie metod okna dialogowego

Wyeksportuj okno dialogowe Access2Base dlgTrace i zaimportuj je do biblioteki aplikacji MyLib.

Inside the control properties pane of the Dialog Editor, use the Events tab to replace macro assignments by component assignments, and type in the intended method names:

- Ustaw nazwę metody komponentu przycisku Zrzuć do pliku na _dump2File.

- Opcjonalnie zdefiniuj nazwy metod komponentów, takie jak _openHelp dla Text Tracelog zdarzeń naciśnięcia klawisza i przycisku myszy.

- Opcjonalnie zdefiniuj nazwę metody komponentu zdarzenia Ok jako onOkHasfocus

Akcje przypisane do zdarzeń powinny zawierać protokół vnd.sun.star.UNO:.

## Tworzenie procedury obsługi

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.

Wszystkie nazwy metod komponentów muszą być jawnie zadeklarowane podczas korzystania z procedury obsługi okna dialogowego.

### Za pomocą języka Python

W tym przykładzie okno dialogowe znajduje się na komputerze.

          # -*- 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):
              """ Procedura obsługa konsoli Access2Base """
              ''' przystosowano z « Créer un dialogue avec gestionnaire d'événements » autorstwa JM Zambona
              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):
                  """ Twórz okno dialogowe z podanej lokalizacji """
                  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=''):
              ''' Brzydkie MsgBox '''
              import msgbox
              mb = msgbox.MsgBox(uno.getComponentContext())
              mb.addButton('Howdy')
              mb.show(prompt,0,title)

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

          g_exportedScripts = (ConsoleHandler,)

Zgodnie z oczekiwaniami brakująca metoda onOkHasFocus zgłasza wyjątek.

Refer to Python calls to LibreOffice Basic page for getBasicScript routine description and for details about cross-language scripting execution.

### Za pomocą języka LibreOffice Basic

W tym przykładzie okno dialogowe jest osadzone w dokumencie i równie dobrze może znajdować się na komputerze.

          ' <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)) ' jeśli okno dialogowe osadzone w dokumencie
              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) jako typ logiczny
              ''' 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) jeśli jest to okno dialogowe na komputerze
                  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

          ' przystosowano z « Créer un dialogue avec gestionnaire d'événements » autorstwa JM Zambona
          ' https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler

Zgodnie z oczekiwaniami brakująca metoda onOkHasFocus zgłasza wyjątek.

Tematy pokrewne

Wywoływanie makr Basic z Pythona

Otwieranie okna dialogowego za pomocą Basic

CreateUnoListener Function

Creating Event Listeners

Opening a Dialog with Python

Listening to Document Events

Python programming examples

Pomoc skryptów Pythona LibreOffice