Package gui :: Package components :: Module menu
[hide private]
[frames] | no frames]

Module menu

source code

Module for the main relax menu bar.

Functions [hide private]
wx.MenuItem() instance
build_menu_item(menu, parent=None, id=-1, text='', tooltip='', icon=None, fn=None, append=True)
Construct and return the menu sub-item.
source code
Variables [hide private]
  __package__ = 'gui.components'

Imports: wx, dep_check


Function Details [hide private]

build_menu_item(menu, parent=None, id=-1, text='', tooltip='', icon=None, fn=None, append=True)

source code 

Construct and return the menu sub-item.

Parameters:
  • menu (wx.Menu instance) - The menu object to place this entry in.
  • id (int) - The element identification number.
  • text (None or str) - The text for the menu entry.
  • tooltip (str) - A tool tip.
  • icon (None or str) - The bitmap icon path.
  • fn (class method) - The function to bind to the menu entry.
  • append (bool) - A flag which if true will cause the element to be appended to the given menu.
Returns: wx.MenuItem() instance
The initialised wx.MenuItem() instance.