Event listener registration can now be done by the **do** instruction instead of **connect** (that stays available for compatibility reasons).

Author: dddomodossola

README.md

@@ -31,6 +31,16 @@ There is also a drag n drop GUI editor. Look at the [Editor](https://github.com/
 
 Changelog
 ===
+*2019 April 1*
+
+Event listener registration can now be done by the **do** instruction instead of **connect** (that stays available for compatibility reasons).
+i.e. 
+```python
+mybutton.onclick.do(myevent_listener)
+```
+
+*Older changes*
+
 The current branch includes improvements about resource files handling. 
 App constructor accepts **static_file_path** parameter. Its value have to be a dictionary, where elements represents named resources paths.
 
@@ -105,7 +115,7 @@ class MyApp(App):
         self.bt = gui.Button('Press me!')
 
         # setting the listener for the onclick event of the button
-        self.bt.onclick.connect(self.on_button_pressed)
+        self.bt.onclick.do(self.on_button_pressed)
 
         # appending a widget to another, the first argument is a string key
         container.append(self.lbl)
@@ -214,7 +224,7 @@ Such events are a convenient way to define the application behavior.
 Each widget has its own callbacks, depending on the type of user interaction it allows.
 The specific callbacks for the widgets will be illustrated later.
 
-In order to register a function as an event listener you have to call a function like eventname.connect (i.e. onclick.connect) passing as parameters the callback that will manage the event.
+In order to register a function as an event listener you have to call a function like eventname.do (i.e. onclick.do) passing as parameters the callback that will manage the event.
 Follows an example:
 
 ```py
@@ -231,7 +241,7 @@ class MyApp(App):
         self.bt = gui.Button('Press me!')
 
         # setting the listener for the onclick event of the button
-        self.bt.onclick.connect(self.on_button_pressed)
+        self.bt.onclick.do(self.on_button_pressed)
 
         # appending a widget to another, the first argument is a string key
         container.append(self.lbl)
@@ -249,13 +259,13 @@ class MyApp(App):
 start(MyApp)
 ```
 
-In the shown example *self.bt.onclick.connect(self.on_button_pressed)* registers the self's *on_button_pressed* function as a listener for the event *onclick* exposed by the Button widget.
+In the shown example *self.bt.onclick.do(self.on_button_pressed)* registers the self's *on_button_pressed* function as a listener for the event *onclick* exposed by the Button widget.
 Simple, easy.
 
 Listener's callbacks will receive the emitter's instance firstly, then all other parameters provided by the specific event.
 
 
-Besides the standard event registration (as aforementioned), it is possible to pass user parameters to listener functions. This can be achieves appending parameters to the *connect* function call.
+Besides the standard event registration (as aforementioned), it is possible to pass user parameters to listener functions. This can be achieves appending parameters to the *do* function call.
 
 ```py
 import remi.gui as gui
@@ -272,8 +282,8 @@ class MyApp(App):
         self.bt2 = gui.Button('Hello name surname!')
 
         # setting the listener for the onclick event of the buttons
-        self.bt.onclick.connect(self.on_button_pressed, "Name")
-        self.bt2.onclick.connect(self.on_button_pressed, "Name", "Surname")
+        self.bt.onclick.do(self.on_button_pressed, "Name")
+        self.bt2.onclick.do(self.on_button_pressed, "Name", "Surname")
 
         # appending a widget to another
         container.append(self.lbl)

editor/editor.py

@@ -70,9 +70,9 @@ def setup(self, refWidget, newParent):
 
     def start_drag(self, emitter, x, y):
         self.active = True
-        self.project.onmousemove.connect(self.on_drag)
-        self.project.onmouseup.connect(self.stop_drag)
-        self.project.onmouseleave.connect(self.stop_drag, 0, 0)
+        self.project.onmousemove.do(self.on_drag)
+        self.project.onmouseup.do(self.stop_drag)
+        self.project.onmouseleave.do(self.stop_drag, 0, 0)
         self.origin_x = -1
         self.origin_y = -1
 
@@ -107,7 +107,7 @@ def __init__(self, project, name_coord_x, name_coord_y, compatibility_iterable,
         self.set_stroke(1, 'black')
         self.set_fill('#ffcc00')
         self.compatibility_iterable = compatibility_iterable
-        self.onmousedown.connect(self.start_drag)
+        self.onmousedown.do(self.start_drag)
 
     def setup(self, refWidget, newParent):
         if type(refWidget) in self.compatibility_iterable or refWidget == None:
@@ -140,7 +140,7 @@ def __init__(self, project, compatibility_iterable, **kwargs):
         self.set_stroke(1, 'black')
         self.set_fill('#ffcc00')
         self.compatibility_iterable = compatibility_iterable
-        self.onmousedown.connect(self.start_drag)
+        self.onmousedown.do(self.start_drag)
 
     def setup(self, refWidget, newParent):
         if type(refWidget) in self.compatibility_iterable or refWidget == None:
@@ -173,7 +173,7 @@ def __init__(self, project, compatibility_iterable, **kwargs):
         self.set_stroke(1, 'black')
         self.set_fill('#ffcc00')
         self.compatibility_iterable = compatibility_iterable
-        self.onmousedown.connect(self.start_drag)
+        self.onmousedown.do(self.start_drag)
 
     def setup(self, refWidget, newParent):
         if type(refWidget) in self.compatibility_iterable or refWidget == None:
@@ -206,7 +206,7 @@ def __init__(self, project, **kwargs):
         self.style['position'] = 'absolute'
         self.style['left']='0px'
         self.style['top']='0px'
-        self.onmousedown.connect(self.start_drag)
+        self.onmousedown.do(self.start_drag)
 
     def setup(self, refWidget, newParent):
         if type(refWidget) in [gui.Widget, gui.Button, gui.GridBox, gui.VBox, gui.HBox, 
@@ -247,7 +247,7 @@ def __init__(self, project, **kwargs):
         self.style['position'] = 'absolute'
         self.style['left']='0px'
         self.style['top']='0px'
-        self.onmousedown.connect(self.start_drag)
+        self.onmousedown.do(self.start_drag)
 
     def setup(self, refWidget, newParent):
         if type(refWidget) in [gui.Widget, gui.Button, gui.GridBox, gui.VBox, gui.HBox, 
@@ -333,7 +333,7 @@ def create_callback_copy(self, widget):
                 #if there is a callback
                 if getattr(widget, setOnEventListenerFuncname).callback: 
                     getattr(widget, setOnEventListenerFuncname).callback_copy = getattr(widget, setOnEventListenerFuncname).callback
-                    getattr(widget, setOnEventListenerFuncname).connect(None)
+                    getattr(widget, setOnEventListenerFuncname).do(None)
         for w in widget.children.values():
             self.create_callback_copy(w)
 
@@ -556,20 +556,20 @@ def main(self):
         self.toolbar.append(grid_size)
 
         self.fileOpenDialog = editor_widgets.EditorFileSelectionDialog('Open Project', 'Select the project file.<br>It have to be a python program created with this editor.', False, '.', True, False, self)
-        self.fileOpenDialog.confirm_value.connect(self.on_open_dialog_confirm)
+        self.fileOpenDialog.confirm_value.do(self.on_open_dialog_confirm)
 
         self.fileSaveAsDialog = editor_widgets.EditorFileSaveDialog('Project Save', 'Select the project folder and type a filename', False, '.', False, True, self)
         self.fileSaveAsDialog.add_fileinput_field('untitled.py')
-        self.fileSaveAsDialog.confirm_value.connect(self.on_saveas_dialog_confirm)        
+        self.fileSaveAsDialog.confirm_value.do(self.on_saveas_dialog_confirm)        
 
-        m10.onclick.connect(self.menu_new_clicked)
-        m11.onclick.connect(self.fileOpenDialog.show)
-        m121.onclick.connect(self.menu_save_clicked)
-        m122.onclick.connect(self.fileSaveAsDialog.show)
-        m21.onclick.connect(self.menu_cut_selection_clicked)
-        m22.onclick.connect(self.menu_paste_selection_clicked)
+        m10.onclick.do(self.menu_new_clicked)
+        m11.onclick.do(self.fileOpenDialog.show)
+        m121.onclick.do(self.menu_save_clicked)
+        m122.onclick.do(self.fileSaveAsDialog.show)
+        m21.onclick.do(self.menu_cut_selection_clicked)
+        m22.onclick.do(self.menu_paste_selection_clicked)
 
-        m3.onclick.connect(self.menu_project_config_clicked)
+        m3.onclick.do(self.menu_project_config_clicked)
 
         self.subContainer = gui.HBox(width='100%', height='96%', layout_orientation=gui.Widget.LAYOUT_HORIZONTAL)
         self.subContainer.style.update({'position':'relative',
@@ -595,7 +595,7 @@ def main(self):
                 
                 return false;""" % {'evt':self.EVENT_ONDROPPPED}
         self.project.attributes['editor_varname'] = 'App'
-        self.project.onkeydown.connect(self.onkeydown)
+        self.project.onkeydown.do(self.onkeydown)
 
         self.projectConfiguration = editor_widgets.ProjectConfigurationDialog('Project Configuration', 'Write here the configuration for your project.')
 
@@ -619,7 +619,7 @@ def main(self):
         self.subContainerRight.add_class('RaisedFrame')
 
         self.instancesWidget = editor_widgets.InstancesWidget(width='100%')
-        self.instancesWidget.treeView.on_tree_item_selected.connect(self.on_instances_widget_selection)
+        self.instancesWidget.treeView.on_tree_item_selected.do(self.on_instances_widget_selection)
 
         self.subContainerRight.append([self.instancesWidget, self.attributeEditor])
 
@@ -635,7 +635,7 @@ def main(self):
                             SvgDraggablePoint(self.project, 'x', 'y', [gui.SvgRectangle, gui.SvgText]),
                             SvgDraggableRectangleResizePoint(self.project, [gui.SvgRectangle])]
         for drag_helper in self.drag_helpers:
-            drag_helper.stop_drag.connect(self.on_drag_resize_end)
+            drag_helper.stop_drag.do(self.on_drag_resize_end)
 
         self.menu_new_clicked(None)
 
@@ -660,7 +660,7 @@ def configure_widget_for_editing(self, widget):
 
         if not 'editor_varname' in widget.attributes:
             return
-        widget.onclick.connect(self.on_widget_selection)
+        widget.onclick.do(self.on_widget_selection)
 
         #setup of the on_dropped function of the widget in order to manage the dragNdrop 
         widget.__class__.on_dropped = on_dropped

editor/editor_widgets.py

@@ -28,7 +28,7 @@ def append_instance(self, instance, parent):
         if parent==None:
             parent = self
         item.instance = instance
-        item.onclick.connect(self.on_tree_item_selected)
+        item.onclick.do(self.on_tree_item_selected)
         parent.append(item)
         return item
 
@@ -110,7 +110,7 @@ def __init__(self, **kwargs):
     def add_command(self, imagePath, callback, title):
         icon = gui.Image(imagePath, height='90%', margin='0px 1px')
         icon.style['outline'] = '1px solid lightgray'
-        icon.onclick.connect(callback)
+        icon.onclick.do(callback)
         icon.attributes['title'] = title
         self.append(icon)
 
@@ -125,7 +125,7 @@ def __init__(self, widget, listenersList, eventConnectionFuncName, eventConnecti
         self.label.style.update({'float':'left', 'font-size':'10px', 'overflow':'hidden', 'outline':'1px solid lightgray'})
 
         self.dropdown = gui.DropDown(width='49%', height='100%')
-        self.dropdown.onchange.connect(self.on_connection)
+        self.dropdown.onchange.do(self.on_connection)
         self.append([self.label, self.dropdown])
         self.dropdown.style['float'] = 'right'
 
@@ -144,14 +144,14 @@ def __init__(self, widget, listenersList, eventConnectionFuncName, eventConnecti
 
     def on_connection(self, widget, dropDownValue):
         if self.dropdown.get_value()=='None':
-            self.eventConnectionFunc.connect(None)
+            self.eventConnectionFunc.do(None)
         else:
             listener = self.dropdown._selected_item.listenerInstance
             listener.attributes['editor_newclass'] = "True"
             print("Event: " + self.eventConnectionFuncName + " signal connection to: " + listener.attributes['editor_varname'] + "   from:" + self.refWidget.attributes['editor_varname'])
             back_callback = getattr(self.refWidget, self.eventConnectionFuncName).callback
             listener.__class__.fakeListenerFunc = fakeListenerFunc
-            getattr(self.refWidget, self.eventConnectionFuncName).connect(listener.fakeListenerFunc)
+            getattr(self.refWidget, self.eventConnectionFuncName).do(listener.fakeListenerFunc)
             getattr(self.refWidget, self.eventConnectionFuncName).callback_copy = getattr(self.refWidget, self.eventConnectionFuncName).callback
             getattr(self.refWidget, self.eventConnectionFuncName).callback = back_callback
 
@@ -295,7 +295,7 @@ def show(self, *args):
 
     def add_fileinput_field(self, defaultname='untitled'):
         self.txtFilename = gui.TextInput()
-        self.txtFilename.onkeydown.connect(self.on_enter_key_pressed)
+        self.txtFilename.onkeydown.do(self.on_enter_key_pressed)
         self.txtFilename.set_text(defaultname)
 
         self.add_field_with_label("filename","Filename",self.txtFilename)
@@ -345,7 +345,7 @@ def __init__(self, appInstance, widgetClass, **kwargs_to_widget):
 
         self.optional_style_dict = {} #this dictionary will contain optional style attributes that have to be added to the widget once created
 
-        self.onclick.connect(self.prompt_new_widget)
+        self.onclick.do(self.prompt_new_widget)
 
     def build_widget_name_list_from_tree(self, node):
         if not hasattr(node, 'attributes'):
@@ -384,7 +384,7 @@ def prompt_new_widget(self, widget):
             self.dialog.add_field_with_label(param, param + note, editWidget)
 
         self.dialog.add_field_with_label("editor_newclass", "Overload base class", gui.CheckBox())
-        self.dialog.confirm_dialog.connect(self.on_dialog_confirm)
+        self.dialog.confirm_dialog.do(self.on_dialog_confirm)
         self.dialog.show(self.appInstance)
 
     def on_dropped(self, left, top):
@@ -517,7 +517,7 @@ def __init__(self, title, **kwargs):
             'background-repeat':'no-repeat',
             'background-position':'5px',
             'border-top':'3px solid lightgray'})
-        self.title.onclick.connect(self.openClose)
+        self.title.onclick.do(self.openClose)
         self.append(self.title, '0')
 
     def openClose(self, widget):
@@ -559,8 +559,8 @@ def __init__(self, appInstance, **kwargs):
             attributeName = attribute[0]
             attributeValue = attribute[1]
             attributeEditor = EditorAttributeInput(attributeName, attributeValue, appInstance)
-            attributeEditor.on_attribute_changed.connect(self.onattribute_changed)
-            attributeEditor.on_attribute_remove.connect(self.onattribute_remove)
+            attributeEditor.on_attribute_changed.do(self.onattribute_changed)
+            attributeEditor.on_attribute_remove.do(self.onattribute_remove)
             #attributeEditor.style['display'] = 'none'
             if not attributeValue['group'] in self.attributeGroups.keys():
                 groupContainer = EditorAttributesGroup(attributeValue['group'], width='100%')
@@ -610,15 +610,15 @@ def __init__(self, appInstance, **kwargs):
         self.style['overflow'] = 'hidden'
 
         self.numInput = gui.SpinBox('0',-999999999, 999999999, 1, width='60%', height='100%')
-        self.numInput.onchange.connect(self.onchange)
+        self.numInput.onchange.do(self.onchange)
         self.numInput.style['text-align'] = 'right'
         self.append(self.numInput)
 
         self.dropMeasureUnit = gui.DropDown(width='40%', height='100%')
         self.dropMeasureUnit.append( gui.DropDownItem('px'), 'px' )
         self.dropMeasureUnit.append( gui.DropDownItem('%'), '%' )
         self.dropMeasureUnit.select_by_key('px')
-        self.dropMeasureUnit.onchange.connect(self.onchange)
+        self.dropMeasureUnit.onchange.do(self.onchange)
         self.append(self.dropMeasureUnit)
 
     @gui.decorate_event
@@ -654,18 +654,18 @@ def __init__(self, appInstance, **kwargs):
 
         self.txtInput = gui.TextInput(width='80%', height='100%')
         self.txtInput.style['float'] = 'left'
-        self.txtInput.onchange.connect(self.on_txt_changed)
+        self.txtInput.onchange.do(self.on_txt_changed)
         self.append(self.txtInput)
 
         self.btFileFolderSelection = gui.Widget(width='20%', height='100%')
         self.btFileFolderSelection.style.update({'background-repeat':'round',
             'background-image':"url('/res:folder.png')",
             'background-color':'transparent'})
         self.append(self.btFileFolderSelection)
-        self.btFileFolderSelection.onclick.connect(self.on_file_selection_bt_pressed)
+        self.btFileFolderSelection.onclick.do(self.on_file_selection_bt_pressed)
 
         self.selectionDialog = gui.FileSelectionDialog('Select a file', '', False, './', True, False)
-        self.selectionDialog.confirm_value.connect(self.file_dialog_confirmed)
+        self.selectionDialog.confirm_value.do(self.file_dialog_confirmed)
 
     @gui.decorate_event
     def onchange(self, widget, value):
@@ -704,7 +704,7 @@ def __init__(self, attributeName, attributeDict, appInstance=None):
         self.EVENT_ATTRIB_ONREMOVE = 'onremove_attribute'
         self.removeAttribute = gui.Image('/editor_resources:delete.png', width='5%')
         self.removeAttribute.attributes['title'] = 'Remove attribute from this widget.'
-        self.removeAttribute.onclick.connect(self.on_attribute_remove)
+        self.removeAttribute.onclick.do(self.on_attribute_remove)
         self.append(self.removeAttribute)
 
         self.label = gui.Label(attributeName, width='45%', height=22, margin='0px')
@@ -734,7 +734,7 @@ def __init__(self, attributeName, attributeDict, appInstance=None):
         else: #default editor is string
             self.inputWidget = gui.TextInput()
 
-        self.inputWidget.onchange.connect(self.on_attribute_changed)
+        self.inputWidget.onchange.do(self.on_attribute_changed)
         self.inputWidget.set_size('50%','22px')
         self.inputWidget.attributes['title'] = attributeDict['description']
         self.label.attributes['title'] = attributeDict['description']

editor/prototypes.py

@@ -67,4 +67,4 @@ def construct_ui(self):
 
 proto_layout_append = "%(parentname)s.append(%(varname)s)\n        "
 
-proto_set_listener = "%(sourcename)s.%(register_function)s.connect(%(listenername)s.%(listener_function)s)\n        "
+proto_set_listener = "%(sourcename)s.%(register_function)s.do(%(listenername)s.%(listener_function)s)\n        "

examples/append_and_remove_widgets_app.py

@@ -27,11 +27,11 @@ def main(self):
         main_container = gui.VBox()
         lbl = gui.Label("Press the buttons to add or remove labels")
         bt_add = gui.Button("add a label", style={'margin':'3px'})
-        bt_add.onclick.connect(self.on_add_a_label_pressed)
+        bt_add.onclick.do(self.on_add_a_label_pressed)
         bt_remove = gui.Button("remove a label", style={'margin':'3px', 'background-color':'orange'})
-        bt_remove.onclick.connect(self.on_remove_a_label_pressed)
+        bt_remove.onclick.do(self.on_remove_a_label_pressed)
         bt_empty = gui.Button("empty", style={'margin':'3px', 'background-color':'red'})
-        bt_empty.onclick.connect(self.on_empty_pressed)
+        bt_empty.onclick.do(self.on_empty_pressed)
         self.lbls_container = gui.HBox()
         main_container.append([lbl, bt_add, bt_remove, bt_empty, self.lbls_container])
 

examples/closeable_app.py

@@ -30,7 +30,7 @@ def main(self, name='world'):
         bt.style['margin'] = 'auto 50px'
         bt.style['background-color'] = 'red'
 
-        bt.onclick.connect(self.on_button_pressed)
+        bt.onclick.do(self.on_button_pressed)
 
         wid.append(bt)
         return wid

examples/gauge_app.py

@@ -33,8 +33,8 @@ def __init__(self, width, height, _min, _max, **kwargs):
         self.gauge.set_value(_min)
         self.append(self.gauge)
 
-        self.onmousedown.connect(self.confirm_value)
-        self.onmousemove.connect(self.gauge.onmousemove)
+        self.onmousedown.do(self.confirm_value)
+        self.onmousemove.do(self.gauge.onmousemove)
 
     @gui.decorate_event
     def confirm_value(self, widget, x, y):