"""
Copyright 2007, 2008, 2009 Free Software Foundation, Inc.
This file is part of GNU Radio
GNU Radio Companion is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
GNU Radio Companion is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
"""
import pygtk
pygtk.require('2.0')
import gtk
from . import Actions
# The list of actions for the toolbar.
TOOLBAR_LIST = (
Actions.FLOW_GRAPH_NEW,
Actions.FLOW_GRAPH_OPEN,
Actions.FLOW_GRAPH_SAVE,
Actions.FLOW_GRAPH_CLOSE,
None,
Actions.FLOW_GRAPH_SCREEN_CAPTURE,
None,
Actions.BLOCK_CUT,
Actions.BLOCK_COPY,
Actions.BLOCK_PASTE,
Actions.ELEMENT_DELETE,
None,
Actions.FLOW_GRAPH_UNDO,
Actions.FLOW_GRAPH_REDO,
None,
Actions.ERRORS_WINDOW_DISPLAY,
Actions.FLOW_GRAPH_GEN,
Actions.FLOW_GRAPH_EXEC,
Actions.FLOW_GRAPH_KILL,
None,
Actions.BLOCK_ROTATE_CCW,
Actions.BLOCK_ROTATE_CW,
None,
Actions.BLOCK_ENABLE,
Actions.BLOCK_DISABLE,
Actions.BLOCK_BYPASS,
Actions.TOGGLE_HIDE_DISABLED_BLOCKS,
None,
Actions.FIND_BLOCKS,
Actions.RELOAD_BLOCKS,
Actions.OPEN_HIER,
)
# The list of actions and categories for the menu bar.
MENU_BAR_LIST = (
(gtk.Action('File', '_File', None, None), [
'flow_graph_new',
Actions.FLOW_GRAPH_OPEN,
None,
Actions.FLOW_GRAPH_SAVE,
Actions.FLOW_GRAPH_SAVE_AS,
None,
Actions.FLOW_GRAPH_SCREEN_CAPTURE,
None,
Actions.FLOW_GRAPH_CLOSE,
Actions.APPLICATION_QUIT,
]),
(gtk.Action('Edit', '_Edit', None, None), [
Actions.FLOW_GRAPH_UNDO,
Actions.FLOW_GRAPH_REDO,
None,
Actions.BLOCK_CUT,
Actions.BLOCK_COPY,
Actions.BLOCK_PASTE,
Actions.ELEMENT_DELETE,
None,
Actions.BLOCK_ROTATE_CCW,
Actions.BLOCK_ROTATE_CW,
None,
Actions.BLOCK_ENABLE,
Actions.BLOCK_DISABLE,
Actions.BLOCK_BYPASS,
None,
Actions.BLOCK_PARAM_MODIFY,
]),
(gtk.Action('View', '_View', None, None), [
Actions.TOGGLE_BLOCKS_WINDOW,
None,
Actions.TOGGLE_REPORTS_WINDOW,
Actions.TOGGLE_SCROLL_LOCK,
Actions.SAVE_REPORTS,
Actions.CLEAR_REPORTS,
None,
Actions.TOGGLE_HIDE_DISABLED_BLOCKS,
Actions.TOGGLE_AUTO_HIDE_PORT_LABELS,
Actions.TOGGLE_SNAP_TO_GRID,
Actions.TOGGLE_SHOW_BLOCK_COMMENTS,
None,
Actions.TOGGLE_SHOW_CODE_PREVIEW_TAB,
None,
Actions.ERRORS_WINDOW_DISPLAY,
Actions.FIND_BLOCKS,
]),
(gtk.Action('Run', '_Run', None, None), [
Actions.FLOW_GRAPH_GEN,
Actions.FLOW_GRAPH_EXEC,
Actions.FLOW_GRAPH_KILL,
]),
(gtk.Action('Tools', '_Tools', None, None), [
Actions.TOOLS_RUN_FDESIGN,
None,
Actions.TOGGLE_SHOW_FLOWGRAPH_COMPLEXITY,
None,
Actions.TOOLS_MORE_TO_COME,
]),
(gtk.Action('Help', '_Help', None, None), [
Actions.HELP_WINDOW_DISPLAY,
Actions.TYPES_WINDOW_DISPLAY,
Actions.XML_PARSER_ERRORS_DISPLAY,
None,
Actions.ABOUT_WINDOW_DISPLAY,
]),
)
# The list of actions for the context menu.
CONTEXT_MENU_LIST = [
Actions.BLOCK_CUT,
Actions.BLOCK_COPY,
Actions.BLOCK_PASTE,
Actions.ELEMENT_DELETE,
None,
Actions.BLOCK_ROTATE_CCW,
Actions.BLOCK_ROTATE_CW,
Actions.BLOCK_ENABLE,
Actions.BLOCK_DISABLE,
Actions.BLOCK_BYPASS,
None,
(gtk.Action('More', '_More', None, None), [
Actions.BLOCK_CREATE_HIER,
Actions.OPEN_HIER,
None,
Actions.BUSSIFY_SOURCES,
Actions.BUSSIFY_SINKS,
]),
Actions.BLOCK_PARAM_MODIFY
]
class Toolbar(gtk.Toolbar):
"""The gtk toolbar with actions added from the toolbar list."""
def __init__(self):
"""
Parse the list of action names in the toolbar list.
Look up the action for each name in the action list and add it to the toolbar.
"""
gtk.Toolbar.__init__(self)
self.set_style(gtk.TOOLBAR_ICONS)
for action in TOOLBAR_LIST:
if action: # add a tool item
item = action.create_tool_item()
# this reset of the tooltip property is required
# (after creating the tool item) for the tooltip to show
action.set_property('tooltip', action.get_property('tooltip'))
else:
item = gtk.SeparatorToolItem()
self.add(item)
class MenuHelperMixin(object):
"""Mixin class to help build menus from the above action lists"""
def _fill_menu(self, actions, menu=None):
"""Create a menu from list of actions"""
menu = menu or gtk.Menu()
for item in actions:
if isinstance(item, tuple):
menu_item = self._make_sub_menu(*item)
elif isinstance(item, str):
menu_item = getattr(self, 'create_' + item)()
elif item is None:
menu_item = gtk.SeparatorMenuItem()
else:
menu_item = item.create_menu_item()
menu.append(menu_item)
menu.show_all()
return menu
def _make_sub_menu(self, main, actions):
"""Create a submenu from a main action and a list of actions"""
main = main.create_menu_item()
main.set_submenu(self._fill_menu(actions))
return main
class MenuBar(gtk.MenuBar, MenuHelperMixin):
"""The gtk menu bar with actions added from the menu bar list."""
def __init__(self, generate_modes, action_handler_callback):
"""
Parse the list of submenus from the menubar list.
For each submenu, get a list of action names.
Look up the action for each name in the action list and add it to the submenu.
Add the submenu to the menu bar.
"""
gtk.MenuBar.__init__(self)
self.generate_modes = generate_modes
self.action_handler_callback = action_handler_callback
for main_action, actions in MENU_BAR_LIST:
self.append(self._make_sub_menu(main_action, actions))
def create_flow_graph_new(self):
"""Sub menu to create flow-graph with pre-set generate mode"""
def callback_adaptor(item, key):
"""Sets original FLOW_GRAPH_NEW action as source"""
self.action_handler_callback(Actions.FLOW_GRAPH_NEW, key)
sub_menu = gtk.Menu()
for key, name, default in self.generate_modes:
if default:
item = Actions.FLOW_GRAPH_NEW.create_menu_item()
item.set_label(name)
else:
item = gtk.MenuItem(name)
item.connect('activate', callback_adaptor, key)
sub_menu.append(item)
sub_menu.show_all()
main = gtk.ImageMenuItem(gtk.STOCK_NEW)
main.set_label(Actions.FLOW_GRAPH_NEW.get_label())
main.set_submenu(sub_menu)
return main
class ContextMenu(gtk.Menu, MenuHelperMixin):
"""The gtk menu with actions added from the context menu list."""
def __init__(self):
gtk.Menu.__init__(self)
self._fill_menu(CONTEXT_MENU_LIST, self)