Description

The GPopupMenu provides a means of showing a right click pop up menu that can respond to menu commands.

Example

The example below shows a simple version of a pop up menu that will print out commands to the command shell.

The above example will create a popup menu that will appears as follows,

Example of the GPopupMenu widget.

GPopupMenu Widget

The GPopupMenu widget inherits from,

• gwidget.GWidget (grail.widgets.gwidget)

class GPopupMenu([parent, **keywords])

This widget functions a little different from the other widgets. In this widget you specify the menu options as title-callback pairs. Obviously the separator doesn't have a callback and is simply specified as a '-' or '=' (what ever makes you happier).

An example of a typical popup menu configuration options would be something like this,

options = (("Cut", _oncut),
           ("Copy", _oncopy),
           ("Paste", _onpaste),
           '-'
           ("Select All", _onselectall))

where all the callbacks such as _oncut or _oncopy have already been defined.

If you define the callback as None, then the menu item will appear in a disabled state.

You have to rig up the response to the right click button, but fortunately its not to tricky and can be done as follows,

def _onmousedown(event):
   popup.show(event.widget.winfo_pointerxy())

popup = GPopupMenu(frame, options=options)
frame.bind("<3>", _onmousedown)

Basically what you are doing is,

1. Building the pop up menu.
2. Instructing the frame that the right mouse button event ("<3>") is attached to the _onmousedown function.
3. Making a call to the show function on the popup menu to make the popup menu appear where the user just made the right click.

The options can not be changed once a popup menu has been constructed; re-construct a new popup menu if you really want.

Arguments:

parent : Tkinter.Frame

Parent widget, widget we insert into.

keywords

Variable keyword list defined below.

Keyword:

option : list

Specifies the configuration for the dialog. See the above for an example of how to specify the option-callback list.

Signals:

None. You specify callbacks for each of your options with this widget.

Components:

None.

show(point)

Forces the widget to appear at x, y (in root coordinates)

Arguments:

point : x,y tuple

The x and y root coordinates that you want this window to appear at.

Example:

Typically you would have your event mapped to some event handler, that would receive an event object (for example, using the bind() attribute). Given that you had this event handler, and a popup menu called 'popup' you would do something like this,

def _onevent(event):
   popup.show(e.widget.winfo_pointerxy())