Crear un manipulador de diálogos

Contenido

# Creación de un controlador de diálogos

Después de la asignación de macros a eventos o de la creación de escuchas de eventos, se pueden utilizar controladores de diálogo, cuyo principio es definir palabras clave o métodos UNO que se asignarán a eventos a observar. El controlador de eventos es responsable de la ejecución de los métodos mediante el protocolo vnd.sun.star.UNO:<nombre_del_método>. A diferencia de los escuchas, que requieren que se definan todos los métodos compatibles, aunque no se usen, los controladores de diálogos requieren solo dos métodos, además de las previstas secuencias de órdenes de control.

Las ventajas de este método son:

- Empaqueta el código que gestiona las macros orientadas a eventos,

- Rompe la relación entre los eventos y los nombres de las macros, lo que facilita el mantenimiento o las actualizaciones, en particular cuando se mueven las macros o los módulos.

Este mecanismo se ilustra aquí para los lenguajes Basic y Python; se utiliza una copia importada del diálogo Access2Base dlgTrace. El manejo de excepciones y la regionalización se omiten, para mayor claridad.

## Asignación de métodos de Dialog

Exporte el cuadro de diálogo dlgTrace de Access2Base e impórtelo en la biblioteca de aplicación MyLib.

Dentro del panel de propiedades del control del Editor de diálogos, use la pestaña Eventos para remplazar las asignaciones de macros por asignaciones de componentes y escriba los nombres de los métodos propuestos:

- Establezca el nombre del método del componente del botón de diálogo Dump to file en _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

Las acciones asignadas a los eventos deben mencionar el protocolo vnd.sun.star.UNO:.

## Creación del controlador

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.

All component method names must be explicitly declared when using a dialog handler.

### Con Python

En este ejemplo, el cuadro de diálogo se localiza en el equipo.

          # -*- 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):
              """ Manipulador de la consola de Access2Base """
              ''' adaptado de «Créer un dialogue avec gestionnaire d’événements» de J.-M. 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):
                  """ Crear un diálogo desde su ubicación """
                  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,)

Como es esperable, la falta del método onOkHasFocus provoca una excepción.

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

### Con LibreOffice BASIC

En este ejemplo el cuadro de diálogo se ha incrustado en un documento, pero también podría igualmente localizarse en el equipo.

          ' <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)) ' si se trata de un diálogo incrustado en el 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) 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

Como es esperable, la falta del método onOkHasFocus provoca una excepción.

Temas relacionados

Llamar macros en Basic desde Python

Abrir un cuadro de diálogo con Basic

Función CreateUnoListener

Creating Event Listeners

Abrir un cuadro de diálogo con Python

Escucha de eventos de documento

Ejemplos de programación en Python

Ayuda con las macros en Python en LibreOffice