<!DOCTYPE html>
<html lang="es" dir="ltr">
<head>
<base href="../../../../">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Crear un manipulador de diálogos</title>
<link rel="shortcut icon" href="media/navigation/favicon.ico">
<link type="text/css" href="normalize.css" rel="Stylesheet">
<link type="text/css" href="prism.css" rel="Stylesheet">
<link type="text/css" href="default.css" rel="Stylesheet">
<script type="text/javascript" src="polyfills.js"></script><script type="text/javascript" src="languages.js"></script><script type="text/javascript" src="es/langnames.js"></script><script type="text/javascript" src="flexsearch.debug.js"></script><script type="text/javascript" src="prism.js"></script><script type="text/javascript" src="help2.js" defer></script><script type="text/javascript" src="a11y-toggle.js" defer></script><script type="text/javascript" src="paginathing.js" defer></script><script type="text/javascript" src="es/bookmarks.js" defer></script><script type="text/javascript" src="es/contents.js" defer></script><script type="text/javascript" src="help.js" defer></script><meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<header id="TopLeftHeader"><a class="symbol" href="es/text/shared/05/new_help.html"><div></div></a><a class="logo" href="es/text/shared/05/new_help.html"><p dir="auto">Ayuda de LibreOffice 25.2</p></a><div class="dropdowns"><div class="modules">
<button type="button" data-a11y-toggle="modules-nav" id="modules" aria-haspopup="true" aria-expanded="false" aria-controls="modules-nav">Módulo</button><nav id="modules-nav" hidden=""></nav>
</div></div></header><aside class="leftside"><input id="accordion-1" name="accordion-menu" type="checkbox"><label for="accordion-1" dir="auto">Contenido</label><div id="Contents" class="contents-treeview"></div></aside><div id="SearchFrame"><div id="Bookmarks">
<input id="search-bar" type="search" class="search" placeholder="Buscar en los marcadores del módulo elegido" dir="auto"><div class="nav-container" tabindex="0"><nav class="index" dir="auto"></nav></div>
</div></div>
<div id="DisplayArea" itemprop="softwareHelp" itemscope="true" itemtype="http://schema.org/SoftwareApplication">
<noscript><div id="WarnJS"><h1 dir="auto">Active JavaScript en el navegador para mostrar las páginas de ayuda de LibreOffice.</h1></div></noscript>
<a id="N0664"></a> <meta itemprop="keywords" content="Basic,Controlador de diálogos"> <meta itemprop="keywords" content="Python,Controlador de diálogos"> <meta itemprop="keywords" content="Access2Base, dlgTrace"> <meta itemprop="keywords" content="Access2Base,_DumpToFile"> <meta itemprop="keywords" content="API,DialogProvider2"> <meta itemprop="keywords" content="API,XDialogEventHandler">
<a id="bm_id66701251"></a>
<h1 id="N0665" dir="auto">
<a id="pythonhandler_h1"></a>Creación de un controlador de diálogos</h1>
<p id="N0666" class="paragraph" dir="auto">Después de la <a target="_top" href="es/text/sbasic/shared/01040000.html">asignación de macros a eventos</a> o de la <a target="_top" href="es/html">creación de escuchas de eventos</a>, 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 <span class="literal">vnd.sun.star.UNO:<nombre_del_método></span>. 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.</p>
<p id="N0667" class="paragraph" dir="auto">Las ventajas de este método son:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto"><p id="N0668" class="listitem" dir="auto">Empaqueta el código que gestiona las macros orientadas a eventos,</p></li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto"><p id="N0669" class="listitem" dir="auto">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.</p></li>
</ul>
<p id="N0670" class="paragraph" dir="auto">Este mecanismo se ilustra aquí para los lenguajes Basic y Python; se utiliza una copia importada del diálogo <span class="literal">Access2Base</span> <span class="literal">dlgTrace</span>. El manejo de excepciones y la regionalización se omiten, para mayor claridad.</p>
<h2 id="N0671" dir="auto">Asignación de métodos de Dialog</h2>
<p id="N0672" class="paragraph" dir="auto">Exporte el cuadro de diálogo <span class="literal">dlgTrace</span> de <span class="literal">Access2Base</span> e impórtelo en la biblioteca de aplicación <span class="literal">MyLib</span>.</p>
<p id="N0673" class="paragraph" dir="auto">Dentro del panel de propiedades del control del <a target="_top" href="es/text/sbasic/guide/create_dialog.html">Editor de diálogos</a>, use la pestaña Eventos para remplazar las asignaciones de macros por asignaciones de componentes y escriba los nombres de los métodos propuestos:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto"><p id="N0674" class="listitem" dir="auto">Establezca el nombre del método del componente del botón de diálogo <span class="literal">Dump to file</span> en <span class="literal">_dump2File</span></p></li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto"><p id="N0675" class="listitem" dir="auto">Optionally define <span class="literal">txtTracelog</span> key pressed and mouse button pressed events component method names as <span class="literal">_openHelp</span></p></li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto"><p id="N0676" class="listitem" dir="auto">Optionally define <span class="literal">Ok</span> button receiving focus event component method name as <span class="literal">onOkHasfocus</span></p></li>
</ul>
<p id="N0677" class="paragraph" dir="auto">Las acciones asignadas a los eventos deben mencionar el protocolo <span class="literal">vnd.sun.star.UNO:</span>.</p>
<h2 id="N0678" dir="auto">Creación del controlador</h2>
<p id="N0679" class="paragraph" dir="auto"><span class="literal">createDialogWithHandler</span> method of <a target="_blank" href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1DialogProvider2.html">com.sun.star.awt.DialogProvider2</a> service is used to set the dialog and its handler. The handler is responsible for implementing <a target="_blank" href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XDialogEventHandler.html">com.sun.star.awt.XDialogEventHandler</a> interface.</p>
<div class="warning">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/warning.svg" alt="warning" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0680" dir="auto">All component method names must be explicitly declared when using a dialog handler.</p></div>
</div>
<br>
<h3 id="N0681" dir="auto">Con Python</h3>
<p id="N0682" class="paragraph" dir="auto">En este ejemplo, el cuadro de diálogo se localiza en el equipo.</p>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
# -*- 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,)
</code></pre></div>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0740" dir="auto">Como es esperable, la falta del método <span class="literal">onOkHasFocus</span> provoca una excepción.</p></div>
</div>
<br>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0741" dir="auto">Refer to <a target="_top" href="es/text/sbasic/python/python_2_basic.html">Python calls to LibreOffice Basic</a> page for <span class="literal">getBasicScript</span> routine description and for details about cross-language scripting execution.</p></div>
</div>
<br>
<h3 id="N0742" dir="auto">Con LibreOffice BASIC</h3>
<p id="N0743" class="paragraph" dir="auto">En este ejemplo el cuadro de diálogo se ha incrustado en un documento, pero también podría igualmente localizarse en el equipo.</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
' <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
</code></pre></div>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0781" dir="auto">Como es esperable, la falta del método <span class="literal">onOkHasFocus</span> provoca una excepción.</p></div>
</div>
<br>
<a id="relatedtopics"></a><div class="relatedtopics">
<p class="related" itemprop="mentions" dir="auto"><a id="related"></a><span class="emph">Temas relacionados</span></p>
<div class="relatedbody" itemprop="mentions">
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_2_basic.html">Llamar macros en Basic desde Python</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/guide/show_dialog.html">Abrir un cuadro de diálogo con Basic</a></p></div>
<p id="N0505" class="paragraph" dir="auto"><a target="_top" href="es/text/sbasic/shared/03132000.html">Función CreateUnoListener</a></p>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_listener.html">Creating Event Listeners</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_dialogs.html">Abrir un cuadro de diálogo con Python</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_document_events.html">Escucha de eventos de documento</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_examples.html">Ejemplos de programación en Python</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/main0000.html">Ayuda con las macros en Python en LibreOffice</a></p></div>
</div>
</div>
</div>
<div id="DonationFrame"></div>
<footer><h2 style="text-align: center;"><a href="https://books.libreoffice.org" target="_blank">Libros de LibreOffice</a></h2>
<div class="noteicon" dir="auto" style="display:flex;justify-content:center;flex-wrap:wrap;row-gap:15px;">
<img src="media/navigation/libo-writer.svg" alt="Writer Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-calc.svg" alt="Calc Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-impress.svg" alt="Impress Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-draw.svg" alt="Draw Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-base.svg" alt="Base Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-math.svg" alt="Math Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-symbol-black.svg" alt="Getting Started Icon" style="width:60px;height:60px;">
</div>
<div id="DEBUG" class="debug">
<h3 class="bug">Help content debug info:</h3>
<p dir="auto">This page is: <a href="https://opengrok.libreoffice.org/xref/help/source/text/sbasic/python/python_handler.xhp" target="_blank">/text/sbasic/python/python_handler.xhp</a></p>
<p dir="auto">Title is: Crear un manipulador de diálogos</p>
<p id="bm_module" dir="auto"></p>
<p id="bm_system" dir="auto"></p>
<p id="bm_HID" dir="auto"></p>
</div></footer>
</body>
</html>