Package aldrin :: Module interface :: Class IMainFrame
[show private | hide private]
[frames | no frames]

Type IMainFrame

object --+    
         |    
 Interface --+
             |
            IMainFrame

Known Subclasses:
AldrinFrame

Base interface for the mainframe window.
Method Summary
  add_click_handler(self, toolid, func)
Adds a handler for when a tool is being clicked by the user.
int add_menuitem(self, label, description, kind)
Adds a new menuitem to the tools menu and returns the identifier.
int add_submenu(self, label, submenu, description)
Adds a new submenu to the tools menu and returns the identifier.
int add_tool_button(self, label, bitmap1, bitmap2, kind, tooltip, description)
Adds a new tool to the toolbar and returns the identifier.
wx.Window get_window(self)
Returns the window object associated with the mainframe.
    Inherited from Interface
  __init__(self)
Compares implemented methods and warns on discrepancies in argument count, argument names or default values.
  create_protected_proxy(self, ifaces)
Returns a protected proxy object that only exports methods defined in interfaces.
  get_interfaces(self)
Returns all supported interfaces.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

add_click_handler(self, toolid, func)

Adds a handler for when a tool is being clicked by the user.
Parameters:
toolid - Id of the tool as returned by add_tool()
           (type=int)
func - Function to call. The function should take an additional event parameter.
           (type=callable)

add_menuitem(self, label, description='', kind=0)

Adds a new menuitem to the tools menu and returns the identifier.
Parameters:
label - Label of the item.
           (type=str)
description - Description for Status bar.
           (type=str)
kind - One of wx.ITEM_NORMAL, wx.ITEM_CHECK or wx.ITEM_RADIO
           (type=int)
Returns:
Identifier of the menuitem.
           (type=int)

add_submenu(self, label, submenu, description='')

Adds a new submenu to the tools menu and returns the identifier.
Parameters:
label - Label of the item.
           (type=str)
submenu - The submenu which to add.
           (type=wx.Menu)
description - Description for Status bar.
           (type=str)
Returns:
Identifier of the menuitem.
           (type=int)

add_tool_button(self, label, bitmap1, bitmap2=wxPython wrapper for UNBORN object! (The C++ object is no..., kind=0, tooltip='', description='')

Adds a new tool to the toolbar and returns the identifier.
Parameters:
label - Label of the button. Will not be visible on all systems.
           (type=str)
bitmap1 - Bitmap for the button.
           (type=wx.Bitmap)
bitmap2 - Bitmap for disabled button.
           (type=wx.Bitmap)
kind - One of wx.ITEM_NORMAL, wx.ITEM_CHECK or wx.ITEM_RADIO
           (type=int)
tooltip - Tooltip Text
           (type=str)
description - Description for Status bar.
           (type=str)
Returns:
Identifier of the toolbar button.
           (type=int)

get_window(self)

Returns the window object associated with the mainframe.
Returns:
Window object.
           (type=wx.Window)

Generated by Epydoc 2.1 on Sun Feb 4 18:01:15 2007 http://epydoc.sf.net