FBGenericMenu Class Reference

FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu FBGenericMenu

Inheritance diagram for FBGenericMenu:

[legend]

List of all members.

---

Detailed Description

A GenericMenu class.

You can use this class either to create a new menu in the menu bar (or in a menuitem in the menu bar) or you can use this class to create a pop-up menu.

    #to start a pop up menu use the Execute method
    def mouseClick(x, y):
        item = menu.Execute(x, y)
        if item.Id == 10:
           [do this]
        else if item.Id == 100:
            [do that...]

There are 4 ways to insert new item in a menu. Each method needs the name of the menuitem as well as it's unique id. You can also optionnally sets a new menu for a specific item.

    embeededMenu = FBGenericMenu()
    menu.InsertLast("new new item", 67, embeddedMenu)

    #A genericMenu contains a GenericMenuItem for each entry. You can iterate on the different menuitem
    #using GetFirstITem/GetNextItem or if you already know the id of the item you can get it with GetItem.

    item = menu.GetFirstItem()
    while item:
        print item.Name
        item = menu.GetNextItem(item)

You can also delete a Menu item: this will remove the item from the menu as well as freeing its memory.To be notified when a menuitem is clicked, you can register using OnMenuActivate. This will send a FBEventMenu containing the name and the Id of the menu item that was clicked.

See sample: FBMenu.py.

Public Member Functions
	FBGenericMenu ()
	Default constructor.
	DeleteItem (FBGenericMenuItem pToDelete)
	Remove a menu item from the menu and delete it.
FBGenericMenuItem	Execute (int pX, int pY, bool pRightAlign=True)
	Starts the menu as a pop-up menu at a specific location on screen.
FBGenericMenuItem	GetFirstItem ()
	Returns the first menu item (if existing) in this menu.
FBGenericMenuItem	GetItem (int pItemId)
	Returns the menu item corresponding to an id.
FBGenericMenuItem	GetLastItem ()
	Returns the last menu item (if existing) in this menu.
FBGenericMenuItem	GetNextItem (FBGenericMenuItem pItem)
	Returns the menu item following an other item.
FBGenericMenuItem	GetPrevItem (FBGenericMenuItem pItem)
	Returns the menu item preceding an other item.
FBGenericMenuItem	InsertAfter (FBGenericMenuItem pBeforeItem, str pItemName, int pItemId, FBGenericMenu pMenu=None)
	Inserts a new menu Item AFTER another item.
FBGenericMenuItem	InsertBefore (FBGenericMenuItem pAfterItem, str pItemName, int pItemId, FBGenericMenu pMenu=None)
	Inserts a new menu Item BEFORE another item.
FBGenericMenuItem	InsertFirst (str pItemName, int pItemId, FBGenericMenu pMenu=None)
	Inserts a new menu Item at the first position in the menu list.
FBGenericMenuItem	InsertLast (str pItemName, int pItemId, FBGenericMenu pMenu=None)
	Inserts a new menu Item at the last position in the menu list.
Public Attributes
FBEvent	OnMenuActivate
	Event Property: Register on this property to be notified when a menu item is clicked by the user.

---

Constructor & Destructor Documentation

FBGenericMenu

(

)

Default constructor.

Used to create embedded menu (inside aniother menu item) or pop-up menu.

---

Member Function Documentation

DeleteItem

(

FBGenericMenuItem

pToDelete

)

Remove a menu item from the menu and delete it.

Parameters:

pToDelete

The item to remove.

FBGenericMenuItem Execute	(	int	pX,
		int	pY,
		bool	pRightAlign = True
	)

Starts the menu as a pop-up menu at a specific location on screen.

It returns the item that was clicked by the user.

Parameters:

	pX	X location in pixel on screen where the menu is to be popped.
	pY	Y location in pixel on screen where the menu is to be poppded.
	pRightAlign	All menu item will be align to the right justified (if true) or left justifed (if false)

Returns:

The selected item by the user. Null if the user clicks outside the menu.

FBGenericMenuItem GetFirstItem

(

)

Returns the first menu item (if existing) in this menu.

You can then use GetNextItem to iterate on other menu items.

Returns:

The first menu item in this Menu.

FBGenericMenuItem GetItem

(

int

pItemId

)

Returns the menu item corresponding to an id.

Parameters:

pItemId

Id of the item we are looking for.

Returns:

Will return the Item corresponding to an id (null if not found).

FBGenericMenuItem GetLastItem

(

)

Returns the last menu item (if existing) in this menu.

You can then use GetPrevItem to reverse iterate on other menu items.

Returns:

The last menu item in this Menu.

FBGenericMenuItem GetNextItem

(

FBGenericMenuItem

pItem

)

Returns the menu item following an other item.

Returns null if this is the last item in menu.

Parameters:

pItem

Will return the item after pItem

Returns:

Will return the item after pItem. Null if pItem is the last item.

FBGenericMenuItem GetPrevItem

(

FBGenericMenuItem

pItem

)

Returns the menu item preceding an other item.

Returns null if this is the first item in menu.

Parameters:

pItem

Will return the item BEFORE pItem

Returns:

Will return the item BEFORE pItem. Null if pItem is the first item.

FBGenericMenuItem InsertAfter	(	FBGenericMenuItem	pBeforeItem,
		str	pItemName,
		int	pItemId,
		FBGenericMenu	pMenu = None
	)

Inserts a new menu Item AFTER another item.

Parameters:

	pBeforeItem	The reference item. We will create a new item AFTER this one.
	pItemName	Caption of the newly added item.
	pItemId	Unique id of this menu item.
	pMenu	Optionnal. If this Item leads to another menu (embddedd) it can be specified here.

Returns:

Will return the menu item created from this insertion.

FBGenericMenuItem InsertBefore	(	FBGenericMenuItem	pAfterItem,
		str	pItemName,
		int	pItemId,
		FBGenericMenu	pMenu = None
	)

Inserts a new menu Item BEFORE another item.

Parameters:

	pAfterItem	The reference item. We will create a new item BEFORE this one.
	pItemName	Caption of the newly added item.
	pItemId	Unique id of this menu item.
	pMenu	Optionnal. If this Item leads to another menu (embddedd) it can be specified here.

Returns:

Will return the menu item created from this insertion.

FBGenericMenuItem InsertFirst	(	str	pItemName,
		int	pItemId,
		FBGenericMenu	pMenu = None
	)

Inserts a new menu Item at the first position in the menu list.

Parameters:

	pItemName	Caption of the newly added item.
	pItemId	Unique id of this menu item.
	pMenu	Optionnal. If this Item leads to another menu (embddedd) it can be specified here.

Returns:

Will return the menu item created from this insertion.

FBGenericMenuItem InsertLast	(	str	pItemName,
		int	pItemId,
		FBGenericMenu	pMenu = None
	)

Inserts a new menu Item at the last position in the menu list.

Parameters:

	pItemName	Caption of the newly added item.
	pItemId	Unique id of this menu item.
	pMenu	Optionnal. If this Item leads to another menu (embddedd) it can be specified here.

Returns:

Will return the menu item created from this insertion.

---

Member Data Documentation

FBEvent OnMenuActivate

Event Property: Register on this property to be notified when a menu item is clicked by the user.

---