C:/work/RevealedSystems/EyeSpy-RS/eyespy/src/objects/gui/mainFrameMenuBar.py

Go to the documentation of this file.

# Copyright (C) 2008-2009  Mark Hanegraaff
#
# This program 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 3 of the License, or
# (at your option) any later version.
#
# This program 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, see <http://www.gnu.org/licenses/>.


import wx
from objects.logic.common.globalStrings import globalStrings
from mainFrameContainer import mainFrameContainer


## Menu bar class.
# The menu bar is currently not used, but it can easily added to the main window during initialization/
# There is nothing in the menu bar which cannot be found in the toolbar
class mainFrameMenuBar(mainFrameContainer):
    def __init__(self, mainFrm):
        self.mainFrame = mainFrm        
        self.createMenuBar()
        
        
    """
        Menubar related
    """
    
    ## Creates the menubar, and attached it to the parent.
    def createMenuBar(self):
        menuBar = wx.MenuBar()
        for eachMenuData in self.menuData():
            menuLabel = eachMenuData[0]
            menuItems = eachMenuData[1]
            menuBar.Append(self.createMenu(menuItems), menuLabel)
        self.mainFrame.SetMenuBar(menuBar)

    
    ## Creates the menu item, given a dictionary containing the menu's properties
    # @param menuData Dictionary containing all menu items which are part of a menu
    # @return Menu wx.Menu, which is then attached to the menu bar
    def createMenu(self, menuData):
        menu = wx.Menu()
        for eachItem in menuData:
            if len(eachItem) == 2:
                label = eachItem[0]
                subMenu = self.createMenu(eachItem[1])
                menu.AppendMenu(wx.NewId(), label, subMenu)
            else:
                self.createMenuItem(menu, *eachItem)
        return menu
    
    
    ## Creates a single menu item. This is basically a helper function used by "createMenu".
    # @param menu The wx.Menu object to which append this item.
    # @param label String label of the menu item
    # @param status I believe this indicates whether the item is enabled or not
    # @param handler Handler function which is invoked when this item is triggered
    # @param kind Additional Menu items descriptor. I forget what this does exactly.  
    def createMenuItem(self, menu, label, status, handler, kind=wx.ITEM_NORMAL):
        if not label:
            menu.AppendSeparator()
            return
        menuItem = menu.Append(-1, label, status, kind)
        self.mainFrame.Bind(wx.EVT_MENU, handler, menuItem)
    
    
    ## Menu data hash.
    def menuData(self):
        return [("&File", (                    
                    ("", "", ""),
                    ("&Exit", "Exit", self.mainFrame.handleExit)
                    
                    ))]

---