1 """GNUmed phrasewheel.
2
3 A class, extending wx.TextCtrl, which has a drop-down pick list,
4 automatically filled based on the inital letters typed. Based on the
5 interface of Richard Terry's Visual Basic client
6
7 This is based on seminal work by Ian Haywood <ihaywood@gnu.org>
8 """
9
10 __version__ = "$Revision: 1.136 $"
11 __author__ = "K.Hilbert <Karsten.Hilbert@gmx.net>, I.Haywood, S.J.Tan <sjtan@bigpond.com>"
12 __license__ = "GPL"
13
14
15 import string, types, time, sys, re as regex, os.path
16
17
18
19 import wx
20 import wx.lib.mixins.listctrl as listmixins
21
22
23
24 if __name__ == '__main__':
25 sys.path.insert(0, '../../')
26 from Gnumed.pycommon import gmTools
27 from Gnumed.pycommon import gmDispatcher
28
29
30 import logging
31 _log = logging.getLogger('macosx')
32
33
34 color_prw_invalid = 'pink'
35 color_prw_partially_invalid = 'yellow'
36 color_prw_valid = None
37
38
39 default_phrase_separators = r';+'
40 default_spelling_word_separators = r'[\W\d_]+'
41
42
43 NUMERIC = '0-9'
44 ALPHANUMERIC = 'a-zA-Z0-9'
45 EMAIL_CHARS = "a-zA-Z0-9\-_@\."
46 WEB_CHARS = "a-zA-Z0-9\.\-_/:"
47
48
49 _timers = []
50
52 """It can be useful to call this early from your shutdown code to avoid hangs on Notify()."""
53 global _timers
54 _log.info('shutting down %s pending timers', len(_timers))
55 for timer in _timers:
56 _log.debug('timer [%s]', timer)
57 timer.Stop()
58 _timers = []
59
61
63 wx.Timer.__init__(self, *args, **kwargs)
64 self.callback = lambda x:x
65 global _timers
66 _timers.append(self)
67
70
71
73
75 try:
76 kwargs['style'] = kwargs['style'] | wx.LC_REPORT | wx.LC_SINGLE_SEL | wx.SIMPLE_BORDER
77 except: pass
78 wx.ListCtrl.__init__(self, *args, **kwargs)
79 listmixins.ListCtrlAutoWidthMixin.__init__(self)
80
82 self.DeleteAllItems()
83 self.__data = items
84 pos = len(items) + 1
85 for item in items:
86 row_num = self.InsertStringItem(pos, label=item['list_label'])
87
89 sel_idx = self.GetFirstSelected()
90 if sel_idx == -1:
91 return None
92 return self.__data[sel_idx]['data']
93
95 sel_idx = self.GetFirstSelected()
96 if sel_idx == -1:
97 return None
98 return self.__data[sel_idx]
99
101 sel_idx = self.GetFirstSelected()
102 if sel_idx == -1:
103 return None
104 return self.__data[sel_idx]['list_label']
105
106
107
109 """Widget for smart guessing of user fields, after Richard Terry's interface.
110
111 - VB implementation by Richard Terry
112 - Python port by Ian Haywood for GNUmed
113 - enhanced by Karsten Hilbert for GNUmed
114 - enhanced by Ian Haywood for aumed
115 - enhanced by Karsten Hilbert for GNUmed
116
117 @param matcher: a class used to find matches for the current input
118 @type matcher: a L{match provider<Gnumed.pycommon.gmMatchProvider.cMatchProvider>}
119 instance or C{None}
120
121 @param selection_only: whether free-text can be entered without associated data
122 @type selection_only: boolean
123
124 @param capitalisation_mode: how to auto-capitalize input, valid values
125 are found in L{capitalize()<Gnumed.pycommon.gmTools.capitalize>}
126 @type capitalisation_mode: integer
127
128 @param accepted_chars: a regex pattern defining the characters
129 acceptable in the input string, if None no checking is performed
130 @type accepted_chars: None or a string holding a valid regex pattern
131
132 @param final_regex: when the control loses focus the input is
133 checked against this regular expression
134 @type final_regex: a string holding a valid regex pattern
135
136 @param navigate_after_selection: whether or not to immediately
137 navigate to the widget next-in-tab-order after selecting an
138 item from the dropdown picklist
139 @type navigate_after_selection: boolean
140
141 @param speller: if not None used to spellcheck the current input
142 and to retrieve suggested replacements/completions
143 @type speller: None or a L{enchant Dict<enchant>} descendant
144
145 @param picklist_delay: this much time of user inactivity must have
146 passed before the input related smarts kick in and the drop
147 down pick list is shown
148 @type picklist_delay: integer (milliseconds)
149 """
150 - def __init__ (self, parent=None, id=-1, *args, **kwargs):
151
152
153 self.matcher = None
154 self.selection_only = False
155 self.selection_only_error_msg = _('You must select a value from the picklist or type an exact match.')
156 self.capitalisation_mode = gmTools.CAPS_NONE
157 self.accepted_chars = None
158 self.final_regex = '.*'
159 self.final_regex_error_msg = _('The content is invalid. It must match the regular expression: [%%s]. <%s>') % self.__class__.__name__
160 self.navigate_after_selection = False
161 self.speller = None
162 self.speller_word_separators = default_spelling_word_separators
163 self.picklist_delay = 150
164
165
166 self._has_focus = False
167 self._current_match_candidates = []
168 self._screenheight = wx.SystemSettings.GetMetric(wx.SYS_SCREEN_Y)
169 self.suppress_text_update_smarts = False
170
171 self.__static_tt = None
172 self.__static_tt_extra = None
173
174
175 self._data = {}
176
177 self._on_selection_callbacks = []
178 self._on_lose_focus_callbacks = []
179 self._on_set_focus_callbacks = []
180 self._on_modified_callbacks = []
181
182 try:
183 kwargs['style'] = kwargs['style'] | wx.TE_PROCESS_TAB | wx.TE_PROCESS_ENTER
184 except KeyError:
185 kwargs['style'] = wx.TE_PROCESS_TAB | wx.TE_PROCESS_ENTER
186 super(cPhraseWheelBase, self).__init__(parent, id, **kwargs)
187
188 self.__my_startup_color = self.GetBackgroundColour()
189 self.__non_edit_font = self.GetFont()
190 global color_prw_valid
191 if color_prw_valid is None:
192 color_prw_valid = wx.SystemSettings_GetColour(wx.SYS_COLOUR_WINDOW)
193
194 self.__init_dropdown(parent = parent)
195 self.__register_events()
196 self.__init_timer()
197
198
199
200 - def GetData(self, can_create=False):
201 """Retrieve the data associated with the displayed string(s).
202
203 - self._create_data() must set self.data if possible (/successful)
204 """
205 if len(self._data) == 0:
206 if can_create:
207 self._create_data()
208
209 return self._data
210
211 - def SetText(self, value=u'', data=None, suppress_smarts=False):
212
213 if value is None:
214 value = u''
215
216 self.suppress_text_update_smarts = suppress_smarts
217
218 if data is not None:
219 self.suppress_text_update_smarts = True
220 self.data = self._dictify_data(data = data, value = value)
221 super(cPhraseWheelBase, self).SetValue(value)
222 self.display_as_valid(valid = True)
223
224
225 if len(self._data) > 0:
226 return True
227
228
229 if value == u'':
230
231 if not self.selection_only:
232 return True
233
234 if not self._set_data_to_first_match():
235
236 if self.selection_only:
237 self.display_as_valid(valid = False)
238 return False
239
240 return True
241
243 raise NotImplementedError('[%s]: set_from_instance()' % self.__class__.__name__)
244
246 raise NotImplementedError('[%s]: set_from_pk()' % self.__class__.__name__)
247
249 if valid is True:
250 self.SetBackgroundColour(self.__my_startup_color)
251 elif valid is False:
252 if partially_invalid:
253 self.SetBackgroundColour(color_prw_partially_invalid)
254 else:
255 self.SetBackgroundColour(color_prw_invalid)
256 else:
257 raise ValueError(u'<valid> must be True or False')
258 self.Refresh()
259
261 if disabled is True:
262 self.SetBackgroundColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BACKGROUND))
263 elif disabled is False:
264 self.SetBackgroundColour(color_prw_valid)
265 else:
266 raise ValueError(u'<disabled> must be True or False')
267 self.Refresh()
268
269
270
272 """Add a callback for invocation when a picklist item is selected.
273
274 The callback will be invoked whenever an item is selected
275 from the picklist. The associated data is passed in as
276 a single parameter. Callbacks must be able to cope with
277 None as the data parameter as that is sent whenever the
278 user changes a previously selected value.
279 """
280 if not callable(callback):
281 raise ValueError('[add_callback_on_selection]: ignoring callback [%s], it is not callable' % callback)
282
283 self._on_selection_callbacks.append(callback)
284
286 """Add a callback for invocation when getting focus."""
287 if not callable(callback):
288 raise ValueError('[add_callback_on_set_focus]: ignoring callback [%s] - not callable' % callback)
289
290 self._on_set_focus_callbacks.append(callback)
291
293 """Add a callback for invocation when losing focus."""
294 if not callable(callback):
295 raise ValueError('[add_callback_on_lose_focus]: ignoring callback [%s] - not callable' % callback)
296
297 self._on_lose_focus_callbacks.append(callback)
298
300 """Add a callback for invocation when the content is modified."""
301 if not callable(callback):
302 raise ValueError('[add_callback_on_modified]: ignoring callback [%s] - not callable' % callback)
303
304 self._on_modified_callbacks.append(callback)
305
306
307
308 - def set_context(self, context=None, val=None):
309 if self.matcher is not None:
310 self.matcher.set_context(context=context, val=val)
311
312 - def unset_context(self, context=None):
313 if self.matcher is not None:
314 self.matcher.unset_context(context=context)
315
316
317
319
320 try:
321 import enchant
322 except ImportError:
323 self.speller = None
324 return False
325
326 try:
327 self.speller = enchant.DictWithPWL(None, os.path.expanduser(os.path.join('~', '.gnumed', 'spellcheck', 'wordlist.pwl')))
328 except enchant.DictNotFoundError:
329 self.speller = None
330 return False
331
332 return True
333
335 if self.speller is None:
336 return None
337
338
339 last_word = self.__speller_word_separators.split(val)[-1]
340 if last_word.strip() == u'':
341 return None
342
343 try:
344 suggestions = self.speller.suggest(last_word)
345 except:
346 _log.exception('had to disable (enchant) spell checker')
347 self.speller = None
348 return None
349
350 if len(suggestions) == 0:
351 return None
352
353 input2match_without_last_word = val[:val.rindex(last_word)]
354 return [ input2match_without_last_word + suggestion for suggestion in suggestions ]
355
361
363 return self.__speller_word_separators.pattern
364
365 speller_word_separators = property(_get_speller_word_separators, _set_speller_word_separators)
366
367
368
369
370
372 szr_dropdown = None
373 try:
374
375 self.__dropdown_needs_relative_position = False
376 self._picklist_dropdown = wx.PopupWindow(parent)
377 list_parent = self._picklist_dropdown
378 self.__use_fake_popup = False
379 except NotImplementedError:
380 self.__use_fake_popup = True
381
382
383 add_picklist_to_sizer = True
384 szr_dropdown = wx.BoxSizer(wx.VERTICAL)
385
386
387 self.__dropdown_needs_relative_position = False
388 self._picklist_dropdown = wx.MiniFrame (
389 parent = parent,
390 id = -1,
391 style = wx.SIMPLE_BORDER | wx.FRAME_FLOAT_ON_PARENT | wx.FRAME_NO_TASKBAR | wx.POPUP_WINDOW
392 )
393 scroll_win = wx.ScrolledWindow(parent = self._picklist_dropdown, style = wx.NO_BORDER)
394 scroll_win.SetSizer(szr_dropdown)
395 list_parent = scroll_win
396
397
398
399
400
401
402
403 self.__mac_log('dropdown parent: %s' % self._picklist_dropdown.GetParent())
404
405 self._picklist = cPhraseWheelListCtrl (
406 list_parent,
407 style = wx.LC_NO_HEADER
408 )
409 self._picklist.InsertColumn(0, u'')
410
411 if szr_dropdown is not None:
412 szr_dropdown.Add(self._picklist, 1, wx.EXPAND)
413
414 self._picklist_dropdown.Hide()
415
417 """Display the pick list if useful."""
418
419 self._picklist_dropdown.Hide()
420
421 if not self._has_focus:
422 return
423
424 if len(self._current_match_candidates) == 0:
425 return
426
427
428
429 if len(self._current_match_candidates) == 1:
430 candidate = self._current_match_candidates[0]
431 if candidate['field_label'] == input2match:
432 self._update_data_from_picked_item(candidate)
433 return
434
435
436 dropdown_size = self._picklist_dropdown.GetSize()
437 border_width = 4
438 extra_height = 25
439
440 rows = len(self._current_match_candidates)
441 if rows < 2:
442 rows = 2
443 if rows > 20:
444 rows = 20
445 self.__mac_log('dropdown needs rows: %s' % rows)
446 pw_size = self.GetSize()
447 dropdown_size.SetHeight (
448 (pw_size.height * rows)
449 + border_width
450 + extra_height
451 )
452
453 dropdown_size.SetWidth(min (
454 self.Size.width * 2,
455 self.Parent.Size.width
456 ))
457
458
459 (pw_x_abs, pw_y_abs) = self.ClientToScreenXY(0,0)
460 self.__mac_log('phrasewheel position (on screen): x:%s-%s, y:%s-%s' % (pw_x_abs, (pw_x_abs+pw_size.width), pw_y_abs, (pw_y_abs+pw_size.height)))
461 dropdown_new_x = pw_x_abs
462 dropdown_new_y = pw_y_abs + pw_size.height
463 self.__mac_log('desired dropdown position (on screen): x:%s-%s, y:%s-%s' % (dropdown_new_x, (dropdown_new_x+dropdown_size.width), dropdown_new_y, (dropdown_new_y+dropdown_size.height)))
464 self.__mac_log('desired dropdown size: %s' % dropdown_size)
465
466
467 if (dropdown_new_y + dropdown_size.height) > self._screenheight:
468 self.__mac_log('dropdown extends offscreen (screen max y: %s)' % self._screenheight)
469 max_height = self._screenheight - dropdown_new_y - 4
470 self.__mac_log('max dropdown height would be: %s' % max_height)
471 if max_height > ((pw_size.height * 2) + 4):
472 dropdown_size.SetHeight(max_height)
473 self.__mac_log('possible dropdown position (on screen): x:%s-%s, y:%s-%s' % (dropdown_new_x, (dropdown_new_x+dropdown_size.width), dropdown_new_y, (dropdown_new_y+dropdown_size.height)))
474 self.__mac_log('possible dropdown size: %s' % dropdown_size)
475
476
477 self._picklist_dropdown.SetSize(dropdown_size)
478 self._picklist.SetSize(self._picklist_dropdown.GetClientSize())
479 self.__mac_log('pick list size set to: %s' % self._picklist_dropdown.GetSize())
480 if self.__dropdown_needs_relative_position:
481 dropdown_new_x, dropdown_new_y = self._picklist_dropdown.GetParent().ScreenToClientXY(dropdown_new_x, dropdown_new_y)
482 self._picklist_dropdown.MoveXY(dropdown_new_x, dropdown_new_y)
483
484
485 self._picklist.Select(0)
486
487
488 self._picklist_dropdown.Show(True)
489
490
491
492
493
494
495
496
497
498
499
501 """Hide the pick list."""
502 self._picklist_dropdown.Hide()
503
505 """Mark the given picklist row as selected."""
506 if old_row_idx is not None:
507 pass
508 self._picklist.Select(new_row_idx)
509 self._picklist.EnsureVisible(new_row_idx)
510
512 """Get string to display in the field for the given picklist item."""
513 if item is None:
514 item = self._picklist.get_selected_item()
515 try:
516 return item['field_label']
517 except KeyError:
518 pass
519 try:
520 return item['list_label']
521 except KeyError:
522 pass
523 try:
524 return item['label']
525 except KeyError:
526 return u'<no field_*/list_*/label in item>'
527
528
530 """Update the display to show item strings."""
531
532 display_string = self._picklist_item2display_string(item = item)
533 self.suppress_text_update_smarts = True
534 super(cPhraseWheelBase, self).SetValue(display_string)
535
536 self.SetInsertionPoint(self.GetLastPosition())
537 return
538
539
540
542 raise NotImplementedError('[%s]: fragment extraction not implemented' % self.__class__.__name__)
543
545 """Get candidates matching the currently typed input."""
546
547
548 self._current_match_candidates = []
549 if self.matcher is not None:
550 matched, self._current_match_candidates = self.matcher.getMatches(val)
551 self._picklist.SetItems(self._current_match_candidates)
552
553
554
555
556
557 if len(self._current_match_candidates) == 0:
558 suggestions = self._get_suggestions_from_spell_checker(val)
559 if suggestions is not None:
560 self._current_match_candidates = [
561 {'list_label': suggestion, 'field_label': suggestion, 'data': None}
562 for suggestion in suggestions
563 ]
564 self._picklist.SetItems(self._current_match_candidates)
565
566
567
571
617
619 return self.__static_tt_extra
620
622 self.__static_tt_extra = tt
623
624 static_tooltip_extra = property(_get_static_tt_extra, _set_static_tt_extra)
625
626
627
629 wx.EVT_KEY_DOWN (self, self._on_key_down)
630 wx.EVT_SET_FOCUS(self, self._on_set_focus)
631 wx.EVT_KILL_FOCUS(self, self._on_lose_focus)
632 wx.EVT_TEXT(self, self.GetId(), self._on_text_update)
633 self._picklist.Bind(wx.EVT_LEFT_DCLICK, self._on_list_item_selected)
634
636 """Is called when a key is pressed."""
637
638 keycode = event.GetKeyCode()
639
640 if keycode == wx.WXK_DOWN:
641 self.__on_cursor_down()
642 return
643
644 if keycode == wx.WXK_UP:
645 self.__on_cursor_up()
646 return
647
648 if keycode == wx.WXK_RETURN:
649 self._on_enter()
650 return
651
652 if keycode == wx.WXK_TAB:
653 if event.ShiftDown():
654 self.Navigate(flags = wx.NavigationKeyEvent.IsBackward)
655 return
656 self.__on_tab()
657 self.Navigate(flags = wx.NavigationKeyEvent.IsForward)
658 return
659
660
661 if keycode in [wx.WXK_SHIFT, wx.WXK_BACK, wx.WXK_DELETE, wx.WXK_LEFT, wx.WXK_RIGHT]:
662 pass
663
664
665 elif not self.__char_is_allowed(char = unichr(event.GetUnicodeKey())):
666 wx.Bell()
667
668 return
669
670 event.Skip()
671 return
672
674
675 self._has_focus = True
676 event.Skip()
677
678 self.__non_edit_font = self.GetFont()
679 edit_font = self.GetFont()
680 edit_font.SetPointSize(pointSize = self.__non_edit_font.GetPointSize() + 1)
681 self.SetFont(edit_font)
682 self.Refresh()
683
684
685 for callback in self._on_set_focus_callbacks:
686 callback()
687
688 self.__timer.Start(oneShot = True, milliseconds = self.picklist_delay)
689 return True
690
692 """Do stuff when leaving the control.
693
694 The user has had her say, so don't second guess
695 intentions but do report error conditions.
696 """
697 self._has_focus = False
698
699 self.__timer.Stop()
700 self._hide_picklist()
701 self.SetSelection(1,1)
702 self.SetFont(self.__non_edit_font)
703 self.Refresh()
704
705 is_valid = True
706
707
708
709
710 self._set_data_to_first_match()
711
712
713 if self.__final_regex.match(self.GetValue().strip()) is None:
714 gmDispatcher.send(signal = 'statustext', msg = self.final_regex_error_msg)
715 is_valid = False
716
717 self.display_as_valid(valid = is_valid)
718
719
720 for callback in self._on_lose_focus_callbacks:
721 callback()
722
723 event.Skip()
724 return True
725
727 """Gets called when user selected a list item."""
728
729 self._hide_picklist()
730
731 item = self._picklist.get_selected_item()
732
733 if item is None:
734 self.display_as_valid(valid = True)
735 return
736
737 self._update_display_from_picked_item(item)
738 self._update_data_from_picked_item(item)
739 self.MarkDirty()
740
741
742 for callback in self._on_selection_callbacks:
743 callback(self._data)
744
745 if self.navigate_after_selection:
746 self.Navigate()
747
748 return
749
750 - def _on_text_update (self, event):
751 """Internal handler for wx.EVT_TEXT.
752
753 Called when text was changed by user or by SetValue().
754 """
755 if self.suppress_text_update_smarts:
756 self.suppress_text_update_smarts = False
757 return
758
759 self._adjust_data_after_text_update()
760 self._current_match_candidates = []
761
762 val = self.GetValue().strip()
763 ins_point = self.GetInsertionPoint()
764
765
766
767 if val == u'':
768 self._hide_picklist()
769 self.__timer.Stop()
770 else:
771 new_val = gmTools.capitalize(text = val, mode = self.capitalisation_mode)
772 if new_val != val:
773 self.suppress_text_update_smarts = True
774 super(cPhraseWheelBase, self).SetValue(new_val)
775 if ins_point > len(new_val):
776 self.SetInsertionPointEnd()
777 else:
778 self.SetInsertionPoint(ins_point)
779
780
781
782 self.__timer.Start(oneShot = True, milliseconds = self.picklist_delay)
783
784
785 for callback in self._on_modified_callbacks:
786 callback()
787
788 return
789
790
791
793 """Called when the user pressed <ENTER>."""
794 if self._picklist_dropdown.IsShown():
795 self._on_list_item_selected()
796 else:
797
798 self.Navigate()
799
801
802 if self._picklist_dropdown.IsShown():
803 idx_selected = self._picklist.GetFirstSelected()
804 if idx_selected < (len(self._current_match_candidates) - 1):
805 self._select_picklist_row(idx_selected + 1, idx_selected)
806 return
807
808
809
810
811
812 self.__timer.Stop()
813 if self.GetValue().strip() == u'':
814 val = u'*'
815 else:
816 val = self._extract_fragment_to_match_on()
817 self._update_candidates_in_picklist(val = val)
818 self._show_picklist(input2match = val)
819
821 if self._picklist_dropdown.IsShown():
822 selected = self._picklist.GetFirstSelected()
823 if selected > 0:
824 self._select_picklist_row(selected-1, selected)
825 else:
826
827 pass
828
830 """Under certain circumstances take special action on <TAB>.
831
832 returns:
833 True: <TAB> was handled
834 False: <TAB> was not handled
835
836 -> can be used to decide whether to do further <TAB> handling outside this class
837 """
838
839 if not self._picklist_dropdown.IsShown():
840 return False
841
842
843 if len(self._current_match_candidates) != 1:
844 return False
845
846
847 if not self.selection_only:
848 return False
849
850
851 self._select_picklist_row(new_row_idx = 0)
852 self._on_list_item_selected()
853
854 return True
855
856
857
859 self.__timer = _cPRWTimer()
860 self.__timer.callback = self._on_timer_fired
861
862 self.__timer.Stop()
863
865 """Callback for delayed match retrieval timer.
866
867 if we end up here:
868 - delay has passed without user input
869 - the value in the input field has not changed since the timer started
870 """
871
872 val = self._extract_fragment_to_match_on()
873 self._update_candidates_in_picklist(val = val)
874
875
876
877
878
879
880 wx.CallAfter(self._show_picklist, input2match = val)
881
882
883
885 if self.__use_fake_popup:
886 _log.debug(msg)
887
889
890 if self.accepted_chars is None:
891 return True
892 return (self.__accepted_chars.match(char) is not None)
893
899
901 if self.__accepted_chars is None:
902 return None
903 return self.__accepted_chars.pattern
904
905 accepted_chars = property(_get_accepted_chars, _set_accepted_chars)
906
908 self.__final_regex = regex.compile(final_regex, flags = regex.LOCALE | regex.UNICODE)
909
911 return self.__final_regex.pattern
912
913 final_regex = property(_get_final_regex, _set_final_regex)
914
916 self.__final_regex_error_msg = msg % self.final_regex
917
919 return self.__final_regex_error_msg
920
921 final_regex_error_msg = property(_get_final_regex_error_msg, _set_final_regex_error_msg)
922
923
924
927
929 self.data = {item['field_label']: item}
930
932 raise NotImplementedError('[%s]: _dictify_data()' % self.__class__.__name__)
933
935 raise NotImplementedError('[%s]: cannot adjust data after text update' % self.__class__.__name__)
936
941
943 raise NotImplementedError('[%s]: cannot create data object' % self.__class__.__name__)
944
947
949 self._data = data
950 self.__recalculate_tooltip()
951
952 data = property(_get_data, _set_data)
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1023
1024 - def GetData(self, can_create=False, as_instance=False):
1025
1026 super(cPhraseWheel, self).GetData(can_create = can_create)
1027
1028 if len(self._data) > 0:
1029 if as_instance:
1030 return self._data2instance()
1031
1032 if len(self._data) == 0:
1033 return None
1034
1035 return self._data.values()[0]['data']
1036
1038 """Set the data and thereby set the value, too. if possible.
1039
1040 If you call SetData() you better be prepared
1041 doing a scan of the entire potential match space.
1042
1043 The whole thing will only work if data is found
1044 in the match space anyways.
1045 """
1046
1047 self._update_candidates_in_picklist(u'*')
1048
1049
1050 if self.selection_only:
1051
1052 if len(self._current_match_candidates) == 0:
1053 return False
1054
1055
1056 for candidate in self._current_match_candidates:
1057 if candidate['data'] == data:
1058 super(cPhraseWheel, self).SetText (
1059 value = candidate['field_label'],
1060 data = data,
1061 suppress_smarts = True
1062 )
1063 return True
1064
1065
1066 if self.selection_only:
1067 self.display_as_valid(valid = False)
1068 return False
1069
1070 self.data = self._dictify_data(data = data)
1071 self.display_as_valid(valid = True)
1072 return True
1073
1074
1075
1077
1078
1079
1080
1081 if len(self._data) > 0:
1082 self._picklist_dropdown.Hide()
1083 return
1084
1085 return super(cPhraseWheel, self)._show_picklist(input2match = input2match)
1086
1088
1089 if len(self._data) > 0:
1090 return True
1091
1092
1093 val = self.GetValue().strip()
1094 if val == u'':
1095 return True
1096
1097
1098 self._update_candidates_in_picklist(val = val)
1099 for candidate in self._current_match_candidates:
1100 if candidate['field_label'] == val:
1101 self.data = {candidate['field_label']: candidate}
1102 self.MarkDirty()
1103 return True
1104
1105
1106 if self.selection_only:
1107 gmDispatcher.send(signal = 'statustext', msg = self.selection_only_error_msg)
1108 is_valid = False
1109 return False
1110
1111 return True
1112
1115
1118
1124
1126
1135
1136 - def GetData(self, can_create=False, as_instance=False):
1137
1138 super(cMultiPhraseWheel, self).GetData(can_create = can_create)
1139
1140 if len(self._data) > 0:
1141 if as_instance:
1142 return self._data2instance()
1143
1144 return self._data.values()
1145
1147 self.speller = None
1148 return True
1149
1151
1152 data_dict = {}
1153
1154 for item in data_items:
1155 try:
1156 list_label = item['list_label']
1157 except KeyError:
1158 list_label = item['label']
1159 try:
1160 field_label = item['field_label']
1161 except KeyError:
1162 field_label = list_label
1163 data_dict[field_label] = {'data': item['data'], 'list_label': list_label, 'field_label': field_label}
1164
1165 return data_dict
1166
1167
1168
1171
1173
1174 new_data = {}
1175
1176
1177 for displayed_label in self.displayed_strings:
1178 try:
1179 new_data[displayed_label] = self._data[displayed_label]
1180 except KeyError:
1181
1182
1183 pass
1184
1185 self.data = new_data
1186
1188
1189 cursor_pos = self.GetInsertionPoint()
1190
1191 entire_input = self.GetValue()
1192 if self.__phrase_separators.search(entire_input) is None:
1193 self.left_part = u''
1194 self.right_part = u''
1195 return self.GetValue().strip()
1196
1197 string_left_of_cursor = entire_input[:cursor_pos]
1198 string_right_of_cursor = entire_input[cursor_pos:]
1199
1200 left_parts = [ lp.strip() for lp in self.__phrase_separators.split(string_left_of_cursor) ]
1201 if len(left_parts) == 0:
1202 self.left_part = u''
1203 else:
1204 self.left_part = u'%s%s ' % (
1205 (u'%s ' % self.__phrase_separators.pattern[0]).join(left_parts[:-1]),
1206 self.__phrase_separators.pattern[0]
1207 )
1208
1209 right_parts = [ rp.strip() for rp in self.__phrase_separators.split(string_right_of_cursor) ]
1210 self.right_part = u'%s %s' % (
1211 self.__phrase_separators.pattern[0],
1212 (u'%s ' % self.__phrase_separators.pattern[0]).join(right_parts[1:])
1213 )
1214
1215 val = (left_parts[-1] + right_parts[0]).strip()
1216 return val
1217
1219 val = (u'%s%s%s' % (
1220 self.left_part,
1221 self._picklist_item2display_string(item = item),
1222 self.right_part
1223 )).lstrip().lstrip(';').strip()
1224 self.suppress_text_update_smarts = True
1225 super(cMultiPhraseWheel, self).SetValue(val)
1226
1227 item_end = val.index(item['field_label']) + len(item['field_label'])
1228 self.SetInsertionPoint(item_end)
1229 return
1230
1232
1233
1234 self._data[item['field_label']] = item
1235
1236
1237 field_labels = [ p.strip() for p in self.__phrase_separators.split(self.GetValue().strip()) ]
1238 new_data = {}
1239
1240
1241 for field_label in field_labels:
1242 try:
1243 new_data[field_label] = self._data[field_label]
1244 except KeyError:
1245
1246
1247 pass
1248
1249 self.data = new_data
1250
1257
1258
1259
1261 """Set phrase separators.
1262
1263 - must be a valid regular expression pattern
1264
1265 input is split into phrases at boundaries defined by
1266 this regex and matching is performed on the phrase
1267 the cursor is in only,
1268
1269 after selection from picklist phrase_separators[0] is
1270 added to the end of the match in the PRW
1271 """
1272 self.__phrase_separators = regex.compile(phrase_separators, flags = regex.LOCALE | regex.UNICODE)
1273
1275 return self.__phrase_separators.pattern
1276
1277 phrase_separators = property(_get_phrase_separators, _set_phrase_separators)
1278
1280 return [ p.strip() for p in self.__phrase_separators.split(self.GetValue().strip()) if p.strip() != u'' ]
1281
1282 displayed_strings = property(_get_displayed_strings, lambda x:x)
1283
1284
1285
1286 if __name__ == '__main__':
1287
1288 if len(sys.argv) < 2:
1289 sys.exit()
1290
1291 if sys.argv[1] != u'test':
1292 sys.exit()
1293
1294 from Gnumed.pycommon import gmI18N
1295 gmI18N.activate_locale()
1296 gmI18N.install_domain(domain='gnumed')
1297
1298 from Gnumed.pycommon import gmPG2, gmMatchProvider
1299
1300 prw = None
1301
1303 print "got focus:"
1304 print "value:", prw.GetValue()
1305 print "data :", prw.GetData()
1306 return True
1307
1309 print "lost focus:"
1310 print "value:", prw.GetValue()
1311 print "data :", prw.GetData()
1312 return True
1313
1315 print "modified:"
1316 print "value:", prw.GetValue()
1317 print "data :", prw.GetData()
1318 return True
1319
1321 print "selected:"
1322 print "value:", prw.GetValue()
1323 print "data :", prw.GetData()
1324 return True
1325
1326
1328 app = wx.PyWidgetTester(size = (200, 50))
1329
1330 items = [ {'data': 1, 'list_label': "Bloggs", 'field_label': "Bloggs", 'weight': 0},
1331 {'data': 2, 'list_label': "Baker", 'field_label': "Baker", 'weight': 0},
1332 {'data': 3, 'list_label': "Jones", 'field_label': "Jones", 'weight': 0},
1333 {'data': 4, 'list_label': "Judson", 'field_label': "Judson", 'weight': 0},
1334 {'data': 5, 'list_label': "Jacobs", 'field_label': "Jacobs", 'weight': 0},
1335 {'data': 6, 'list_label': "Judson-Jacobs", 'field_label': "Judson-Jacobs", 'weight': 0}
1336 ]
1337
1338 mp = gmMatchProvider.cMatchProvider_FixedList(items)
1339
1340 mp.word_separators = '[ \t=+&:@]+'
1341 global prw
1342 prw = cPhraseWheel(parent = app.frame, id = -1)
1343 prw.matcher = mp
1344 prw.capitalisation_mode = gmTools.CAPS_NAMES
1345 prw.add_callback_on_set_focus(callback=display_values_set_focus)
1346 prw.add_callback_on_modified(callback=display_values_modified)
1347 prw.add_callback_on_lose_focus(callback=display_values_lose_focus)
1348 prw.add_callback_on_selection(callback=display_values_selected)
1349
1350 app.frame.Show(True)
1351 app.MainLoop()
1352
1353 return True
1354
1356 print "Do you want to test the database connected phrase wheel ?"
1357 yes_no = raw_input('y/n: ')
1358 if yes_no != 'y':
1359 return True
1360
1361 gmPG2.get_connection()
1362 query = u"""SELECT code, code || ': ' || _(name), _(name) FROM dem.country WHERE _(name) %(fragment_condition)s"""
1363 mp = gmMatchProvider.cMatchProvider_SQL2(queries = [query])
1364 app = wx.PyWidgetTester(size = (400, 50))
1365 global prw
1366
1367 prw = cMultiPhraseWheel(parent = app.frame, id = -1)
1368 prw.matcher = mp
1369
1370 app.frame.Show(True)
1371 app.MainLoop()
1372
1373 return True
1374
1376 gmPG2.get_connection()
1377 query = u"""
1378 select
1379 pk_identity,
1380 firstnames || ' ' || lastnames || ', ' || to_char(dob, 'YYYY-MM-DD'),
1381 firstnames || ' ' || lastnames
1382 from
1383 dem.v_basic_person
1384 where
1385 firstnames || lastnames %(fragment_condition)s
1386 """
1387 mp = gmMatchProvider.cMatchProvider_SQL2(queries = [query])
1388 app = wx.PyWidgetTester(size = (500, 50))
1389 global prw
1390 prw = cPhraseWheel(parent = app.frame, id = -1)
1391 prw.matcher = mp
1392 prw.selection_only = True
1393
1394 app.frame.Show(True)
1395 app.MainLoop()
1396
1397 return True
1398
1416
1417
1418
1419
1420 test_prw_patients()
1421
1422
1423