C:/work/RevealedSystems/EyeSpy-RS/eyespy/src/objects/gui/mainFramePopupMenu.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.entity.filter.filterDictionary import filterDictionary
from objects.gui.mainFrameContainer import mainFrameContainer



## Right click Popup menu object. Invoked whenever the Right Click is used over the main window.
class mainFramePopupMenu(mainFrameContainer):
    
    def __init__(self, mainFrm):
        mainFrameContainer.__init__(self, mainFrm)
        
        self.hideMenu  = None
        self.traceMenu = None

    ## Creates all static menu items. These are the items which never change and always show up on the menu.
    def constructStaticItems(self):
        self.addMenuItem(("View Filters",     "VIEW_FILTERS", ""),    self.mainFrmPopupMenu)                          
        self.mainFrmPopupMenu.AppendSeparator()          
        self.addMenuItem(("Display Settings", "DISPLAY_SETTING", ""), self.mainFrmPopupMenu)
        self.addMenuItem(("Options",          "SHOW_OPTIONS", ""),     self.mainFrmPopupMenu)                

    ## Creates the all the dynamically generated filter items. These are entirely dependent on the
    # supplied Networked Entity list
    # @param entList list of Networked Entity objects
    def constructFilterMenu(self, entList):
        self.FilterSubmenu = wx.Menu()
        
        menuItemNames = dict()
        
        filterDict = filterDictionary()
        
        for menuName, attrTuple in filterDict.filter.iteritems():
            attr, dataType = attrTuple
            for ent in entList:
                
                if ent[attr] is not None and unicode(ent[attr]) != "": 
                    nextItem = "%s: %s" % (menuName, unicode(ent[attr]))
                    
                    if not menuItemNames.has_key(nextItem):
                        # add the item to the sub menu
                        self.addMenuItem( (nextItem, "FILTERITEM", (menuName, ent[attr])), self.FilterSubmenu)
                                          
                        menuItemNames[nextItem] = 1
        
        # now append the submen to main one
        self.hideMenu = self.mainFrmPopupMenu.AppendMenu(-1, "Hide", self.FilterSubmenu)
    
    
    
    ## Builds the entire popup menu. This is usually what it called in response to the 
    # user right clicking onto the main window
    # @param entList list of Networked Entity objects used for the dynamic menu items
    def buildMenuFromEntList(self, entList):        
        self.mainFrmPopupMenu = wx.Menu()
        self.menu_items_ids = dict()        
        
        self.DisplaySubmenu = wx.Menu()
        
        self.addMenuItem(("All Peers", "SHOWDETAILSALL", ""), self.DisplaySubmenu)
        self.addMenuItem(("Visible Peers", "SHOWDETAILSVIS", ""), self.DisplaySubmenu)
        
        self.mainFrmPopupMenu .AppendMenu(-1, "Show Details", self.DisplaySubmenu)        
                        
        if entList != None:        
            if len(entList) == 1:
                self.addMenuItem(("Peer", "SHOWDETAILS", ""), self.DisplaySubmenu)
                                
                self.traceMenu = self.addMenuItem(("Display Network Trace", "DISPLAY_TRACE", ""),    self.mainFrmPopupMenu)
                self.mainFrmPopupMenu.AppendSeparator()                                          
                
            else:
                self.addMenuItem(("Peer Group", "SHOWDETAILS", ""), self.DisplaySubmenu)
                
            self.constructFilterMenu(entList)
        
        self.constructStaticItems()
        
        
        
    ## Attach a Menu Item to the Menu object
    # @param itemTuple Tuple in the form of (itemName, itemCategory, itemParams)
    # @param whichMenu wx.Menu object to which attach this item
    def addMenuItem(self, itemTuple, whichMenu):
        id = wx.NewId()
        self.menu_items_ids[id] = itemTuple
        
        itemName, itemAction, itemParams = itemTuple        
            
        ret = whichMenu.Append(id, itemName)
        
        wx.EVT_MENU(self.mainFrmPopupMenu, id, self.mainFrame.popupMenuCallBack)
        
        return ret
    
    ## returns the Menu object
    # @return wx.Menu
    def getMenu(self):
        return self.mainFrmPopupMenu
    
    
    ## returns an Item from the Menu object
    # @param id wx.NewId, this is usually attached to the wx.Event object
    # @return Tuple in the form of (itemName, itemCategory, itemParams)
    def getMenuItem(self, id):
        return self.menu_items_ids[id]
            
        
            
            
     

---