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
|
"""
@package gui_core.toolbars
@brief Base classes toolbar widgets
Classes:
- toolbars::BaseToolbar
(C) 2007-2011 by the GRASS Development Team
This program is free software under the GNU General Public License
(>=v2). Read the file COPYING that comes with GRASS for details.
@author Michael Barton
@author Jachym Cepicky
@author Martin Landa <landa.martin gmail.com>
"""
import platform
import os
import wx
from core import globalvar
from core.debug import Debug
from core.utils import _
from icons.icon import MetaIcon
from collections import defaultdict
from core.globalvar import IMGDIR
from grass.pydispatch.signal import Signal
BaseIcons = {
'display': MetaIcon(img='show',
label=_('Display map'),
desc=_('Re-render modified map layers only')),
'render': MetaIcon(img='layer-redraw',
label=_('Render map'),
desc=_('Force re-rendering all map layers')),
'erase': MetaIcon(img='erase',
label=_('Erase display'),
desc=_('Erase display canvas with given background color')),
'pointer': MetaIcon(img='pointer',
label=_('Pointer')),
'zoomIn': MetaIcon(img='zoom-in',
label=_('Zoom in'),
desc=_('Drag or click mouse to zoom')),
'zoomOut': MetaIcon(img='zoom-out',
label=_('Zoom out'),
desc=_('Drag or click mouse to unzoom')),
'zoomBack': MetaIcon(img='zoom-last',
label=_('Return to previous zoom')),
'zoomMenu': MetaIcon(img='zoom-more',
label=_('Various zoom options'),
desc=_('Zoom to default or saved region, save to named region, ...')),
'zoomExtent': MetaIcon(img='zoom-extent',
label=_('Zoom to selected map layer(s)')),
'zoomRegion': MetaIcon(img='zoom-region',
label=_('Zoom to computational region extent')),
'pan': MetaIcon(img='pan',
label=_('Pan'),
desc=_('Drag with mouse to pan')),
'saveFile': MetaIcon(img='map-export',
label=_('Save display to file')),
'print': MetaIcon(img='print',
label=_('Print display')),
'font': MetaIcon(img='font',
label=_('Select font')),
'help': MetaIcon(img='help',
label=_('Show manual')),
'quit': MetaIcon(img='quit',
label=_('Quit')),
'addRast': MetaIcon(img='layer-raster-add',
label=_('Add raster map layer')),
'addVect': MetaIcon(img='layer-vector-add',
label=_('Add vector map layer')),
'overlay': MetaIcon(img='overlay-add',
label=_('Add map elements'),
desc=_('Overlay elements like scale and legend onto map')),
'histogramD': MetaIcon(img='layer-raster-histogram',
label=_('Create histogram with d.histogram')),
'settings': MetaIcon(img='settings',
label=_("Settings")),
}
class BaseToolbar(wx.ToolBar):
"""Abstract toolbar class.
Following code shows how to create new basic toolbar:
class MyToolbar(BaseToolbar):
def __init__(self, parent):
BaseToolbar.__init__(self, parent)
self.InitToolbar(self._toolbarData())
self.Realize()
def _toolbarData(self):
return self._getToolbarData((("help", Icons["help"],
self.parent.OnHelp),
))
"""
def __init__(self, parent, toolSwitcher=None,
style=wx.NO_BORDER | wx.TB_HORIZONTAL):
self.parent = parent
wx.ToolBar.__init__(self, parent=self.parent, id=wx.ID_ANY,
style=style)
self._default = None
self.SetToolBitmapSize(globalvar.toolbarSize)
self.toolSwitcher = toolSwitcher
self.handlers = {}
def InitToolbar(self, toolData):
"""Initialize toolbar, add tools to the toolbar
"""
for tool in toolData:
self.CreateTool(*tool)
self._data = toolData
def _toolbarData(self):
"""Toolbar data (virtual)"""
return None
def CreateTool(self, label, bitmap, kind,
shortHelp, longHelp, handler, pos=-1):
"""Add tool to the toolbar
:param pos: if -1 add tool, if > 0 insert at given pos
:return: id of tool
"""
bmpDisabled = wx.NullBitmap
tool = -1
if label:
tool = vars(self)[label] = wx.NewId()
Debug.msg(3, "CreateTool(): tool=%d, label=%s bitmap=%s" %
(tool, label, bitmap))
if pos < 0:
toolWin = self.AddLabelTool(tool, label, bitmap,
bmpDisabled, kind,
shortHelp, longHelp)
else:
toolWin = self.InsertLabelTool(pos, tool, label, bitmap,
bmpDisabled, kind,
shortHelp, longHelp)
self.handlers[tool] = handler
self.Bind(wx.EVT_TOOL, handler, toolWin)
self.Bind(wx.EVT_TOOL, self.OnTool, toolWin)
else: # separator
self.AddSeparator()
return tool
def EnableLongHelp(self, enable=True):
"""Enable/disable long help
:param enable: True for enable otherwise disable
"""
for tool in self._data:
if tool[0] == '': # separator
continue
if enable:
self.SetToolLongHelp(vars(self)[tool[0]], tool[4])
else:
self.SetToolLongHelp(vars(self)[tool[0]], "")
def OnTool(self, event):
"""Tool selected
"""
if self.toolSwitcher:
Debug.msg(3, "BaseToolbar.OnTool(): id = %s" % event.GetId())
self.toolSwitcher.ToolChanged(event.GetId())
event.Skip()
def SelectTool(self, id):
self.ToggleTool(id, True)
self.toolSwitcher.ToolChanged(id)
self.handlers[id](event=None)
def SelectDefault(self):
"""Select default tool"""
self.SelectTool(self._default)
def FixSize(self, width):
"""Fix toolbar width on Windows
.. todo::
Determine why combobox causes problems here
"""
if platform.system() == 'Windows':
size = self.GetBestSize()
self.SetSize((size[0] + width, size[1]))
def Enable(self, tool, enable=True):
"""Enable/Disable defined tool
:param tool: name
:param enable: True to enable otherwise disable tool
"""
try:
id = getattr(self, tool)
except AttributeError:
# TODO: test everything that this is not raised
# this error was ignored for a long time
raise AttributeError("Toolbar does not have a tool %s." % tool)
return
self.EnableTool(id, enable)
def EnableAll(self, enable=True):
"""Enable/Disable all tools
:param enable: True to enable otherwise disable tool
"""
for item in self._toolbarData():
if not item[0]:
continue
self.Enable(item[0], enable)
def _getToolbarData(self, data):
"""Define tool
"""
retData = list()
for args in data:
retData.append(self._defineTool(*args))
return retData
def _defineTool(self, name=None, icon=None, handler=None,
item=wx.ITEM_NORMAL, pos=-1):
"""Define tool
"""
if name:
return (name, icon.GetBitmap(),
item, icon.GetLabel(), icon.GetDesc(),
handler, pos)
return ("", "", "", "", "", "") # separator
def _onMenu(self, data):
"""Toolbar pop-up menu"""
menu = wx.Menu()
for icon, handler in data:
item = wx.MenuItem(menu, wx.ID_ANY, icon.GetLabel())
item.SetBitmap(icon.GetBitmap(self.parent.iconsize))
menu.AppendItem(item)
self.Bind(wx.EVT_MENU, handler, item)
self.PopupMenu(menu)
menu.Destroy()
def CreateSelectionButton(self, tooltip=_("Select graphics tool")):
"""Add button to toolbar for selection of graphics drawing mode.
Button must be custom (not toolbar tool) to set smaller width.
"""
arrowPath = os.path.join(IMGDIR, 'small_down_arrow.png')
if os.path.isfile(arrowPath) and os.path.getsize(arrowPath):
bitmap = wx.Bitmap(name=arrowPath)
else:
bitmap = wx.ArtProvider.GetBitmap(
id=wx.ART_MISSING_IMAGE, client=wx.ART_TOOLBAR)
button = wx.BitmapButton(parent=self, id=wx.ID_ANY, size=(
(-1, self.GetToolSize()[1])), bitmap=bitmap, style=wx.NO_BORDER)
button.SetToolTipString(tooltip)
return button
class ToolSwitcher:
"""Class handling switching tools in toolbar and custom toggle buttons."""
def __init__(self):
self._groups = defaultdict(lambda: defaultdict(list))
self._toolsGroups = defaultdict(list)
# emitted when tool is changed
self.toggleToolChanged = Signal('ToolSwitcher.toggleToolChanged')
def AddToolToGroup(self, group, toolbar, tool):
"""Adds tool from toolbar to group of exclusive tools.
:param group: name of group (e.g. 'mouseUse')
:param toolbar: instance of toolbar
:param tool: id of a tool from the toolbar
"""
self._groups[group][toolbar].append(tool)
self._toolsGroups[tool].append(group)
def AddCustomToolToGroup(self, group, btnId, toggleHandler):
"""Adds custom tool from to group of exclusive tools (some toggle button).
:param group: name of group (e.g. 'mouseUse')
:param btnId: id of a tool (typically button)
:param toggleHandler: handler to be called to switch the button
"""
self._groups[group]['custom'].append((btnId, toggleHandler))
self._toolsGroups[btnId].append(group)
def RemoveCustomToolFromGroup(self, tool):
"""Removes custom tool from group.
:param tool: id of the button
"""
if not tool in self._toolsGroups:
return
for group in self._toolsGroups[tool]:
self._groups[group]['custom'] = \
[(bid, hdlr) for (bid, hdlr)
in self._groups[group]['custom'] if bid != tool]
def RemoveToolbarFromGroup(self, group, toolbar):
"""Removes toolbar from group.
Before toolbar is destroyed, it must be removed from group, too.
Otherwise we can expect some DeadObject errors.
:param group: name of group (e.g. 'mouseUse')
:param toolbar: instance of toolbar
"""
for tb in self._groups[group]:
if tb == toolbar:
del self._groups[group][tb]
break
def IsToolInGroup(self, tool, group):
"""Checks whether a tool is in a specified group.
:param tool: tool id
:param group: name of group (e.g. 'mouseUse')
"""
for group in self._toolsGroups[tool]:
for tb in self._groups[group]:
if tb == 'custom':
for bid, handler in self._groups[group][tb]:
if tool == bid:
return True
elif tb.FindById(tool):
return True
return False
def ToolChanged(self, tool):
"""When any tool/button is pressed, other tools from group must be unchecked.
:param tool: id of a tool/button
"""
for group in self._toolsGroups[tool]:
for tb in self._groups[group]:
if tb == 'custom':
for btnId, handler in self._groups[group][tb]:
if btnId != tool:
handler(False)
else:
for tl in self._groups[group][tb]:
if tb.FindById(tl): # check if still exists
if tl != tool:
tb.ToggleTool(tl, False)
else:
tb.ToggleTool(tool, True)
self.toggleToolChanged.emit(id=tool)
|
