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_listener.xhp">
<title id="tit" xml-lang="en-US">Python Listeners : Creating Event Listeners</title>
<filename>/text/sbasic/python/python_listener.xhp</filename>
</topic>
</meta>
<body>
<bookmark branch="index" id="N0385">
<bookmark_value>Python;Event Listener</bookmark_value>
<bookmark_value>Python;createUnoListener</bookmark_value>
<bookmark_value>Basic;Event Listener</bookmark_value>
<bookmark_value>API;ActionEvent</bookmark_value>
<bookmark_value>API;DialogProvider</bookmark_value>
<bookmark_value>API;EventObject</bookmark_value>
<bookmark_value>API;ExecutableDialogResults</bookmark_value>
<bookmark_value>API;XActionListener</bookmark_value>
</bookmark>
<section id="pythonlistener1">
<h1 id="N0386"><variable id="pythonlistener"><link href="text/sbasic/python/python_listener.xhp" name="python listeners">Creating Event Listeners</link></variable></h1>
</section>
<paragraph role="paragraph" id="N0387">Events raised by dialogs, documents, forms or graphical controls can be linked to macros, which is referred to as event-driven programming. The most common method to relate events to macros are the <literal>Events</literal> tab in <menuitem>Tools – Customize</menuitem> menu and the <link href="text/sbasic/guide/create_dialog.xhp" name ="Create dialog">Dialog Editor</link> Control properties pane from <menuitem>Tools - Macros – Organise Dialogs...</menuitem> menu.</paragraph>
<paragraph role="paragraph" id="N0388">Graphical artifacts, keyboard inputs, mouse moves and other man/machine interactions can be controlled using UNO listeners that watch for the user’s behaviour. Listeners are dynamic program code alternatives to macro assignments. One may create as many UNO listeners as events to watch for. A single listener can also handle multiple user interface controls.</paragraph>
<h2 id="N0389">Creating an event listener</h2>
<paragraph role="paragraph" id="N0390">Listeners get attached to controls held in dialogs, as well as to document or form events. Listeners are also used when creating runtime dialogs or when adding controls to a dialog on the fly.</paragraph>
<paragraph role="paragraph" id="N0391">This example creates a listener for <literal>Button1</literal> control of <literal>Dialog1</literal> dialog in <literal>Standard</literal> library.</paragraph>
<h3 id="N0392">With Python</h3>
<pycode>
<paragraph role="pycode" localize="false" id="N0393"># -*- coding: utf-8 -*-</paragraph>
<paragraph role="pycode" localize="false" id="N0394">from __future__ import unicode_literals</paragraph>
<paragraph role="pycode" localize="false" id="N0395"> </paragraph>
<paragraph role="pycode" localize="false" id="N0396">import uno, unohelper</paragraph>
<paragraph role="pycode" localize="false" id="N0397">from com.sun.star.awt import XActionListener</paragraph>
<paragraph role="pycode" localize="false" id="N0398">from com.sun.star.awt import ActionEvent</paragraph>
<paragraph role="pycode" localize="false" id="N0399">from com.sun.star.lang import EventObject</paragraph>
<paragraph role="pycode" localize="false" id="N0400">from com.sun.star.ui.dialogs.ExecutableDialogResults \</paragraph>
<paragraph role="pycode" localize="false" id="N0401"> import OK, CANCEL</paragraph>
<paragraph role="pycode" localize="false" id="N0402">import msgbox as util</paragraph>
<paragraph role="pycode" localize="false" id="N0403"> </paragraph>
<paragraph role="pycode" localize="false" id="N0404">_MY_BUTTON = "Button1"</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0405">_MY_LABEL = 'Python listens..'</paragraph>
<paragraph role="pycode" localize="false" id="N0406">_DLG_PROVIDER = "com.sun.star.awt.DialogProvider"</paragraph>
<paragraph role="pycode" localize="false" id="N0407"> </paragraph>
<paragraph role="pycode" localize="false" id="N0408">def Main(*args):</paragraph>
<paragraph role="pycode" localize="false" id="N0409"> ui = createUnoDialog("Standard.Dialog1", embedded=True)</paragraph>
<paragraph role="pycode" localize="false" id="N0410"> ui.Title = "Python X[any]Listener"</paragraph>
<paragraph role="pycode" localize="false" id="N0411"> ctl = ui.getControl(_MY_BUTTON)</paragraph>
<paragraph role="pycode" localize="false" id="N0412"> ctl.Model.Label = _MY_LABEL</paragraph>
<paragraph role="pycode" localize="false" id="N0413"> act = ActionListener()</paragraph>
<paragraph role="pycode" localize="false" id="N0414"> ctl.addActionListener(act)</paragraph>
<paragraph role="pycode" localize="false" id="N0415"> rc = ui.execute()</paragraph>
<paragraph role="pycode" localize="false" id="N0416"> if rc == OK:</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0417"> MsgBox("The user acknowledged the dialog.")</paragraph>
<paragraph role="pycode" localize="false" id="N0418"> elif rc == CANCEL:</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0419"> MsgBox("The user canceled the dialog.")</paragraph>
<paragraph role="pycode" localize="false" id="N0420"> ui.dispose() # ui.endExecute</paragraph>
<paragraph role="pycode" localize="false" id="N0421"> ctl.removeActionListener(act)</paragraph>
<paragraph role="pycode" localize="false" id="N0422"> </paragraph>
<paragraph role="pycode" localize="false" id="N0423">def createUnoDialog(libr_dlg: str, embedded=False):</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0424"> """ Create a Dialog from its location """</paragraph>
<paragraph role="pycode" localize="false" id="N0425"> smgr = XSCRIPTCONTEXT.getComponentContext().ServiceManager</paragraph>
<paragraph role="pycode" localize="false" id="N0426"> if embedded:</paragraph>
<paragraph role="pycode" localize="false" id="N0427"> model = XSCRIPTCONTEXT.getDocument()</paragraph>
<paragraph role="pycode" localize="false" id="N0428"> dp = smgr.createInstanceWithArguments(_DLG_PROVIDER, (model,))</paragraph>
<paragraph role="pycode" localize="false" id="N0429"> location = "?location=document"</paragraph>
<paragraph role="pycode" localize="false" id="N0430"> else:</paragraph>
<paragraph role="pycode" localize="false" id="N0431"> dp = smgr.createInstanceWithContext(_DLG_PROVIDER, ctx)</paragraph>
<paragraph role="pycode" localize="false" id="N0432"> location = "?location=application"</paragraph>
<paragraph role="pycode" localize="false" id="N0433"> dlg = dp.createDialog("vnd.sun.star.script:"+libr_dlg+location)</paragraph>
<paragraph role="pycode" localize="false" id="N0434"> return dlg</paragraph>
<paragraph role="pycode" localize="false" id="N0435"> </paragraph>
<paragraph role="pycode" localize="false" id="N0436">class ActionListener(unohelper.Base, XActionListener):</paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0437"> """ Listen to & count button clicks """</paragraph>
<paragraph role="pycode" localize="false" id="N0438"> def __init__(self):</paragraph>
<paragraph role="pycode" localize="false" id="N0439"> self.count = 0</paragraph>
<paragraph role="pycode" localize="false" id="N0440"> </paragraph>
<paragraph role="pycode" localize="false" id="N0441"> def actionPerformed(self, evt: ActionEvent):</paragraph>
<paragraph role="pycode" localize="false" id="N0442"> self.count = self.count + 1</paragraph>
<paragraph role="pycode" localize="false" id="N0443"> #mri(evt)</paragraph>
<paragraph role="pycode" localize="false" id="N0444"> if evt.Source.Model.Name == _MY_BUTTON:</paragraph>
<paragraph role="pycode" localize="false" id="N0445"> evt.Source.Model.Label = _MY_LABEL+ str( self.count )</paragraph>
<paragraph role="pycode" localize="false" id="N0446"> return</paragraph>
<paragraph role="pycode" localize="false" id="N0447"> </paragraph>
<paragraph role="pycode" xml-lang="en-US" id="N0448"> def disposing(self, evt: EventObject): # mandatory routine</paragraph>
<paragraph role="pycode" localize="false" id="N0449"> pass</paragraph>
<paragraph role="pycode" localize="false" id="N0450"> </paragraph>
<paragraph role="pycode" localize="false" id="N0451">def MsgBox(txt: str):</paragraph>
<paragraph role="pycode" localize="false" id="N0452"> mb = util.MsgBox(uno.getComponentContext())</paragraph>
<paragraph role="pycode" localize="false" id="N0453"> mb.addButton("Ok")</paragraph>
<paragraph role="pycode" localize="false" id="N0454"> mb.show(txt, 0, "Python")</paragraph>
<paragraph role="pycode" localize="false" id="N0455"> </paragraph>
<paragraph role="pycode" localize="false" id="N0456">g_exportedScripts = (Main,)</paragraph>
</pycode>
<paragraph role="paragraph" id="N0457">
<emph>msgbox.py</emph> in <emph>{installation}/program/</emph> directory has some examples of button listeners.
</paragraph>
<h3 id="N0458">With %PRODUCTNAME Basic</h3>
<bascode>
<paragraph role="bascode" localize="false" id="N0459a">Option Explicit</paragraph>
<paragraph role="bascode" localize="false" id="N0459b"> </paragraph>
<paragraph role="bascode" localize="false" id="N0459c">Const MY_LIBRARY = "Standard", MY_DIALOG = "Dialog1", MY_BUTTON = "Button1"</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0459d">Const MY_LABEL = "Basic listens.."</paragraph>
<paragraph role="bascode" localize="false" id="N0459e">Dim count As Integer</paragraph>
<paragraph role="bascode" localize="false" id="N0459f"> </paragraph>
<paragraph role="bascode" localize="false" id="N0459">Sub Main</paragraph>
<paragraph role="bascode" localize="false" id="N0460"> Dim libr As Object ' com.sun.star.script.XLibraryContainer</paragraph>
<paragraph role="bascode" localize="false" id="N0461"> Dim dlg As Object</paragraph>
<paragraph role="bascode" localize="false" id="N0462"> Dim ui As Object ' stardiv.Toolkit.UnoDialogControl</paragraph>
<paragraph role="bascode" localize="false" id="N0463"> Dim ctl As Object ' stardiv.Toolkit.UnoButtonControl</paragraph>
<paragraph role="bascode" localize="false" id="N0464"> Dim act As Object ' com.sun.star.awt.XActionListener</paragraph>
<paragraph role="bascode" localize="false" id="N0465"> Dim rc As Object : rc = com.sun.star.ui.dialogs.ExecutableDialogResults</paragraph>
<paragraph role="bascode" localize="false" id="N0466"> </paragraph>
<paragraph role="bascode" localize="false" id="N0467"> BasicLibraries.LoadLibrary(MY_LIBRARY)</paragraph>
<paragraph role="bascode" localize="false" id="N0468"> libr = DialogLibraries.GetByName(MY_LIBRARY)</paragraph>
<paragraph role="bascode" localize="false" id="N0469"> dlg = libr.GetByName(MY_DIALOG)</paragraph>
<paragraph role="bascode" localize="false" id="N0470"> ui = CreateUnoDialog(dlg)</paragraph>
<paragraph role="bascode" localize="false" id="N0471"> ui.Title = "Basic X[any]Listener example"</paragraph>
<paragraph role="bascode" localize="false" id="N0472"> count = 0</paragraph>
<paragraph role="bascode" localize="false" id="N0473"> ctl = ui.GetControl(MY_BUTTON)</paragraph>
<paragraph role="bascode" localize="false" id="N0474"> ctl.Model.Label = MY_LABEL</paragraph>
<paragraph role="bascode" localize="false" id="N0475"> act = CreateUnoListener("awt_", "com.sun.star.awt.XActionListener")</paragraph>
<paragraph role="bascode" localize="false" id="N0476"> ctl.addActionListener(act)</paragraph>
<paragraph role="bascode" localize="false" id="N0477"> Select Case ui.Execute</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0478"> Case rc.OK : MsgBox "The user acknowledged the dialog.",, "Basic"</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0479"> Case rc.CANCEL : MsgBox "The user canceled the dialog.",, "Basic"</paragraph>
<paragraph role="bascode" localize="false" id="N0480"> End Select</paragraph>
<paragraph role="bascode" localize="false" id="N0481"> ui.dispose ' ui.endExecute()</paragraph>
<paragraph role="bascode" localize="false" id="N0482"> ctl.removeActionListener(act)</paragraph>
<paragraph role="bascode" localize="false" id="N0483">End Sub</paragraph>
<paragraph role="bascode" localize="false" id="N0484"> </paragraph>
<paragraph role="bascode" localize="false" id="N0485">Private Sub awt_actionPerformed(evt As com.sun.star.awt.ActionEvent)</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0486"> ''' Listen to & count button clicks '''</paragraph>
<paragraph role="bascode" localize="false" id="N0487"> With evt.Source.Model</paragraph>
<paragraph role="bascode" localize="false" id="N0488"> If .Name = MY_BUTTON Then</paragraph>
<paragraph role="bascode" localize="false" id="N0489"> count = count + 1</paragraph>
<paragraph role="bascode" localize="false" id="N0490"> .Label = MY_LABEL+Cstr(count)</paragraph>
<paragraph role="bascode" localize="false" id="N0491"> End If</paragraph>
<paragraph role="bascode" localize="false" id="N0492"> End With</paragraph>
<paragraph role="bascode" localize="false" id="N0493">End Sub ' awt_actionPerformed</paragraph>
<paragraph role="bascode" localize="false" id="N0494"> </paragraph>
<paragraph role="bascode" localize="false" id="N0495">Private Sub awt_disposing(evt As com.sun.star.lang.EventObject) ' mandatory Sub</paragraph>
<paragraph role="bascode" xml-lang="en-US" id="N0496"> ' your code goes here</paragraph>
<paragraph role="bascode" localize="false" id="N0497">End Sub ' awt_disposing</paragraph>
</bascode>
<h2 id="N0498">Other Event Listeners</h2>
<paragraph role="paragraph" id="N0499">Listeners are usually coded along with <link href="text/sbasic/python/python_dialogs.xhp" name ="dialog opening">dialog opening</link>. Numerous listener approaches are possible such as event handlers for dialogs or event monitors for documents or forms.</paragraph>
<section id="relatedtopics" >
<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/>
<paragraph role="paragraph" id="N0505"><link href="text/sbasic/shared/03132000.xhp" name ="CreateUnoListener Function">CreateUnoListener Function</link></paragraph>
<paragraph role="paragraph" id="N0506"><link href="text/swriter/01/05060700.xhp" name ="Events mapping to objects">Events mapping to objects</link></paragraph>
<paragraph role="paragraph" id="N0509">See also <link href="text/sbasic/shared/01040000.xhp" name ="Document events">Document events</link>, <link href="text/shared/02/01170202.xhp" name ="Form events">Form events</link>.</paragraph>
<!-- WIP
<embed href="text/sbasic/python/python_dialog_handler.xhp#pythonhandler1"/>
-->
<embed href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/>
<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/>
</section>
</body>
</helpdocument>
|
