3 """Playlist panel for Hooke.
\r
5 Provides a nice GUI interface to the
\r
6 :class:`~hooke.plugin.playlist.PlaylistPlugin`.
\r
13 from ....util.callback import callback, in_callback
\r
17 class Menu (wx.Menu):
\r
18 """Popup menu for selecting playlist :class:`Tree` actions.
\r
20 def __init__(self, on_delete, *args, **kwargs):
\r
21 super(Menu, self).__init__(*args, **kwargs)
\r
23 'delete': self.Append(id=wx.ID_ANY, text='Delete'),
\r
25 self.Bind(wx.EVT_MENU, on_delete)
\r
28 class Tree (wx.TreeCtrl):
\r
29 """:class:`wx.TreeCtrl` subclass handling playlist and curve selection.
\r
31 def __init__(self, config, callbacks, *args, **kwargs):
\r
32 super(Tree, self).__init__(*args, **kwargs)
\r
33 imglist = wx.ImageList(width=16, height=16, mask=True, initialCount=2)
\r
34 imglist.Add(wx.ArtProvider.GetBitmap(
\r
35 wx.ART_FOLDER, wx.ART_OTHER, wx.Size(16, 16)))
\r
36 imglist.Add(wx.ArtProvider.GetBitmap(
\r
37 wx.ART_NORMAL_FILE, wx.ART_OTHER, wx.Size(16, 16)))
\r
38 self.AssignImageList(imglist)
\r
45 'menu': Menu(self._on_delete),
\r
46 'root': self.AddRoot(text='Playlists', image=self.image['root'])
\r
48 self.Bind(wx.EVT_RIGHT_DOWN, self._on_context_menu)
\r
49 self.Bind(wx.EVT_TREE_SEL_CHANGED, self._on_select)
\r
51 self.config = config
\r
52 self._callbacks = callbacks
\r
53 self._setup_playlists()
\r
55 def _setup_playlists(self):
\r
56 self._playlists = {} # {name: hooke.playlist.Playlist()}
\r
58 # In both of the following dicts, curve names are
\r
59 # (playlist.name, curve.name) to avoid cross-playlist
\r
60 # collisions. See ._is_curve().
\r
61 self._id_for_name = {} # {name: id}
\r
62 self._name_for_id = {} # {id: name}
\r
64 def _name(self, name):
\r
65 """Cleanup names according to configured preferences.
\r
67 if self.config['hide extensions'] == 'True': # HACK: config should decode
\r
68 name,ext = os.path.splitext(name)
\r
71 def _is_curve(self, name): # name from ._id_for_name / ._name_for_id
\r
72 """Return `True` if `name` corresponds to a :class:`hooke.curve.Curve`.
\r
74 # Playlist names are strings, Curve names are tuples.
\r
75 # See ._setup_playlists().
\r
76 return not isinstance(name, types.StringTypes)
\r
78 def _canonical_id(self, _id):
\r
79 """Return a canonical form of `_id` suitable for accessing `._name_for_id`.
\r
81 For some reason, `.GetSelection()`, etc. return items that
\r
82 hash differently than the original `.AppendItem()`-returned
\r
83 IDs. This means that `._name_for_id[self.GetSelection()]`
\r
84 will raise `KeyError`, even if there is an id `X` in
\r
85 `._name_for_id` for which `X == self.GetSelection()` will
\r
86 return `True`. This method "canonicalizes" IDs so that the
\r
87 hashing is consistent.
\r
89 for c_id in self._name_for_id.keys():
\r
97 def _on_context_menu(self, event):
\r
98 """Launch a popup :class:`Menu` with per-playlist/curve activities.
\r
100 hit_id,hit_flags = self.HitTest(event.GetPosition())
\r
101 if (hit_flags & wx.TREE_HITTEST_ONITEM) != 0:
\r
102 self._hit_id = self._canonical_id(hit_id) # store for callbacks
\r
103 menu = Menu(self._on_delete)
\r
104 self.PopupMenu(menu, event.GetPosition())
\r
108 # add_* called directly by HookeFrame
\r
109 # _add_* called on every addition
\r
111 def add_playlist(self, playlist):
\r
112 """Add a :class:`hooke.playlist.Playlist` to the tree.
\r
114 Calls :meth:`_add_playlist` and triggers a callback.
\r
116 self._add_playlist(playlist)
\r
117 in_callback(self, playlist)
\r
119 def _add_playlist(self, playlist):
\r
120 """Add a class:`hooke.playlist.Playlist` to the tree.
\r
122 No callback triggered.
\r
124 if playlist.name not in self._playlists:
\r
127 raise ValueError('duplicate playlist: %s' % playlist.name)
\r
128 self._playlists[playlist.name] = playlist
\r
129 p_id = self.AppendItem(
\r
130 parent=self._c['root'],
\r
131 text=self._name(playlist.name),
\r
132 image=self.image['playlist'])
\r
133 self._id_for_name[playlist.name] = p_id
\r
134 self._name_for_id[p_id] = playlist.name
\r
135 for curve in playlist:
\r
136 self._add_curve(playlist.name, curve)
\r
138 def add_curve(self, playlist_name, curve):
\r
139 """Add a :class:`hooke.curve.Curve` to a curently loaded playlist.
\r
141 Calls :meth:`_add_curve` and triggers a callback.
\r
143 self._add_curve(playlist_name, curve)
\r
144 playlist = self._playlists[playlist_name]
\r
145 in_callback(self, playlist, curve)
\r
147 def _add_curve(self, playlist_name, curve):
\r
148 """Add a class:`hooke.curve.Curve` to the tree.
\r
150 No callback triggered.
\r
152 p = self._playlists[playlist_name]
\r
155 c_id = self.AppendItem(
\r
156 parent=self._id_for_name[playlist_name],
\r
157 text=self._name(curve.name),
\r
158 image=self.image['curve'])
\r
159 self._id_for_name[(p.name, curve.name)] = c_id
\r
160 self._name_for_id[c_id] = (p.name, curve.name)
\r
163 def generate_new_playlist(self):
\r
166 def _GetUniquePlaylistName(self, name): # TODO
\r
167 playlist_name = name
\r
169 while playlist_name in self.playlists:
\r
170 playlist_name = ''.join([name, str(count)])
\r
172 return playlist_name
\r
175 # delete_* called by _on_delete handler (user click) or HookeFrame
\r
176 # _delete_* called on every deletion
\r
178 def _on_delete(self, event):
\r
179 """Handler for :class:`Menu`'s `Delete` button.
\r
181 Determines the clicked item and calls the appropriate
\r
182 `.delete_*()` method on it.
\r
184 #if hasattr(self, '_hit_id'): # called via ._c['menu']
\r
187 name = self._name_for_id[_id]
\r
188 if self._is_curve(name):
\r
189 self.delete_curve(playlist_name=name[0], name=name[1])
\r
191 self.delete_playlist(name)
\r
193 def delete_playlist(self, name):
\r
194 """Delete a :class:`hooke.playlist.Playlist` by name.
\r
196 Called by the :meth:`_on_delete` handler.
\r
198 Removes the playlist and its curves from the tree, then calls
\r
199 :meth:`_delete_playlist`.
\r
201 _id = self._id_for_name[name]
\r
203 playlist = self._playlists[name]
\r
204 self._delete_playlist(playlist)
\r
205 in_callback(self, playlist)
\r
207 def _delete_playlist(self, playlist):
\r
208 """Adjust name/id caches for the playlist and its curves.
\r
210 Called on *every* playlist deletion.
\r
212 self._playlists.pop(playlist.name)
\r
213 _id = self._id_for_name.pop(playlist.name)
\r
214 del(self._name_for_id[_id])
\r
215 for curve in playlist:
\r
216 self._delete_curve(playlist, curve)
\r
217 in_callback(self, playlist)
\r
219 def delete_curve(self, playlist_name, name):
\r
220 """Delete a :class:`hooke.curve.Curve` by name.
\r
222 Called by the :meth:`_on_delete` handler.
\r
224 Removes the curve from the tree, then calls
\r
225 :meth:`_delete_curve`.
\r
227 _id = self._id_for_name[(playlist_name, name)]
\r
229 playlist = self._playlists[playlist_name]
\r
231 for i,c in enumerate(playlist):
\r
235 self._delete_curve(playlist, curve)
\r
236 in_callback(self, playlist, curve)
\r
238 def _delete_curve(self, playlist, curve):
\r
239 """Adjust name/id caches.
\r
241 Called on _every_ curve deletion.
\r
243 _id = self._id_for_name.pop((playlist.name, curve.name))
\r
244 del(self._name_for_id[_id])
\r
245 in_callback(self, playlist, curve)
\r
249 def get_selected_playlist(self):
\r
250 """Return the selected :class:`hooke.playlist.Playlist`.
\r
252 _id = self.GetSelection()
\r
253 name = self._name_for_id[self._canonical_id(_id)]
\r
254 if self._is_curve(name):
\r
256 return self._playlists[name]
\r
258 def get_selected_curve(self):
\r
259 """Return the selected :class:`hooke.curve.Curve`.
\r
261 _id = self.GetSelection()
\r
262 name = self._name_for_id[self._canonical_id(_id)]
\r
263 if self._is_curve(name):
\r
264 p_name,c_name = name
\r
265 playlist = self._playlists[p_name]
\r
266 c = playlist.current()
\r
267 assert c.name == c_name, '%s != %s' % (c.name, c_name)
\r
269 playlist = self._playlists[name]
\r
270 return playlist.current()
\r
273 # set_* called by HookeFrame, includes tree display updates
\r
274 # _set_* called on every selection (including _on_select)
\r
276 # Selection is a bit tricky, because playlists are never selected
\r
277 # directly. Selecting a playlist is equivalent to selecting its
\r
280 def _on_select(self, event):
\r
281 """Select the clicked-on curve/playlist.
\r
283 _id = self.GetSelection()
\r
284 name = self._name_for_id[self._canonical_id(_id)]
\r
285 if self._is_curve(name):
\r
286 p_name,c_name = name
\r
287 self._set_selected_curve(p_name, c_name)
\r
289 self._set_selected_playlist(name)
\r
291 def set_selected_playlist(self, name):
\r
292 """Set the selected :class:`hooke.playlist.Playlist` by name.
\r
294 Just a wrapper around :meth:`_set_selected_playlist`.
\r
296 # Selection would be overridden by _set_select_playlist
\r
297 #self.SelectItem(self._id_for_name[name])
\r
298 self.Expand(self._id_for_name[name])
\r
299 self._set_selected_playlist(name)
\r
301 def _set_selected_playlist(self, name):
\r
302 """Selects the playlist's current :class:`hooke.curve.Curve`.
\r
304 Updates the tree to display, which calls
\r
305 :meth:`_set_selected_curvet` via :meth:`_on_select`.
\r
307 playlist = self._playlists[name]
\r
308 curve = playlist.current()
\r
309 self.SelectItem(self._id_for_name[(name, curve.name)])
\r
310 # triggers _set_selected_curve
\r
312 def set_selected_curve(self, playlist_name, name):
\r
313 """Set the selected :class:`hooke.curve.Curve` by name.
\r
315 Updates the tree display, which calls
\r
316 :meth:`_set_selected_curvet` via :meth:`_on_select`.
\r
318 self.Expand(self._id_for_name[playlist_name])
\r
319 self.SelectItem(self._id_for_name[(playlist_name, name)])
\r
320 # triggers _set_selected_curve
\r
322 def _set_selected_curve(self, playlist_name, name):
\r
323 """Make the curve the playlist's current curve.
\r
325 playlist = self._playlists[playlist_name]
\r
327 for i,c in enumerate(playlist):
\r
333 raise ValueError(name)
\r
334 curve = playlist.current()
\r
335 in_callback(self, playlist, curve)
\r
338 class Playlist (Panel, wx.Panel):
\r
339 """:class:`wx.Panel` subclass wrapper for :class:`Tree`.
\r
341 def __init__(self, config, callbacks, *args, **kwargs):
\r
342 # Use the WANTS_CHARS style so the panel doesn't eat the Return key.
\r
343 super(Playlist, self).__init__(*args, **kwargs)
\r
344 self.name = 'playlist panel'
\r
349 callbacks=callbacks,
\r
351 size=wx.Size(160, 250),
\r
352 style=wx.TR_DEFAULT_STYLE | wx.NO_BORDER | wx.TR_HIDE_ROOT),
\r
355 sizer = wx.BoxSizer(wx.VERTICAL)
\r
356 sizer.Add(self._c['tree'], 1, wx.EXPAND)
\r
357 self.SetSizer(sizer)
\r
360 # Expose all Tree's public curve/playlist methods directly.
\r
361 # Following DRY and the LoD.
\r
362 for attribute_name in dir(self._c['tree']):
\r
363 if (attribute_name.startswith('_')
\r
364 or 'playlist' not in attribute_name
\r
365 or 'curve' not in attribute_name):
\r
366 continue # not an attribute we're interested in
\r
367 attr = getattr(self._c['tree'], attribute_name)
\r
368 if hasattr(attr, '__call__'): # attr is a function / method
\r
369 setattr(self, attribute_name, attr) # expose it
\r