| 1 |
# Copyright (C) 2014 Dustin Spicuzza <[email protected]> |
| 2 |
# |
| 3 |
# This program is free software; you can redistribute it and/or modify |
| 4 |
# it under the terms of the GNU General Public License as published by |
| 5 |
# the Free Software Foundation; either version 2, or (at your option) |
| 6 |
# any later version. |
| 7 |
# |
| 8 |
# This program is distributed in the hope that it will be useful, |
| 9 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 11 |
# GNU General Public License for more details. |
| 12 |
# |
| 13 |
# You should have received a copy of the GNU General Public License |
| 14 |
# along with this program; if not, write to the Free Software |
| 15 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 16 |
# |
| 17 |
# |
| 18 |
# The developers of the Exaile media player hereby grant permission |
| 19 |
# for non-GPL compatible GStreamer and Exaile plugins to be used and |
| 20 |
# distributed together with GStreamer and Exaile. This permission is |
| 21 |
# above and beyond the permissions granted by the GPL license by which |
| 22 |
# Exaile is covered. If you modify this code, you may extend this |
| 23 |
# exception to your version of the code, but you are not obligated to |
| 24 |
# do so. If you do not wish to do so, delete this exception statement |
| 25 |
# from your version. |
| 26 |
|
| 27 |
# |
| 28 |
# Contains definitions for all of the context menus for panels |
| 29 |
# |
| 30 |
# Each panel pulls in menu items from different providers, so that |
| 31 |
# plugins can easily hook all of the panels for track operations |
| 32 |
# without a lot of work. |
| 33 |
# |
| 34 |
# To hook into a panel, just call 'register' on the menu item with |
| 35 |
# the appropriate provider key. |
| 36 |
# |
| 37 |
# Each panel context has the following keys available: |
| 38 |
# |
| 39 |
# - selection-empty |
| 40 |
# Use this for conditions to determine whether to show the menu |
| 41 |
# item or not. |
| 42 |
# |
| 43 |
# - selected-tracks |
| 44 |
# Will return all selected tracks, even if a playlist is selected |
| 45 |
# |
| 46 |
# Other context keys are available for specific panels |
| 47 |
# |
| 48 |
|
| 49 |
from xl.nls import gettext as _ |
| 50 |
from xl import common |
| 51 |
from xlgui.widgets import menu, menuitems |
| 52 |
|
| 53 |
### Generic track selection menus |
| 54 |
|
| 55 |
|
| 56 |
def __create_track_panel_menus(): |
| 57 |
items = [] |
| 58 |
|
| 59 |
items.append(menuitems.EnqueueMenuItem('enqueue', after=['top-sep'])) |
| 60 |
|
| 61 |
items.append(menuitems.AppendMenuItem('append', after=[items[-1].name])) |
| 62 |
items.append(menuitems.ReplaceCurrentMenuItem('replace', after=[items[-1].name])) |
| 63 |
items.append(menuitems.RatingMenuItem('rating', after=[items[-1].name])) |
| 64 |
|
| 65 |
items.append(menu.simple_separator('tp-sep', after=[items[-1].name])) |
| 66 |
|
| 67 |
items.append(menuitems.PropertiesMenuItem('properties', after=[items[-1].name])) |
| 68 |
|
| 69 |
for item in items: |
| 70 |
item.register('track-panel-menu') |
| 71 |
|
| 72 |
|
| 73 |
__create_track_panel_menus() |
| 74 |
|
| 75 |
|
| 76 |
class TrackPanelMenu(menu.ProviderMenu): |
| 77 |
""" |
| 78 |
Context menu when a track is clicked on a panel |
| 79 |
|
| 80 |
Provider key: track-panel-menu |
| 81 |
""" |
| 82 |
|
| 83 |
def __init__(self, parent): |
| 84 |
menu.ProviderMenu.__init__(self, 'track-panel-menu', parent) |
| 85 |
|
| 86 |
def get_context(self): |
| 87 |
context = common.LazyDict(self._parent) |
| 88 |
context['selected-tracks'] = ( |
| 89 |
lambda name, parent: parent.tree.get_selected_tracks() |
| 90 |
) |
| 91 |
context['selection-empty'] = ( |
| 92 |
lambda name, parent: parent.tree.get_selection_empty() |
| 93 |
) |
| 94 |
return context |
| 95 |
|
| 96 |
|
| 97 |
### Collection panel menus |
| 98 |
|
| 99 |
|
| 100 |
def __create_collection_panel_context_menu(): |
| 101 |
def collection_delete_tracks_func(panel, context, tracks): |
| 102 |
panel.collection.delete_tracks(tracks) |
| 103 |
|
| 104 |
items = [] |
| 105 |
items.append(menu.simple_separator('cp-sep', after=['properties'])) |
| 106 |
items.append( |
| 107 |
menuitems.OpenDirectoryMenuItem('open-directory', after=[items[-1].name]) |
| 108 |
) |
| 109 |
items.append( |
| 110 |
menuitems.TrashMenuItem( |
| 111 |
'trash-tracks', |
| 112 |
after=[items[-1].name], |
| 113 |
delete_tracks_func=collection_delete_tracks_func, |
| 114 |
) |
| 115 |
) |
| 116 |
|
| 117 |
for item in items: |
| 118 |
item.register('collection-panel-context-menu') |
| 119 |
|
| 120 |
|
| 121 |
__create_collection_panel_context_menu() |
| 122 |
|
| 123 |
|
| 124 |
class CollectionContextMenu(menu.MultiProviderMenu): |
| 125 |
""" |
| 126 |
Context menu when a collection track is clicked |
| 127 |
|
| 128 |
Provider keys: track-panel-menu, collection-panel-context-menu |
| 129 |
""" |
| 130 |
|
| 131 |
def __init__(self, panel): |
| 132 |
menu.MultiProviderMenu.__init__( |
| 133 |
self, ['track-panel-menu', 'collection-panel-context-menu'], panel |
| 134 |
) |
| 135 |
|
| 136 |
def get_context(self): |
| 137 |
context = common.LazyDict(self._parent) |
| 138 |
context['selected-tracks'] = ( |
| 139 |
lambda name, parent: parent.tree.get_selected_tracks() |
| 140 |
) |
| 141 |
context['selection-empty'] = ( |
| 142 |
lambda name, parent: parent.tree.get_selection_empty() |
| 143 |
) |
| 144 |
return context |
| 145 |
|
| 146 |
|
| 147 |
### Files panel menu |
| 148 |
|
| 149 |
|
| 150 |
def __create_files_panel_context_menu(): |
| 151 |
def trash_tracks_func(parent, context, tracks): |
| 152 |
menuitems.generic_trash_tracks_func(parent, context, tracks) |
| 153 |
parent.refresh(None) |
| 154 |
|
| 155 |
items = [] |
| 156 |
items.append(menu.simple_separator('fp-sep', after=['properties'])) |
| 157 |
items.append( |
| 158 |
menuitems.OpenDirectoryMenuItem('open-directory', after=[items[-1].name]) |
| 159 |
) |
| 160 |
items.append( |
| 161 |
menuitems.TrashMenuItem( |
| 162 |
'trash-tracks', after=[items[-1].name], trash_tracks_func=trash_tracks_func |
| 163 |
) |
| 164 |
) |
| 165 |
|
| 166 |
for item in items: |
| 167 |
item.register('files-panel-context-menu') |
| 168 |
|
| 169 |
|
| 170 |
__create_files_panel_context_menu() |
| 171 |
|
| 172 |
|
| 173 |
class FilesContextMenu(menu.MultiProviderMenu): |
| 174 |
""" |
| 175 |
Context menu when a files panel track is clicked |
| 176 |
|
| 177 |
Provider keys: track-panel-menu, files-panel-context-menu |
| 178 |
""" |
| 179 |
|
| 180 |
def __init__(self, panel): |
| 181 |
menu.MultiProviderMenu.__init__( |
| 182 |
self, ['track-panel-menu', 'files-panel-context-menu'], panel |
| 183 |
) |
| 184 |
|
| 185 |
def get_context(self): |
| 186 |
context = common.LazyDict(self._parent) |
| 187 |
context['needs-computing'] = ( |
| 188 |
lambda name, parent: parent.tree.get_selection_is_computed() |
| 189 |
) |
| 190 |
context['selected-tracks'] = ( |
| 191 |
lambda name, parent: parent.tree.get_selected_tracks() |
| 192 |
) |
| 193 |
context['selection-empty'] = ( |
| 194 |
lambda name, parent: parent.tree.get_selection_empty() |
| 195 |
) |
| 196 |
|
| 197 |
return context |
| 198 |
|
| 199 |
|
| 200 |
### Playlist panel menus |
| 201 |
|
| 202 |
|
| 203 |
def __create_playlist_panel_menus(): |
| 204 |
# w, n, o, c: window, name, parent, context |
| 205 |
|
| 206 |
menu.simple_menu_item( |
| 207 |
'new-playlist', |
| 208 |
[], |
| 209 |
_('_New Playlist'), |
| 210 |
'tab-new', |
| 211 |
lambda w, n, o, c: o.add_new_playlist(), |
| 212 |
).register('playlist-panel-menu') |
| 213 |
|
| 214 |
menu.simple_menu_item( |
| 215 |
'new-smart-playlist', |
| 216 |
['new-playlist'], |
| 217 |
_('New _Smart Playlist'), |
| 218 |
'tab-new', |
| 219 |
lambda w, n, o, c: o.add_smart_playlist(), |
| 220 |
).register('playlist-panel-menu') |
| 221 |
|
| 222 |
menu.simple_menu_item( |
| 223 |
'import-playlist', |
| 224 |
['new-smart-playlist'], |
| 225 |
_('_Import Playlist'), |
| 226 |
'document-open', |
| 227 |
lambda w, n, o, c: o.import_playlist(), |
| 228 |
).register('playlist-panel-menu') |
| 229 |
|
| 230 |
menu.simple_separator('top-sep', after=['import-playlist']).register( |
| 231 |
'playlist-panel-menu' |
| 232 |
) |
| 233 |
|
| 234 |
|
| 235 |
__create_playlist_panel_menus() |
| 236 |
|
| 237 |
|
| 238 |
class PlaylistPanelMenu(menu.ProviderMenu): |
| 239 |
""" |
| 240 |
Menu for xlgui.panel.playlists.PlaylistsPanel, for when the |
| 241 |
user does not click on a playlist/track. The default menu. |
| 242 |
|
| 243 |
Provider key: playlist-panel-menu |
| 244 |
""" |
| 245 |
|
| 246 |
def __init__(self, parent): |
| 247 |
menu.ProviderMenu.__init__(self, 'playlist-panel-menu', parent) |
| 248 |
|
| 249 |
|
| 250 |
def __create_playlist_panel_playlist_menus(): |
| 251 |
items = [] |
| 252 |
|
| 253 |
items.append(menu.simple_separator('pp-top-sep', ['properties'])) |
| 254 |
|
| 255 |
items.append( |
| 256 |
menuitems.RenamePlaylistMenuItem('rename-playlist', after=[items[-1].name]) |
| 257 |
) |
| 258 |
items.append( |
| 259 |
menuitems.EditPlaylistMenuItem('edit-playlist', after=[items[-1].name]) |
| 260 |
) |
| 261 |
items.append( |
| 262 |
menuitems.ExportPlaylistMenuItem('export-playlist', after=[items[-1].name]) |
| 263 |
) |
| 264 |
items.append( |
| 265 |
menuitems.ExportPlaylistFilesMenuItem('export-files', after=[items[-1].name]) |
| 266 |
) |
| 267 |
|
| 268 |
items.append(menu.simple_separator('pp-sep', after=[items[-1].name])) |
| 269 |
|
| 270 |
items.append( |
| 271 |
menuitems.DeletePlaylistMenuItem('delete-playlist', after=[items[-1].name]) |
| 272 |
) |
| 273 |
|
| 274 |
for item in items: |
| 275 |
item.register('playlist-panel-context-menu') |
| 276 |
|
| 277 |
|
| 278 |
__create_playlist_panel_playlist_menus() |
| 279 |
|
| 280 |
|
| 281 |
class PlaylistsPanelPlaylistMenu(menu.MultiProviderMenu): |
| 282 |
""" |
| 283 |
Context menu when a playlist is clicked |
| 284 |
|
| 285 |
Provider keys: playlist-panel-menu, track-panel-menu, playlist-panel-context-menu |
| 286 |
""" |
| 287 |
|
| 288 |
def __init__(self, parent): |
| 289 |
menu.MultiProviderMenu.__init__( |
| 290 |
self, |
| 291 |
['playlist-panel-menu', 'track-panel-menu', 'playlist-panel-context-menu'], |
| 292 |
parent, |
| 293 |
) |
| 294 |
|
| 295 |
def get_context(self): |
| 296 |
context = common.LazyDict(self._parent) |
| 297 |
context['needs-computing'] = ( |
| 298 |
lambda name, parent: parent.tree.get_selection_is_computed() |
| 299 |
) |
| 300 |
context['selected-playlist'] = ( |
| 301 |
lambda name, parent: parent.tree.get_selected_page(raw=True) |
| 302 |
) |
| 303 |
context['selected-tracks'] = ( |
| 304 |
lambda name, parent: parent.tree.get_selected_tracks() |
| 305 |
) |
| 306 |
context['selection-empty'] = ( |
| 307 |
lambda name, parent: parent.tree.get_selection_empty() |
| 308 |
) |
| 309 |
return context |
| 310 |
|
| 311 |
|
| 312 |
### Radio panel menu |
| 313 |
|
| 314 |
|
| 315 |
def __create_radio_panel_menus(): |
| 316 |
# w, n, o, c: window, name, parent, context |
| 317 |
|
| 318 |
menu.simple_menu_item( |
| 319 |
'new-station', |
| 320 |
[], |
| 321 |
_('_New Station'), |
| 322 |
'list-add', |
| 323 |
lambda w, n, o, c: o._on_add_button_clicked(), |
| 324 |
).register('radio-panel-menu') |
| 325 |
|
| 326 |
|
| 327 |
__create_radio_panel_menus() |
| 328 |
|
| 329 |
|
| 330 |
class RadioPanelPlaylistMenu(menu.MultiProviderMenu): |
| 331 |
""" |
| 332 |
Context menu when a playlist is clicked |
| 333 |
""" |
| 334 |
|
| 335 |
def __init__(self, parent): |
| 336 |
menu.MultiProviderMenu.__init__( |
| 337 |
self, |
| 338 |
['radio-panel-menu', 'track-panel-menu', 'playlist-panel-context-menu'], |
| 339 |
parent, |
| 340 |
) |
| 341 |
|
| 342 |
def get_context(self): |
| 343 |
context = common.LazyDict(self._parent) |
| 344 |
context['selected-playlist'] = ( |
| 345 |
lambda name, parent: parent.tree.get_selected_page(raw=True) |
| 346 |
) |
| 347 |
context['selected-tracks'] = ( |
| 348 |
lambda name, parent: parent.tree.get_selected_tracks() |
| 349 |
) |
| 350 |
context['selection-empty'] = ( |
| 351 |
lambda name, parent: parent.tree.get_selection_empty() |
| 352 |
) |
| 353 |
return context |