Package wx :: Package lib :: Package agw :: Module flatmenu :: Class FlatMenu

[frames | no frames]

## Type FlatMenu

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                Window --+
                         |
               PopupWindow --+
                             |
             ShadowPopupWindow --+
                                 |
                      FlatMenuBase --+
                                     |
                                    FlatMenu

A Flat popup menu generic implementation.

Method Summary
| ``__init__`(self, parent)` Default class constructor.
| ``AdvanceSelection`(self, down)` Advance forward or backward the current selection.
| ``Append`(self, id, item, helpString, kind)` Appends an item to this menu.
| ``AppendCheckItem`(self, id, item, helpString)` Appends a wx.ITEM_CHECK item to this menu.
| ``AppendItem`(self, menuItem)` Appends an item to this menu.
| ``AppendMenu`(self, id, item, subMenu, helpString)` Appends a menu to this menu.
| ``AppendRadioItem`(self, id, item, helpString)` Appends a wx.ITEM_RADIO item to this menu.
| ``AppendSeparator`(self)` Appends a wx.ITEM_SEPARATOR item to this menu.
| ``Clear`(self)` Clears the menu items.
| ``CloseSubMenu`(self, itemIdx, alwaysClose)` Close a child sub-menu.
| ``Destroy`(self, item)` Destroys an item from the menu.
| ``Dismiss`(self, dismissParent, resetOwner)` Dismisses the popup window.
| ``DoAction`(self, itemIdx)` Performs an action based on user selection.
| ``DoDrawMenu`(self, dc)` Actually draws the menu.
| ``DrawLeftMargin`(self, dc, menuRect)` Draws the menu left margin.
| ``DrawSelection`(self, dc, oldSelection)` Redraws the menu.
| ``FindItem`(self, itemId, menu)` Finds an item inside the menu based on its id.
| ``FindMenuItemPos`(self, itemId, menu)` Finds an item and its position inside the menu based on its id.
| ``FindMenuItemPosSimple`(self, item)` Finds an item and its position inside the menu based on its id.
| `GetAccelArray(self)`
| ``GetAccelTable`(self)` Returns the menu accelerator table.
| ``GetAllItems`(self, menu, items)` Internal function to help recurse thru all over the menu items.
| ``GetBorderXWidth`(self)` Returns the menu border x-width.
| ``GetBorderYWidth`(self)` Returns the menu border y-width.
| ``GetItemHeight`(self)` Returns the height of a particular item.
| ``GetLeftMarginWidth`(self)` Returns the menu left margin width.
| `GetMenuBar(self)`
| `GetMenuBarForSubMenu(self)`
| ``GetMenuItemWidth`(self, menuItem)` Returns the width of a particular item.
| ``GetMenuRect`(self)` Returns the menu rect.
| ``GetMenuWidth`(self)` Returns the menu width.
| ``GetNumberColumns`(self)` Returns the number of columns for a menu window.
| ``GetRightMarginWidth`(self)` Returns the menu right margin width.
| ``GetSiblingGroupItem`(self, item)` Used internally.
| ``HitTest`(self, pos)` HitTest method for FlatMenu.
| ``Insert`(self, pos, id, item, helpString, kind)` Inserts an item into the menu.
| ``InsertItem`(self, pos, item)` Inserts an item into the menu.
| ``InsertSeparator`(self, pos)` Inserts a wx.ITEM_SEPARATOR item in teh position 'pos'.
| ``OnChar`(self, key)` Handles key events for FlatMenu.
| ``OnEraseBg`(self, event)` Handles the wx.EVT_ERASE_BACKGROUND event for FlatMenu.
| ``OnKeyDown`(self, event)` Handles the wx.EVT_KEY_DOWN event for FlatMenu.
| ``OnKillFocus`(self, event)` Handles the wx.EVT_KILL_FOCUS event for FlatMenu.
| ``OnMouseEnterWindow`(self, event)` Handles the wx.EVT_ENTER_WINDOW event for FlatMenu.
| ``OnMouseLeaveWindow`(self, event)` Handles the wx.EVT_LEAVE_WINDOW event for FlatMenu.
| ``OnMouseLeftDown`(self, event)` Handles the wx.EVT_LEFT_DOWN event for FlatMenu.
| ``OnMouseLeftUp`(self, event)` Handles the wx.EVT_LEFT_UP event for FlatMenu.
| ``OnMouseMove`(self, event)` Handles the wx.EVT_MOTION event for FlatMenu.
| ``OnMouseRightDown`(self, event)` Handles the wx.EVT_RIGHT_DOWN event for FlatMenu.
| ``OnPaint`(self, event)` Handles the wx.EVT_PAINT event for FlatMenu.
| ``OnTimer`(self, event)` Handles the wx.EVT_TIMER event for FlatMenu.
| ``OpenItemContextMenu`(self, itemIdx)` Open an item's context menu (if any).
| ``Popup`(self, pt, owner, parent)` Pops up the menu.
| ``ProcessMouseLClick`(self, pos)` Processes mouse left clicks.
| ``ProcessMouseLClickEnd`(self, pos)` Processes mouse left clicks.
| ``ProcessMouseMove`(self, pos)` Processes mouse movements.
| ``ProcessMouseRClick`(self, pos)` Processes mouse right clicks.
| ``RefreshChilds`(self)` In some cases, we need to perform a recursive refresh for all opened submenu from this.
| ``Remove`(self, item)` Removes an item from the menu.
| ``ResizeMenu`(self)` Resizes the menu to the correct size.
| ``ScrollDown`(self)` Scrolls the menu down (for very tall menus).
| ``ScrollUp`(self)` Scrolls the menu up (for very tall menus).
| ``SendCmdEvent`(self, itemIdx)` Actually sends menu command events.
| ``SendOverItem`(self, itemIdx, over)` Sends a mouse over/mouse out event on menu items.
| ``SendUIEvent`(self, itemIdx)` Actually sends menu UI events.
| ``SetMenuBar`(self, mb)` Attaches this menu to a menubar.
| ``SetNumberColumns`(self, numCols)` Sets the number of columns for a menu window.
| `SetSubMenuBar(self, mb)`
| ``TryOpenSubMenu`(self, itemIdx, selectFirst)` If itemIdx is an item with submenu, open it.
| ``TryScrollButtons`(self, event)` Used internally.
| ``UpdateItem`(self, item)` Updates an item.
| ``UpdateRadioGroup`(self, item)` Updates a group of radio items.

