backend, frontends: callbacks refactoring:

- launchAction is now async, and return a dictionary for its result
    - no more action_id, actionResult* are deprecated
    - callback system is about to be unified
This commit is contained in:
Goffi 2013-12-24 15:19:08 +01:00
commit 069a250b04
3 changed files with 151 additions and 78 deletions

View file

@ -238,6 +238,39 @@ class MainWindow(wx.Frame, QuickApp):
self.tools.Disable()
return
def launchAction(self, callback_id, data=None, profile_key="@NONE@"):
""" Launch a dynamic action
@param callback_id: id of the action to launch
@param data: data needed only for certain actions
@param profile_key: %(doc_profile_key)s
"""
if data is None:
data = dict()
def action_cb(data):
if not data:
# action was a one shot, nothing to do
pass
elif "xmlui" in data:
debug (_("XML user interface received"))
XMLUI(self, xml_data = data['xmlui'])
else:
dlg = wx.MessageDialog(self, _(u"Unmanaged action result"),
_('Error'),
wx.OK | wx.ICON_ERROR
)
dlg.ShowModal()
dlg.Destroy()
def action_eb(failure):
dlg = wx.MessageDialog(self, unicode(failure),
_('Error'),
wx.OK | wx.ICON_ERROR
)
dlg.ShowModal()
dlg.Destroy()
self.bridge.launchAction(callback_id, data, profile_key, callback=action_cb, errback=action_eb)
def askConfirmation(self, confirmation_id, confirmation_type, data, profile):
#TODO: refactor this in QuickApp
if not self.check_profile(profile):

View file

@ -129,9 +129,7 @@ class Param(wx.Frame):
self.__save_parameters()
name, category = event.GetEventObject().param_id
callback_id = event.GetEventObject().callback_id
data = {"name":name, "category":category, "callback_id":callback_id}
id = self.host.bridge.launchAction("button", data, profile_key = self.host.profile)
self.host.current_action_ids.add(id)
self.host.launchAction(callback_id, None, profile_key = self.host.profile)
event.Skip()
def __save_parameters(self):

View file

@ -30,11 +30,13 @@ class XMLUI(wx.Frame):
"""Create an user interface from a SàT xml"""
def __init__(self, host, xml_data='', title="Form", options = None, misc = None):
style = wx.DEFAULT_FRAME_STYLE & ~wx.CLOSE_BOX if 'NO_CANCEL' in options else wx.DEFAULT_FRAME_STYLE #FIXME: gof: Q&D tmp hack
if options is None:
options = []
style = wx.DEFAULT_FRAME_STYLE & ~wx.CLOSE_BOX if 'NO_CANCEL' in options else wx.DEFAULT_FRAME_STYLE #FIXME: Q&D tmp hack
super(XMLUI, self).__init__(None, title=title, style=style)
self.host = host
self.options = options or []
self.options = options
self.misc = misc or {}
self.ctrl_list = {} # usefull to access ctrl
@ -165,6 +167,7 @@ class XMLUI(wx.Frame):
top= cat_dom.documentElement
self.type = top.getAttribute("type")
self.title = top .getAttribute("title")
self.submit_id = top.getAttribute("submit") or None
if self.title:
self.SetTitle(self.title)
if top.nodeName != "sat_xmlui" or not self.type in ['form', 'param', 'window']:
@ -195,7 +198,6 @@ class XMLUI(wx.Frame):
def onButtonClicked(self, event):
"""Called when a button is pushed"""
callback_id, fields = event.GetEventObject().param_id
data = {"callback_id":callback_id}
for field in fields:
ctrl = self.ctrl_list[field]
if isinstance(ctrl['control'], wx.ListBox):
@ -203,8 +205,7 @@ class XMLUI(wx.Frame):
else:
data[field] = ctrl['control'].GetValue()
id = self.host.bridge.launchAction("button", data, profile_key = self.host.profile)
self.host.current_action_ids.add(id)
self.host.launchAction(callback_id, None, profile_key = self.host.profile)
event.Skip()
def onFormSubmitted(self, event):
@ -224,6 +225,10 @@ class XMLUI(wx.Frame):
self.host.current_action_ids.add(id)
elif self.misc.has_key('callback'):
self.misc['callback'](data)
elif self.submit_id is not None:
data = dict(selected_values)
self.host.launchAction(self.submit_id, data, profile_key=self.host.profile)
else:
warning (_("The form data is not sent back, the type is not managed properly"))
self.MakeModal(False)