1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
-->
<meta>
<topic id="text/sbasic/python/python_handler">
<title id="tit" xml-lang="en-US">Creating A Dialog Handler</title>
<filename>/text/sbasic/python/python_handler.xhp</filename>
</topic>
</meta>
<body>
<bookmark branch="index" id="N0664">
<bookmark_value>Basic;Dialog Handler</bookmark_value>
<bookmark_value>Python;Dialog Handler</bookmark_value>
<bookmark_value>Access2Base;dlgTrace</bookmark_value>
<bookmark_value>Access2Base;_DumpToFile</bookmark_value>
<bookmark_value>API;DialogProvider2</bookmark_value>
<bookmark_value>API;XDialogEventHandler</bookmark_value>
</bookmark>
<h1 id="N0665"><variable id="pythonhandler_h1"><link href="text/sbasic/python/python_handler.xhp" name="Creating a Dialog Handler">Creating a Dialog Handler</link></variable></h1>
<paragraph role="paragraph" id="N0666">Next to <link href="text/sbasic/shared/01040000.xhp" name ="Assigning macros to events">assigning macros to events</link> or <link href="text/sbasic/basic/python/python_listener" name ="creating event listeners">creating event listeners</link>, 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 <literal>vnd.sun.star.UNO:<method_name></literal> 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.</paragraph>
<paragraph role="paragraph" id="N0667">The advantages of this approach are:</paragraph>
<list type="unordered">
<listitem><paragraph role="listitem" id="N0668">It packs the code that handles event-driven macros,</paragraph></listitem>
<listitem><paragraph role="listitem" id="N0669">it decorrelates events from macros names which facilitates maintenance or updates, in particular when moving macros or modules.</paragraph></listitem>
</list>
<paragraph role="paragraph" id="N0670">This mechanism is illustrated herewith for Basic and Python languages using an imported copy of <literal>Access2Base</literal> <literal>dlgTrace</literal> dialog. Exception handling and localisation are omitted for clarity.</paragraph>
<h2 id="N0671">Assigning Dialog methods</h2>
<paragraph role="paragraph" id="N0672">Export <literal>Access2Base</literal> <literal>dlgTrace</literal> dialog and import it into <literal>MyLib</literal> application library.</paragraph>
<paragraph role="paragraph" id="N0673">Inside the control properties pane of the <link href="text/sbasic/guide/create_dialog.xhp" name ="Dialog Editor">Dialog Editor</link>, use the Events tab to replace macro assignments by component assignments, and type in the intended method names:</paragraph>
<list type="unordered">
<listitem><paragraph role="listitem" id="N0674">Set <literal>Dump to file</literal> dialog button component method name to <literal>_dump2File</literal></paragraph></listitem>
<listitem><paragraph role="listitem" id="N0675">Optionally define <literal>txtTracelog</literal> key pressed and mouse button pressed events component method names as <literal>_openHelp</literal></paragraph></listitem>
<listitem><paragraph role="listitem" id="N0676">Optionally define <literal>Ok</literal> button receiving focus event component method name as <literal>onOkHasfocus</literal></paragraph></listitem>
</list>
<paragraph role="paragraph" id="N0677">Events assigned actions should mention the <literal>vnd.sun.star.UNO:</literal> protocol.</paragraph>
<h2 id="N0678">Creating the handler</h2>
<paragraph role="paragraph" id="N0679"><literal>createDialogWithHandler</literal> method of <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1DialogProvider2.html" name ="com.sun.star.awt.DialogProvider2">com.sun.star.awt.DialogProvider2</link> service is used to set the dialog and its handler. The handler is responsible for implementing <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XDialogEventHandler.html" name ="com.sun.star.awt.XDialogEventHandler">com.sun.star.awt.XDialogEventHandler</link> interface.</paragraph>
<warning id="N0680">All component method names must be explicitly declared when using a dialog handler.</warning>
<h3 id="N0681">With Python</h3>
<paragraph role="paragraph" id="N0682">In this example the dialog is located on the computer.</paragraph>
<pycode>
<paragraph role="pycode" localize="false" id="N0683"># -*- coding: utf-8 -*-</paragraph>
<paragraph role="pycode" localize="false" id="N0684">from __future__ import unicode_literals</paragraph>
<paragraph role="pycode" localize="false" id="N0685"> </paragraph>
<paragraph role="pycode" localize="false" id="N0686">import uno, unohelper</paragraph>
<paragraph role="pycode" localize="false" id="N0687">from com.sun.star.awt import XDialogEventHandler</paragraph>
<paragraph role="pycode" localize="false" id="N0688"> </paragraph>
<paragraph role="pycode" localize="false" id="N0689">_DLG_PROVIDER = "com.sun.star.awt.DialogProvider2"</paragraph>
<paragraph role="pycode" localize="false" id="N0690"> </paragraph>
<paragraph role="pycode" localize="false" id="N0691">class Console(unohelper.Base, XDialogEventHandler):</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0692"> """ Access2Base Console Handler """</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0693"> ''' adapted from « Créer un dialogue avec gestionnaire d'événements » by JM Zambon</paragraph>
<paragraph role="pycode" localize="false" id="N0694"> https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler '''</paragraph>
<paragraph role="pycode" localize="false" id="N0695"> def show(self):</paragraph>
<paragraph role="pycode" localize="false" id="N0696"> dialog = self.getDialog("MyLib.dlgTrace", embedded=True)</paragraph>
<paragraph role="pycode" localize="false" id="N0697"> dialog.Title = "Konsole"</paragraph>
<paragraph role="pycode" localize="false" id="N0698"> dialog.execute()</paragraph>
<paragraph role="pycode" localize="false" id="N0699"> </paragraph>
<paragraph role="pycode" localize="false" id="N0700"> def callHandlerMethod(self, dialog, event, method):</paragraph>
<paragraph role="pycode" localize="false" id="N0701"> if method == '_dump2File':</paragraph>
<paragraph role="pycode" localize="false" id="N0702"> event.Source.setLabel("dump requested")</paragraph>
<paragraph role="pycode" localize="false" id="N0703"> scr = getBasicScript(script="_DumpToFile", module="Trace",</paragraph>
<paragraph role="pycode" localize="false" id="N0704"> library='Access2Base')</paragraph>
<paragraph role="pycode" localize="false" id="N0705"> scr.invoke((event,), (), ())</paragraph>
<paragraph role="pycode" localize="false" id="N0706"> elif method == '_openHelp':</paragraph>
<paragraph role="pycode" localize="false" id="N0707"> _msgbox('Not yet implemented')</paragraph>
<paragraph role="pycode" localize="false" id="N0708"> dialog.endDialog(1)</paragraph>
<paragraph role="pycode" localize="false" id="N0709"> else:</paragraph>
<paragraph role="pycode" localize="false" id="N0710"> return False</paragraph>
<paragraph role="pycode" localize="false" id="N0711"> </paragraph>
<paragraph role="pycode" localize="false" id="N0712"> def getSupportedMethodNames(self):</paragraph>
<paragraph role="pycode" localize="false" id="N0713"> return ('_dump2File', '_openHelp')</paragraph>
<paragraph role="pycode" localize="false" id="N0714"> </paragraph>
<paragraph role="pycode" localize="false" id="N0715"> def getDialog(self, libr_dlg: str, embedded=False):</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0716"> """ Create a Dialog from its location """</paragraph>
<paragraph role="pycode" localize="false" id="N0717"> smgr = XSCRIPTCONTEXT.getComponentContext().ServiceManager</paragraph>
<paragraph role="pycode" localize="false" id="N0718"> if embedded:</paragraph>
<paragraph role="pycode" localize="false" id="N0719"> model = XSCRIPTCONTEXT.getDocument()</paragraph>
<paragraph role="pycode" localize="false" id="N0720"> dp = smgr.createInstanceWithArguments(_DLG_PROVIDER, (model,))</paragraph>
<paragraph role="pycode" localize="false" id="N0721"> location = "?location=document"</paragraph>
<paragraph role="pycode" localize="false" id="N0722"> else:</paragraph>
<paragraph role="pycode" localize="false" id="N0723"> dp = smgr.createInstanceWithContext(_DLG_PROVIDER, ctx)</paragraph>
<paragraph role="pycode" localize="false" id="N0724"> location = "?location=application"</paragraph>
<paragraph role="pycode" localize="false" id="N0725"> dlg = dp.createDialogWithHandler("vnd.sun.star.script:"+libr_dlg+location, self)</paragraph>
<paragraph role="pycode" localize="false" id="N0726"> return dlg</paragraph>
<paragraph role="pycode" localize="false" id="N072A"> </paragraph>
<!-- WIP need extra work to embed remote code
<embed href="text/sbasic/python/Python_2_Basic.xhp#Python_getBasicScript" /> -->
<paragraph role="pycode" localize="false" id="N072B"># def getBasicScript() # see note</paragraph>
<paragraph role="pycode" localize="false" id="N0727"> </paragraph>
<paragraph role="pycode" localize="false" id="N0728">def _msgbox(prompt='', title=''):</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0729"> ''' Ugly MsgBox '''</paragraph>
<paragraph role="pycode" localize="false" id="N0730"> import msgbox</paragraph>
<paragraph role="pycode" localize="false" id="N0731"> mb = msgbox.MsgBox(uno.getComponentContext())</paragraph>
<paragraph role="pycode" localize="false" id="N0732"> mb.addButton('Howdy')</paragraph>
<paragraph role="pycode" localize="false" id="N0733"> mb.show(prompt,0,title)</paragraph>
<paragraph role="pycode" localize="false" id="N0734"> </paragraph>
<paragraph role="pycode" localize="false" id="N0735">def ConsoleHandler():</paragraph>
<paragraph role="pycode" localize="false" id="N0736"> Console().show()</paragraph>
<paragraph role="pycode" localize="false" id="N0737"> </paragraph>
<paragraph role="pycode" localize="false" id="N0738">g_exportedScripts = (ConsoleHandler,)</paragraph>
<paragraph role="pycode" localize="false" id="N0739"> </paragraph>
</pycode>
<note id="N0740">As expected, <literal>onOkHasFocus</literal> missing method throws an exception.</note>
<tip id="N0741">Refer to <link href="text/sbasic/python/python_2_basic.xhp" name ="Python calls to %PRODUCTNAME Basic">Python calls to %PRODUCTNAME Basic</link> page for <literal>getBasicScript</literal> routine description and for details about cross-language scripting execution.</tip>
<h3 id="N0742">With %PRODUCTNAME Basic</h3>
<paragraph role="paragraph" id="N0743">In this example the dialog is embedded in a document, and can equally be located on the computer.</paragraph>
<bascode>
<paragraph role="bascode" localize="false" id="N0744">' <MyLib>.<Handler> module</paragraph>
<paragraph role="bascode" localize="false" id="N0745"> </paragraph>
<paragraph role="bascode" localize="false" id="N0746">Public Sub Console_Show()</paragraph>
<paragraph role="bascode" localize="false" id="N0747"> Dim dp as Object ' com.sun.star.awt.DialogProvider2</paragraph>
<paragraph role="bascode" localize="false" id="N0748"> Dim dialog As Object ' com.sun.star.awt.XDialog, com.sun.star.awt.XDialogEventHandler</paragraph>
<paragraph role="bascode" localize="false" id="N0749"> Dim eventHandler As Object ' com.sun.star.awt.XDialogEventHandler</paragraph>
<paragraph role="bascode" localize="false" id="N0750"> dp = CreateUnoService("com.sun.star.awt.DialogProvider2")</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0751"> dp.Initialize(Array(ThisComponent)) ' if doc-embedded dialog</paragraph>
<paragraph role="bascode" localize="false" id="N0752"> eventHandler = CreateUnoListener("Console_", "com.sun.star.awt.XDialogEventHandler")</paragraph>
<paragraph role="bascode" localize="false" id="N0753"> dialog = dp.createDialogWithHandler("vnd.sun.star.script:MyLib.dlgTrace?location=document", eventHandler)</paragraph>
<paragraph role="bascode" localize="false" id="N0754"> dialog.Title = "Konsole"</paragraph>
<paragraph role="bascode" localize="false" id="N0755"> dialog.execute()</paragraph>
<paragraph role="bascode" localize="false" id="N0756">End Sub ' <Handler>.Console_Show()</paragraph>
<paragraph role="bascode" localize="false" id="N0757"> </paragraph>
<paragraph role="bascode" localize="false" id="N0758a">Private Function Console_callHandlerMethod(dialog as Object, _</paragraph>
<paragraph role="bascode" localize="false" id="N0758b"> event As com.sun.star.document.DocumentEvent, _</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0958c"> method As String) As Boolean</paragraph>
<paragraph role="bascode" localize="false" id="N0759"> ''' Intercept dialog events using .UNO protocol '''</paragraph>
<paragraph role="bascode" localize="false" id="N0760"> Console_callHandlerMethod = True</paragraph>
<paragraph role="bascode" localize="false" id="N0761"> Select Case method</paragraph>
<paragraph role="bascode" localize="false" id="N0762"> Case "_dump2File"</paragraph>
<paragraph role="bascode" localize="false" id="N0763"> event.Source.setLabel("dump requested")</paragraph>
<paragraph role="bascode" localize="false" id="N0764"> With GlobalScope.BasicLibraries</paragraph>
<paragraph role="bascode" localize="false" id="N0765"> If Not .IsLibraryLoaded("Access2Base") Then .LoadLibrary("Access2Base")</paragraph>
<paragraph role="bascode" localize="false" id="N0766"> End With</paragraph>
<paragraph role="bascode" localize="false" id="N0767"> Access2Base.Trace._DumpToFile</paragraph>
<paragraph role="bascode" localize="false" id="N0768"> Case "_openHelp" </paragraph>
<paragraph role="bascode" localize="false" id="N0769"> MsgBox "Not yet implemented",0 , "Howdy"</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0770"> 'dialog.endDialog(1) if computer-based dialog</paragraph>
<paragraph role="bascode" localize="false" id="N0771"> Case Else : Console_callHandlerMethod = False</paragraph>
<paragraph role="bascode" localize="false" id="N0772"> End Select</paragraph>
<paragraph role="bascode" localize="false" id="N0773">End Function ' <Handler>.Console_callHandlerMethod</paragraph>
<paragraph role="bascode" localize="false" id="N0774"> </paragraph>
<paragraph role="bascode" localize="false" id="N0775">Private Function Console_getSupportedMethodNames()</paragraph>
<paragraph role="bascode" localize="false" id="N0776"> Console_getSupportedMethodNames = Array("_dump2File", "_openHelp")</paragraph>
<paragraph role="bascode" localize="false" id="N0777">End Function ' <Handler>.Console _getSupportedMethodNames</paragraph>
<paragraph role="bascode" localize="false" id="N0778"> </paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0779">' adapted from « Créer un dialogue avec gestionnaire d'événements » by JM Zambon</paragraph>
<paragraph role="bascode" localize="false" id="N0780">' https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler</paragraph>
</bascode>
<note id="N0781">As expected, <literal>onOkHasFocus</literal> missing method throws an exception.</note>
<section id="relatedtopics" >
<embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/>
<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/>
<paragraph role="paragraph" id="N0505"><link href="text/sbasic/shared/03132000.xhp" name ="CreateUnoListener Function">CreateUnoListener Function</link></paragraph>
<embed href="text/sbasic/python/python_listener.xhp#pythonlistener"/>
<embed href="text/sbasic/python/python_dialogs.xhp#pythondialog"/>
<embed href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/>
<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/>
<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
</section>
</body>
</helpdocument>
|