Property Summary

Instance Method Details

### __init__(self, parent=None)
(Constructor)

Default class constructor.

  Overrides:
    `wx.lib.agw.flatmenu.FlatMenuBase.__init__`

### AdvanceSelection(self, down=True)

Advance forward or backward the current selection.

### Append(self, id, item, helpString, kind)

Appends an item to this menu.

### AppendCheckItem(self, id, item, helpString)

Appends a wx.ITEM_CHECK item to this menu.

### AppendItem(self, menuItem)

Appends an item to this menu.

### AppendMenu(self, id, item, subMenu, helpString)

Appends a menu to this menu.

### AppendRadioItem(self, id, item, helpString)

Appends a wx.ITEM_RADIO item to this menu.

### AppendSeparator(self)

Appends a wx.ITEM_SEPARATOR item to this menu.

### Clear(self)

Clears the menu items.

### CloseSubMenu(self, itemIdx, alwaysClose=False)

Close a child sub-menu.

### Destroy(self, item)

Destroys an item from the menu.

  Overrides:
    `wx.Window.Destroy`

### Dismiss(self, dismissParent, resetOwner)

Dismisses the popup window.

  Overrides:
    `wx.lib.agw.flatmenu.FlatMenuBase.Dismiss`

### DoAction(self, itemIdx)

Performs an action based on user selection.

### DoDrawMenu(self, dc)

Actually draws the menu.

### DrawLeftMargin(self, dc, menuRect)

Draws the menu left margin.

### DrawSelection(self, dc, oldSelection=-1)

Redraws the menu.

### FindItem(self, itemId, menu=None)

Finds an item inside the menu based on its id.

### FindMenuItemPos(self, itemId, menu=None)

Finds an item and its position inside the menu based on its id.

### FindMenuItemPosSimple(self, item)

Finds an item and its position inside the menu based on its id.

### GetAccelTable(self)

Returns the menu accelerator table.

### GetAllItems(self, menu=None, items=[])

