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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
|
"""GNUmed Horst-space inner-frame layout manager.
This implements the simple wx.Notebook based layout as
originally suggested by Horst Herb.
copyright: authors
"""
#==============================================================================
__author__ = "H. Herb <hherb@gnumed.net>,\
K. Hilbert <Karsten.Hilbert@gmx.net>,\
I. Haywood <i.haywood@ugrad.unimelb.edu.au>"
__license__ = 'GPL v2 or later (details at http://www.gnu.org)'
import os.path, os, sys, logging
import wx
from Gnumed.pycommon import gmGuiBroker, gmI18N, gmDispatcher, gmCfg, gmLog2
from Gnumed.wxpython import gmPlugin, gmTopPanel, gmGuiHelpers
from Gnumed.business import gmPerson, gmPraxis
_log = logging.getLogger('gm.ui')
#==============================================================================
class cHorstSpaceNotebook(wx.Notebook): # wx.BestBook ?
def __init__(self, *args, **kwargs):
nb_tab_pos = gmCfg.cCfgSQL().get2 (
option = 'horstspace.notebook.tab_position',
workplace = gmPraxis.gmCurrentPraxisBranch().active_workplace,
bias = 'user',
default = 'bottom'
)
match nb_tab_pos:
case 'top':
nb_tab_pos = wx.NB_TOP
case 'bottom':
nb_tab_pos = wx.NB_BOTTOM
case 'left':
nb_tab_pos = wx.NB_LEFT
case 'right':
nb_tab_pos = wx.NB_RIGHT
case _:
nb_tab_pos = wx.NB_BOTTOM
kwargs['style'] = nb_tab_pos
kwargs['id'] = -1
wx.Notebook.__init__(self, *args, **kwargs)
_log.debug('created wx.Notebook: %s with ID %s', self.__class__.__name__, self.Id)
#self.__register_events()
#----------------------------------------------
# internal API
#----------------------------------------------
def __register_events(self):
# because of
# https://www.wiki.wxpython.org/self.Bind%20vs.%20self.button.Bind
# do self.Bind() rather than self.nb.Bind()
# - notebook page is about to change
#self.nb.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGING, self._on_notebook_page_changing)
#self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGING, self._on_notebook_page_changing, self)
self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGING, self._on_notebook_page_changing)
# - notebook page has been changed
#self.nb.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self._on_notebook_page_changed)
#self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self._on_notebook_page_changed, self)
self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self._on_notebook_page_changed)
# - popup menu on right click in notebook
#wx.EVT_RIGHT_UP(self.nb, self._on_right_click)
#----------------------------------------------
# event handlers
#----------------------------------------------
def _on_notebook_page_changing(self, event):
"""Called before notebook page change is processed."""
_log.debug('just before switching notebook tabs')
_log.debug('id: %s', event.Id)
_log.debug('event object (= source notebook): %s = %s', event.EventObject.Id, event.EventObject)
_log.debug('this notebook (= event receiver): %s = %s', self.Id, self)
if event.EventObject.Id != self.Id:
_log.error('this event came from another notebook')
self.__target_page_already_checked = False
self.__id_nb_page_before_switch = self.GetSelection()
self.__id_evt_page_before_switch = event.GetOldSelection()
__id_evt_page_after_switch = event.GetSelection()
_log.debug('source/target page state in EVT_NOTEBOOK_PAGE_CHANGING:')
_log.debug(' #1 - notebook current page: %s (= notebook.GetSelection())', self.__id_nb_page_before_switch)
_log.debug(' #2 - event source page: %s (= page event says it is coming from, event.GetOldSelection())', self.__id_evt_page_before_switch)
_log.debug(' #3 - event target page: %s (= page event wants to go to, event.GetSelection())', __id_evt_page_after_switch)
if self.__id_evt_page_before_switch != self.__id_nb_page_before_switch:
_log.warning(' problem: #1 and #2 really should match but do not')
# can we check the target page ?
if __id_evt_page_after_switch == self.__id_evt_page_before_switch:
# no, so complain
# (the docs say that on Windows GetSelection() returns the
# old page ID, eg. the same value GetOldSelection() returns)
_log.debug('this system is: sys: [%s] wx: [%s]', sys.platform, wx.Platform)
_log.debug('it seems to be one of those platforms that have no clue which notebook page they are switching to')
_log.debug('(Windows is documented to return the old page from both evt.GetOldSelection() and evt.GetSelection())')
_log.debug('current notebook page : %s', self.__id_nb_page_before_switch)
_log.debug('source page from event: %s', self.__id_evt_page_before_switch)
_log.debug('target page from event: %s', __id_evt_page_after_switch)
_log.warning('cannot check whether notebook page change needs to be vetoed')
# but let's do a basic check anyways
pat = gmPerson.gmCurrentPatient()
if not pat.connected:
gmDispatcher.send(signal = 'statustext', msg =_('Cannot change notebook tabs. No active patient.'))
event.Veto()
return
# that test passed, so let's hope things are fine
event.Allow() # redundant ?
event.Skip()
return
# check target page
target_page = self.__gb['horstspace.notebook.pages'][__id_evt_page_after_switch]
_log.debug('checking event target page for focussability: %s', target_page)
if not target_page.can_receive_focus():
_log.warning('veto()ing page change')
event.Veto()
return
# everything seems fine so switch
_log.debug('event target page seems focussable')
self.__target_page_already_checked = True
event.Allow() # redundant ?
event.Skip()
return
#----------------------------------------------
def _on_notebook_page_changed(self, event):
"""Called when notebook page changes.
Date: Wed, 15 May 2019 09:03:49 -0700 (PDT)
From: Robin Dunn <robin@alldunn.com>
To: wxPython-users <wxpython-users@googlegroups.com>
Subject: [wxPython-users] Re: wx.Notebook events work differently on Mac vs Linux and Windows
While in the _CHANGED event the notebook's current page (what you get from
GetCurrentPage) still hasn't been updated. I agree that this seems
unintuitive but it's always been that way. There may be a good reason for
it, but I don't know what it is.
Instead, you can use the event's GetSelection to get the index of the page
being changed to, and then use the notebook's GetPage to get the page object.
Also, you should call event.Skip() in your _CHANGED handler. I think there
is some layout things happening in the default handler on one or more of
the platforms, so you want to ensure that can still happen.
--
Robin
"""
_log.debug('just after switching notebook tabs')
event.Skip()
_log.debug('id: %s', event.Id)
_log.debug('event object (= source notebook): %s = %s', event.EventObject.Id, event.EventObject)
_log.debug('this notebook (= event receiver): %s = %s', self.Id, self)
if event.EventObject.Id != self.Id:
_log.error('this event came from another notebook')
id_nb_page_after_switch = self.GetSelection()
id_evt_page_before_switch = event.GetOldSelection()
id_evt_page_after_switch = event.GetSelection()
_log.debug('source/target page state in EVT_NOTEBOOK_PAGE_CHANGED:')
_log.debug(' #1 - current notebook page: %s (notebook.GetSelection())', id_nb_page_after_switch)
_log.debug(' #2 - event source page: %s (= page event says it is coming from, event.GetOldSelection())', id_evt_page_before_switch)
_log.debug(' #3 - event target page: %s (= page event wants to go to, event.GetSelection())', id_evt_page_after_switch)
if self.__id_nb_page_before_switch != id_evt_page_before_switch:
_log.warning('those two really *should* match:')
_log.warning(' wx.Notebook.GetSelection(): %s (notebook current page before switch) ', self.__id_nb_page_before_switch)
_log.warning(' EVT_NOTEBOOK_PAGE_CHANGED.GetOldSelection(): %s (event source page)' % id_evt_page_before_switch)
target_page = self.__gb['horstspace.notebook.pages'][id_evt_page_after_switch]
# well-behaving wxPython port ?
if self.__target_page_already_checked:
_log.debug('target page (evt=%s, nb=%s) claims to have been checked for focussability already: %s', id_evt_page_after_switch, id_nb_page_after_switch, target_page)
target_page.receive_focus()
self.__target_page_already_checked = False
return
# no, complain
_log.debug('target page not checked for focussability yet: %s', target_page)
_log.debug('EVT_NOTEBOOK_PAGE_CHANGED.GetOldSelection(): %s' % id_evt_page_before_switch)
_log.debug('EVT_NOTEBOOK_PAGE_CHANGED.GetSelection() : %s' % id_evt_page_after_switch)
_log.debug('wx.Notebook.GetSelection() (after switch) : %s' % id_nb_page_after_switch)
# check the new page just for good measure
if target_page.can_receive_focus():
_log.debug('we are lucky: target page *can* receive focus anyway')
target_page.receive_focus()
return
_log.error('target page cannot receive focus but too late for veto')
return
#==============================================================================
# finding the visible page from a notebook page: self.GetParent.GetCurrentPage == self
class cHorstSpaceLayoutMgr(wx.Panel):
"""GNUmed inner-frame layout manager.
This implements a Horst-space notebook-only
"inner-frame" layout manager.
"""
def __init__(self, parent, id):
# main panel
wx.Panel.__init__(
self,
parent = parent,
id = id,
pos = wx.DefaultPosition,
size = wx.DefaultSize,
style = wx.NO_BORDER,
name = 'HorstSpace.LayoutMgrPnl'
)
# top "row": important patient data is displayed there continually
self.top_panel = gmTopPanel.cTopPnl(self, -1)
# notebook
self.nb = cHorstSpaceNotebook(parent = self)
# plugins
self.__gb = gmGuiBroker.GuiBroker()
self.__gb['horstspace.top_panel'] = self.top_panel
self.__gb['horstspace.notebook'] = self.nb # FIXME: remove per Ian's API suggestion
self.__load_plugins()
# layout handling
self.main_szr = wx.BoxSizer(wx.VERTICAL)
self.main_szr.Add(self.top_panel, 0, wx.EXPAND)
self.main_szr.Add(self.nb, 1, wx.EXPAND)
self.SetSizer(self.main_szr)
# self.SetSizerAndFit(self.main_szr)
# self.Layout()
# self.Show(True)
self.__register_events()
#----------------------------------------------
# internal API
#----------------------------------------------
def __register_events(self):
# # because of
# # https://www.wiki.wxpython.org/self.Bind%20vs.%20self.button.Bind
# # do self.Bind() rather than self.nb.Bind()
# # - notebook page is about to change
# #self.nb.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGING, self._on_notebook_page_changing)
self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGING, self._on_notebook_page_changing, self.nb)
# # - notebook page has been changed
# #self.nb.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self._on_notebook_page_changed)
self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self._on_notebook_page_changed, self.nb)
# # - popup menu on right click in notebook
# #wx.EVT_RIGHT_UP(self.nb, self._on_right_click)
gmDispatcher.connect(self._on_post_patient_selection, 'post_patient_selection')
#----------------------------------------------
def __load_plugins(self):
wx.BeginBusyCursor()
# get plugin list
plugins2load_by_name = gmPlugin.GetPluginLoadList (
option = 'horstspace.notebook.plugin_load_order',
plugin_dir = 'gui',
defaults = ['gmProviderInboxPlugin']
)
_log.debug('plugin load order: %s', plugins2load_by_name)
nr_plugins = len(plugins2load_by_name)
failed_plugins = []
# set up a progress bar
progress_bar = gmPlugin.cLoadProgressBar(nr_plugins)
# and load them
prev_plugin = ""
first_plugin = None
plugin = None
result = -1
for idx in range(nr_plugins):
curr_plugin = plugins2load_by_name[idx]
progress_bar.Update(result, curr_plugin)
try:
plugin = gmPlugin.instantiate_plugin('gui', curr_plugin)
if plugin:
plugin.register()
result = 1
else:
_log.error("plugin [%s] not loaded, see errors above", curr_plugin)
failed_plugins.append(curr_plugin)
result = 1
except Exception:
_log.exception('failed to load plugin %s', curr_plugin)
failed_plugins.append(curr_plugin)
result = 0
if first_plugin is None:
first_plugin = plugin
prev_plugin = curr_plugin
_log.debug('failed plugins: %s', failed_plugins)
progress_bar.DestroyLater()
wx.EndBusyCursor()
# force-refresh first notebook page
page = self.nb.GetPage(0)
page.Refresh()
return True
#----------------------------------------------
# external callbacks
#----------------------------------------------
def _on_post_patient_selection(self, **kwargs):
db_cfg = gmCfg.cCfgSQL()
default_plugin = db_cfg.get2 (
option = 'patient_search.plugin_to_raise_after_search',
workplace = gmPraxis.gmCurrentPraxisBranch().active_workplace,
bias = 'user',
default = 'gmPatientOverviewPlugin'
)
gmDispatcher.send(signal = 'display_widget', name = default_plugin)
#----------------------------------------------
def _on_notebook_page_changing(self, event):
"""Called before notebook page change is processed."""
_log.debug('just before switching notebook tabs')
_log.debug('id: %s', event.Id)
_log.debug('event object (= source notebook): %s = %s', event.EventObject.Id, event.EventObject)
_log.debug('this notebook (= event receiver): %s = %s', self.nb.Id, self.nb)
if event.EventObject.Id != self.nb.Id:
_log.error('this event came from another notebook')
self.__target_page_already_checked = False
self.__id_nb_page_before_switch = self.nb.GetSelection()
self.__id_evt_page_before_switch = event.GetOldSelection()
__id_evt_page_after_switch = event.GetSelection()
_log.debug('source/target page state in EVT_NOTEBOOK_PAGE_CHANGING:')
_log.debug(' #1 - notebook current page: %s (= notebook.GetSelection())', self.__id_nb_page_before_switch)
_log.debug(' #2 - event source page: %s (= page event says it is coming from, event.GetOldSelection())', self.__id_evt_page_before_switch)
_log.debug(' #3 - event target page: %s (= page event wants to go to, event.GetSelection())', __id_evt_page_after_switch)
if self.__id_evt_page_before_switch != self.__id_nb_page_before_switch:
_log.warning(' problem: #1 and #2 really should match but do not')
# can we check the target page ?
if __id_evt_page_after_switch == self.__id_evt_page_before_switch:
# no, so complain
# (the docs say that on Windows GetSelection() returns the
# old page ID, eg. the same value GetOldSelection() returns)
_log.debug('this system is: sys: [%s] wx: [%s]', sys.platform, wx.Platform)
_log.debug('it seems to be one of those platforms that have no clue which notebook page they are switching to')
_log.debug('(Windows is documented to return the old page from both evt.GetOldSelection() and evt.GetSelection())')
_log.debug('current notebook page : %s', self.__id_nb_page_before_switch)
_log.debug('source page from event: %s', self.__id_evt_page_before_switch)
_log.debug('target page from event: %s', __id_evt_page_after_switch)
_log.warning('cannot check whether notebook page change needs to be vetoed')
# but let's do a basic check anyways
pat = gmPerson.gmCurrentPatient()
if not pat.connected:
gmDispatcher.send(signal = 'statustext', msg =_('Cannot change notebook tabs. No active patient.'))
event.Veto()
return
# that test passed, so let's hope things are fine
event.Allow() # redundant ?
event.Skip()
return
# check target page
target_page = self.__gb['horstspace.notebook.pages'][__id_evt_page_after_switch]
_log.debug('checking event target page for focussability: %s', target_page)
if not target_page.can_receive_focus():
_log.warning('veto()ing page change')
event.Veto()
return
# everything seems fine so switch
_log.debug('event target page seems focussable')
self.__target_page_already_checked = True
event.Allow() # redundant ?
event.Skip()
return
#----------------------------------------------
def _on_notebook_page_changed(self, event):
"""Called when notebook page changes."""
_log.debug('just after switching notebook tabs')
_log.debug('id: %s', event.Id)
_log.debug('event object (= source notebook): %s = %s', event.EventObject.Id, event.EventObject)
_log.debug('this notebook (= event receiver): %s = %s', self.nb.Id, self.nb)
if event.EventObject.Id != self.nb.Id:
_log.error('this event came from another notebook')
event.Skip()
id_nb_page_after_switch = self.nb.GetSelection()
id_evt_page_before_switch = event.GetOldSelection()
id_evt_page_after_switch = event.GetSelection()
_log.debug('source/target page state in EVT_NOTEBOOK_PAGE_CHANGED:')
_log.debug(' #1 - current notebook page: %s (notebook.GetSelection())', id_nb_page_after_switch)
_log.debug(' #2 - event source page: %s (= page event says it is coming from, event.GetOldSelection())', id_evt_page_before_switch)
_log.debug(' #3 - event target page: %s (= page event wants to go to, event.GetSelection())', id_evt_page_after_switch)
if self.__id_nb_page_before_switch != id_evt_page_before_switch:
_log.warning('those two really *should* match:')
_log.warning(' wx.Notebook.GetSelection(): %s (notebook current page before switch) ', self.__id_nb_page_before_switch)
_log.warning(' EVT_NOTEBOOK_PAGE_CHANGED.GetOldSelection(): %s (event source page)' % id_evt_page_before_switch)
target_page = self.__gb['horstspace.notebook.pages'][id_evt_page_after_switch]
# well-behaving wxPython port ?
if self.__target_page_already_checked:
_log.debug('target page (evt=%s, nb=%s) claims to have been checked for focussability already: %s', id_evt_page_after_switch, id_nb_page_after_switch, target_page)
target_page.receive_focus()
self.__target_page_already_checked = False
return
# no, complain
_log.debug('target page not checked for focussability yet: %s', target_page)
_log.debug('EVT_NOTEBOOK_PAGE_CHANGED.GetOldSelection(): %s' % id_evt_page_before_switch)
_log.debug('EVT_NOTEBOOK_PAGE_CHANGED.GetSelection() : %s' % id_evt_page_after_switch)
_log.debug('wx.Notebook.GetSelection() (after switch) : %s' % id_nb_page_after_switch)
# check the new page just for good measure
if target_page.can_receive_focus():
_log.debug('we are lucky: target page *can* receive focus anyway')
target_page.receive_focus()
return
_log.error('target page cannot receive focus but too late for veto')
return
# #----------------------------------------------
# def _on_right_click(self, evt):
# evt.Skip()
# return
#
# load_menu = wx.Menu()
# any_loadable = 0
# plugins2load_by_name = gmPlugin.GetPluginLoadList('gui')
# plugin = None
# for plugin_name in plugins2load_by_name:
# try:
# plugin = gmPlugin.instantiate_plugin('gui', plugin_name)
# except Exception:
# continue
# # not a plugin
# if not isinstance(plugin, gmPlugin.cNotebookPlugin):
# plugin = None
# continue
# # already loaded ?
# if plugin.__class__.__name__ in self.guibroker['horstspace.notebook.gui']:
# plugin = None
# continue
# # add to load menu
# item = load_menu.AppendItem(wx.MenuItem(load_menu, plugin.name()))
# self.Bind(wx.EVT_MENU, plugin.on_load, load_menu_OR_item)
# any_loadable = 1
# # make menus
# menu = wx.Menu()
# ID_LOAD = wx.NewId()
# ID_DROP = wx.NewId()
# if any_loadable:
# menu.Append(ID_LOAD, _('add plugin ...'), load_menu)
# plugins = self.guibroker['horstspace.notebook.gui']
# raised_plugin = plugins[self.nb.GetSelection()].name()
# item = menu.AppendItem(wx.MenuItem(-1, "drop [%s]" % raised_plugin))
# self.Bind(wx.EVT_MENU, self._on_drop_plugin, item)
# self.PopupMenu(menu, evt.GetPosition())
# menu.DestroyLater()
# evt.Skip()
#----------------------------------------------
def _on_drop_plugin(self, evt):
"""Unload plugin and drop from load list."""
pages = self.guibroker['horstspace.notebook.pages']
page = pages[self.nb.GetSelection()]
page.unregister()
self.nb.AdvanceSelection()
# FIXME:"dropping" means talking to configurator so not reloaded
#----------------------------------------------
def _on_hide_plugin (self, evt):
"""Unload plugin but don't touch configuration."""
# this dictionary links notebook page numbers to plugin objects
pages = self.guibroker['horstspace.notebook.pages']
page = pages[self.nb.GetSelection()]
page.unregister()
#==============================================================================
if __name__ == '__main__':
wx.InitAllImageHandlers()
pgbar = gmPluginLoadProgressBar(3)
|
