Package wx :: Package lib :: Package agw :: Module flatmenu
[frames | no frames]

Module wx.lib.agw.flatmenu

Description
===========

FlatMenu, like the name implies, it is a generic menu implementation. 
I tried to provide a full functionality for menus, menubar and toolbar.


FlatMenu supports the following features:

  - Fires all the events (UI & Cmd);
  - Check items;
  - Separators;
  - Enabled / Disabled menu items;
  - Images on items;
  - Toolbar support, with images and separators;
  - Controls in toolbar (work in progress);
  - Toolbar tools tooltips (done: thanks to Peter Kort);
  - Accelerators for menus;
  - Accelerators for menubar;
  - Radio items in menus;
  - Integration with AUI;
  - Scrolling when menu is too big to fit the screen (in progress);
  - Menu navigation with keyboard;
  - Drop down arrow button to the right of the menu, it always contains the
    "Customize" option, which will popup an options dialog. The dialog has the
    following abilities:
      (a) Ability to add/remove menus;
      (b) Select different colour schemes for the menu bar / toolbar;
      (c) Control various options, such as: colour for highlight menu item, draw
          border around menus (classic look only);
      (d) Toolbar floating appearance.
  - Allows user to specify grey bitmap for disabled menus/toolbar tools;
  - If no grey bitmap is provided, it generates one from the existing bitmap;
  - Hidden toolbar items / menu bar items - will appear in a small popmenu
    to the right if they are hidden;
  - 4 different colour schemes for the menu bar (more can easily added);
  - Scrolling is available if the menu height is greater than the screen height;
  - Context menus for menu items;
  - Show/hide the drop down arrow which allows the customization of FlatMenu;
  - Multiple columns menu window;
  - Tooltips for menus and toolbar items on a wx.StatusBar (if present);
  - Transparency (alpha channel) for menu windows (for platforms supporting it);
  - First attempt in adding controls to FlatToolbar;
  - Added a MiniBar (thanks to Vladiuz);
  - Added wx.ToolBar methods AddCheckTool/AddRadioTool (thanks to Vladiuz).
  

Events
======

FlatMenu implements this event for menus and toolbar tools:

  - EVT_FLAT_MENU_SELECTED
  - EVT_FLAT_MENU_ITEM_MOUSE_OUT
  - EVT_FLAT_MENU_ITEM_MOUSE_OVER

Supported Platforms
===================

FlatMenu v0.8 has been tested on the following platforms:
  * Windows (Windows XP);
  * Linux Ubuntu (Dapper 6.06)
v0.9.* has been tested on
  * Windows (Windows XP, Vista);

License And Version:
===================

FlatMenu is freeware and distributed under the wxPython license.
Version 0.9.2

Classes
FlatMenu A Flat popup menu generic implementation.
FlatMenuBar Implements the generic owner-drawn menu bar for FlatMenu.
FlatMenuBase Base class for generic flat menu derived from wx.PopupWindow.
FlatMenuButton A nice small class that functions like wx.BitmapButton, the reason I did not used BitmapButton is that on Linux, it has some extra margins that I can't seem to be able to remove.
FlatMenuEvent Event class that supports the FlatMenu-compatible event called EVT_FLAT_MENU_SELECTED.
FlatMenuItem A class that represents an item in a menu.
FlatMenuItemGroup A class that manages a group of radio menu items.
FlatToolbarItem This class represents a toolbar item.
FocusHandler A focus event handler.
mcPopupWindow Since Max OS does not support wx.PopupWindow, this is an alternative.
MenuEntryInfo Internal class which holds information about a menu.
MenuKbdRedirector A keyboard event handler.
ShadowPopupWindow Base class for generic FlatMenu derived from wx.PopupWindow.
StatusBarTimer Timer used for deleting StatusBar long help after _DELAY seconds.
ToolBarItem A simple class that holds information about a toolbar item.

Function Summary
  ConvertToMonochrome(bmp)
Converts a bitmap to monochrome colour.
  HeightDefault(h)
Used internally.
  MSWGetCreateWindowCoords(pos, size)
Creates window coordinates for MS platforms.
  WidthDefault(w)
Used internally.

Function Details

ConvertToMonochrome(bmp)

Converts a bitmap to monochrome colour.

HeightDefault(h)

Used internally.

MSWGetCreateWindowCoords(pos, size)

Creates window coordinates for MS platforms.

WidthDefault(w)

Used internally.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:55:02 2009 http://epydoc.sf.net