Internal function to help recurse thru all over the menu items.

### GetBorderXWidth(self)

Returns the menu border x-width.

### GetBorderYWidth(self)

Returns the menu border y-width.

### GetItemHeight(self)

Returns the height of a particular item.

### GetLeftMarginWidth(self)

Returns the menu left margin width.

### GetMenuItemWidth(self, menuItem)

Returns the width of a particular item.

### GetMenuRect(self)

Returns the menu rect.

### GetMenuWidth(self)

Returns the menu width.

### GetNumberColumns(self)

Returns the number of columns for a menu window.

### GetRightMarginWidth(self)

Returns the menu right margin width.

### GetSiblingGroupItem(self, item)

Used internally.

### HitTest(self, pos)

HitTest method for FlatMenu.

  Overrides:
    `wx.Window.HitTest`

### Insert(self, pos, id, item, helpString='', kind=0)

Inserts an item into the menu.

### InsertItem(self, pos, item)

Inserts an item into the menu.

### InsertSeparator(self, pos)

Inserts a wx.ITEM_SEPARATOR item in teh position 'pos'.

### OnChar(self, key)

Handles key events for FlatMenu.

### OnEraseBg(self, event)

Handles the wx.EVT_ERASE_BACKGROUND event for FlatMenu.

### OnKeyDown(self, event)

Handles the wx.EVT_KEY_DOWN event for FlatMenu.

### OnKillFocus(self, event)

Handles the wx.EVT_KILL_FOCUS event for FlatMenu.

### OnMouseEnterWindow(self, event)

Handles the wx.EVT_ENTER_WINDOW event for FlatMenu.

### OnMouseLeaveWindow(self, event)

Handles the wx.EVT_LEAVE_WINDOW event for FlatMenu.

### OnMouseLeftDown(self, event)

Handles the wx.EVT_LEFT_DOWN event for FlatMenu.

### OnMouseLeftUp(self, event)

Handles the wx.EVT_LEFT_UP event for FlatMenu.

### OnMouseMove(self, event)

Handles the wx.EVT_MOTION event for FlatMenu.

### OnMouseRightDown(self, event)

Handles the wx.EVT_RIGHT_DOWN event for FlatMenu.

### OnPaint(self, event)

Handles the wx.EVT_PAINT event for FlatMenu.

### OnTimer(self, event)

Handles the wx.EVT_TIMER event for FlatMenu.

### OpenItemContextMenu(self, itemIdx)

Open an item's context menu (if any).

### Popup(self, pt, owner=None, parent=None)

Pops up the menu.

  Overrides:
    `wx.lib.agw.flatmenu.FlatMenuBase.Popup`

### ProcessMouseLClick(self, pos)

Processes mouse left clicks.

### ProcessMouseLClickEnd(self, pos)

Processes mouse left clicks.

### ProcessMouseMove(self, pos)

Processes mouse movements.

### ProcessMouseRClick(self, pos)

Processes mouse right clicks.

### RefreshChilds(self)

In some cases, we need to perform a recursive refresh for all opened submenu from this.

### Remove(self, item)

Removes an item from the menu.

### ResizeMenu(self)

Resizes the menu to the correct size.

### ScrollDown(self)

Scrolls the menu down (for very tall menus).

  Overrides:
    `wx.lib.agw.flatmenu.FlatMenuBase.ScrollDown`

### ScrollUp(self)

Scrolls the menu up (for very tall menus).

  Overrides:
    `wx.lib.agw.flatmenu.FlatMenuBase.ScrollUp`

### SendCmdEvent(self, itemIdx)

Actually sends menu command events.

### SendOverItem(self, itemIdx, over)

Sends a mouse over/mouse out event on menu items.

### SendUIEvent(self, itemIdx)

Actually sends menu UI events.

### SetMenuBar(self, mb)

Attaches this menu to a menubar.

### SetNumberColumns(self, numCols)

Sets the number of columns for a menu window.

### TryOpenSubMenu(self, itemIdx, selectFirst=False)

If itemIdx is an item with submenu, open it.

### TryScrollButtons(self, event)

Used internally.

### UpdateItem(self, item)

Updates an item.

### UpdateRadioGroup(self, item)

Updates a group of radio items.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:53:51 2009 | http://epydoc.sf.net