Package aldrin :: Module main :: Class AldrinFrame
[show private | hide private]
[frames | no frames]

Type AldrinFrame

            object --+        
                     |        
             Interface --+    
                         |    
                IMainFrame --+
                             |
object --+                   |
         |                   |
    Object --+               |
             |               |
    EvtHandler --+           |
                 |           |
            Window --+       |
                     |       |
        TopLevelWindow --+   |
                         |   |
                     Frame --+
                             |
                            AldrinFrame


The application main window class.
Method Summary
  __init__(self, *args, **kwds)
Initializer.
  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.
  add_tool_button(self, label, bitmap1, bitmap2, kind, tooltip, description)
Adds a new tool to the toolbar.
  clear(self)
Clears the current document.
  document_changed(self)
Event handler triggered when the document has changed.
  get_active_view(self)
Returns the active panel view.
wx.Window get_window(self)
Returns the window object associated with the mainframe.
  init_lunar(self)
Initializes the lunar dsp scripting system
  load_view(self)
Called to load view settings from config
  new(self, event)
Event handler triggered by the "New" menu option.
  on_about(self, event)
Event handler triggered by the "About" menu option.
  on_close(self, event)
Event handler triggered when the window is being closed.
  on_close_cpumonitor(self, event)
Called when the cpu monitor is closed manually.
  on_close_hdrecorder(self, event)
Called when the hd recorder is closed manually.
  on_copy(self, event)
Sent when the copy function is selected from the menu.
  on_cut(self, event)
Sent when the cut function is selected from the menu.
  on_destroy(self, event)
Event handler triggered when the window is being destroyed.
  on_exit(self, event)
Event handler triggered by the "Exit" menu option.
  on_framepanel_size(self, event)
Event handler that resizes the client panels, when the main window is being resized.
  on_handle_events(self, event)
Handler triggered by the default timer.
  on_help_contents(self, event)
Event handler triggered by the help menu option.
  on_key_down(self, event)
Event handler for key events.
  on_open(self, event)
Event handler triggered by the "Open File" menu option.
  on_paste(self, event)
Sent when the paste function is selected from the menu.
  on_preferences(self, event)
Event handler triggered by the "Preferences" menu option.
  on_save(self, event)
Event handler triggered by the "Save" menu option.
  on_save_as(self, event)
Event handler triggered by the "Save As" menu option.
  on_select_theme(self, event)
Event handler for theme radio menu items.
  on_toggle_automation(self, event)
handler triggered by the record toolbar button.
  on_toggle_automation_accel(self, event)
Handler triggered by the f7 accellerator.
  on_toggle_cpu_monitor(self, event)
Handler triggered by the "Toggle CPU Monitor" menu option.
  on_toggle_hard_disk_recorder(self, event)
Handler triggered by the "Toggle Hard Disk Recorder" menu option.
  on_toggle_loop(self, event)
Handler triggered by the loop toolbar button.
  on_toggle_mastertoolbar(self, event)
Handler triggered by the "Toggle Master Toolbar" menu option.
  on_toggle_panic(self, event)
Handler triggered by the mute toolbar button.
  on_toggle_panic_accel(self, event)
Handler triggered by the f12 accellerator.
  on_toggle_statusbar(self, event)
Handler triggered by the "Toggle Status Bar" menu option.
  on_toggle_timetoolbar(self, event)
Handler triggered by the "Toggle Time Toolbar" menu option.
  on_toggle_toolbar(self, event)
Handler triggered by the "Toggle Default" menu option.
  open(self)
Shows the open file dialog and if successful, loads the selected song from disk.
  open_file(self, filename)
Loads a song from disk.
  open_recent_file(self, event)
Event handler triggered by recent file menu options.
  play(self, event)
Event handler triggered by the "Play" toolbar button.
  play_from_cursor(self, event)
Event handler triggered by the F6 key.
  player_callback(self, player, plugin, data)
Default callback for ui events sent by zzub.
  save(self)
Shows a save file dialog if filename is unknown and saves the file.
  save_as(self)
Shows a save file dialog and saves the file.
  save_changes(self)
Asks whether to save changes or not.
  save_file(self, filename)
Saves a song to disk.
  save_view(self)
Called to store view settings to config
  select_page(self, index)
Selects a client panel.
  show_info(self, event)
Event handler triggered by the "Info" toolbar button.
  show_machines(self, event)
Event handler triggered by the "Machines" toolbar button.
  show_mastertoolbar(self, enable)
Shows or hides the mastertoolbar.
  show_patterns(self, event)
Event handler triggered by the "Patterns" toolbar button.
  show_sequencer(self, event)
Event handler triggered by the "Sequencer" toolbar button.
  show_statusbar(self, enable)
Shows or hides the status bar.
  show_timetoolbar(self, enable)
Shows or hides the timetoolbar.
  show_toolbar(self, enable)
Shows or hides the toolbar.
  show_wavetable(self, event)
Event handler triggered by the "Wavetable" toolbar button.
  stop(self, event)
Event handler triggered by the "Stop" toolbar button.
  update_filemenu(self, event)
Updates the most recent files in the file menu.
  update_title(self)
Updates the title to display the filename of the currently loaded document.
  update_view(self)
Called to update all viewstates.
  __do_layout(self)
Layouts available controls.
  __set_properties(self)
Assigns properties to dialog controls.
    Inherited from Frame
  __repr__(self)
  Command(*args, **kwargs)
ProcessCommand(self, int winid) -> bool
  Create(*args, **kwargs)
Create(self, Window parent, int id=-1, String title=EmptyString, ...
  CreateStatusBar(*args, **kwargs)
CreateStatusBar(self, int number=1, long style=DEFAULT_STATUSBAR_STYLE, int winid=0, ...
  CreateToolBar(*args, **kwargs)
CreateToolBar(self, long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar
  DoGiveHelp(*args, **kwargs)
DoGiveHelp(self, String text, bool show)
  DoMenuUpdates(*args, **kwargs)
DoMenuUpdates(self, Menu menu=None)
  GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes (Static method)
  GetClientAreaOrigin(*args, **kwargs)
GetClientAreaOrigin(self) -> Point
  GetMenuBar(*args, **kwargs)
GetMenuBar(self) -> MenuBar
  GetStatusBar(*args, **kwargs)
GetStatusBar(self) -> StatusBar
  GetStatusBarPane(*args, **kwargs)
GetStatusBarPane(self) -> int
  GetToolBar(*args, **kwargs)
GetToolBar(self) -> wxToolBar
  PopStatusText(*args, **kwargs)
PopStatusText(self, int number=0)
  ProcessCommand(*args, **kwargs)
ProcessCommand(self, int winid) -> bool
  PushStatusText(*args, **kwargs)
PushStatusText(self, String text, int number=0)
  SendSizeEvent(*args, **kwargs)
SendSizeEvent(self)
  SetMenuBar(*args, **kwargs)
SetMenuBar(self, MenuBar menubar)
  SetStatusBar(*args, **kwargs)
SetStatusBar(self, StatusBar statBar)
  SetStatusBarPane(*args, **kwargs)
SetStatusBarPane(self, int n)
  SetStatusText(*args, **kwargs)
SetStatusText(self, String text, int number=0)
  SetStatusWidths(*args, **kwargs)
SetStatusWidths(self, int widths)
  SetToolBar(*args, **kwargs)
SetToolBar(self, wxToolBar toolbar)
    Inherited from TopLevelWindow
  CenterOnScreen(*args, **kwargs)
CenterOnScreen(self, int dir=BOTH)
  CentreOnScreen(*args, **kwargs)
CenterOnScreen(self, int dir=BOTH)
  GetIcon(*args, **kwargs)
GetIcon(self) -> Icon
  GetTitle(*args, **kwargs)
GetTitle(self) -> String
  Iconize(*args, **kwargs)
Iconize(self, bool iconize=True)
  IsActive(*args, **kwargs)
IsActive(self) -> bool
  IsFullScreen(*args, **kwargs)
IsFullScreen(self) -> bool
  IsIconized(*args, **kwargs)
IsIconized(self) -> bool
  IsMaximized(*args, **kwargs)
IsMaximized(self) -> bool
  MacGetMetalAppearance(*args, **kwargs)
MacGetMetalAppearance(self) -> bool
  MacSetMetalAppearance(*args, **kwargs)
MacSetMetalAppearance(self, bool on)
  Maximize(*args, **kwargs)
Maximize(self, bool maximize=True)
  RequestUserAttention(*args, **kwargs)
RequestUserAttention(self, int flags=USER_ATTENTION_INFO)
  Restore(*args, **kwargs)
Restore(self)
  SetIcon(*args, **kwargs)
SetIcon(self, Icon icon)
  SetIcons(*args, **kwargs)
SetIcons(self, wxIconBundle icons)
  SetShape(*args, **kwargs)
SetShape(self, Region region) -> bool
  SetTitle(*args, **kwargs)
SetTitle(self, String title)
  ShowFullScreen(*args, **kwargs)
ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool
    Inherited from Window
  AcceptsFocus(*args, **kwargs)
AcceptsFocus(self) -> bool
  AcceptsFocusFromKeyboard(*args, **kwargs)
AcceptsFocusFromKeyboard(self) -> bool
  AddChild(*args, **kwargs)
AddChild(self, Window child)
  AssociateHandle(*args, **kwargs)
AssociateHandle(self, long handle)
  CacheBestSize(*args, **kwargs)
CacheBestSize(self, Size size)
  CaptureMouse(*args, **kwargs)
CaptureMouse(self)
  Center(*args, **kwargs)
Center(self, int direction=BOTH)
  CenterOnParent(*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
  Centre(*args, **kwargs)
Center(self, int direction=BOTH)
  CentreOnParent(*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
  ClearBackground(*args, **kwargs)
ClearBackground(self)
  ClientToScreen(*args, **kwargs)
ClientToScreen(self, Point pt) -> Point
  ClientToScreenXY(*args, **kwargs)
ClientToScreenXY(int x, int y) -> (x,y)
  Close(*args, **kwargs)
Close(self, bool force=False) -> bool
  ConvertDialogPointToPixels(*args, **kwargs)
ConvertDialogPointToPixels(self, Point pt) -> Point
  ConvertDialogSizeToPixels(*args, **kwargs)
ConvertDialogSizeToPixels(self, Size sz) -> Size
  ConvertPixelPointToDialog(*args, **kwargs)
ConvertPixelPointToDialog(self, Point pt) -> Point
  ConvertPixelSizeToDialog(*args, **kwargs)
ConvertPixelSizeToDialog(self, Size sz) -> Size
  Destroy(*args, **kwargs)
Destroy(self) -> bool
  DestroyChildren(*args, **kwargs)
DestroyChildren(self) -> bool
  Disable(*args, **kwargs)
Disable(self) -> bool
  DissociateHandle(*args, **kwargs)
DissociateHandle(self)
  DLG_PNT(*args, **kwargs)
DLG_PNT(self, Point pt) -> Point
  DLG_SZE(*args, **kwargs)
DLG_SZE(self, Size sz) -> Size
  DragAcceptFiles(*args, **kwargs)
DragAcceptFiles(self, bool accept)
  Enable(*args, **kwargs)
Enable(self, bool enable=True) -> bool
  FindFocus(*args, **kwargs)
FindFocus() -> Window (Static method)
  FindWindowById(*args, **kwargs)
FindWindowById(self, long winid) -> Window
  FindWindowByName(*args, **kwargs)
FindWindowByName(self, String name) -> Window
  Fit(*args, **kwargs)
Fit(self)
  FitInside(*args, **kwargs)
FitInside(self)
  Freeze(*args, **kwargs)
Freeze(self)
  GetAcceleratorTable(*args, **kwargs)
GetAcceleratorTable(self) -> AcceleratorTable
  GetAdjustedBestSize(*args, **kwargs)
GetAdjustedBestSize(self) -> Size
  GetAutoLayout(*args, **kwargs)
GetAutoLayout(self) -> bool
  GetBackgroundColour(*args, **kwargs)
GetBackgroundColour(self) -> Colour
  GetBackgroundStyle(*args, **kwargs)
GetBackgroundStyle(self) -> int
  GetBestFittingSize(*args, **kwargs)
GetBestFittingSize(self) -> Size
  GetBestSize(*args, **kwargs)
GetBestSize(self) -> Size
  GetBestSizeTuple(*args, **kwargs)
GetBestSizeTuple() -> (width, height)
  GetBestVirtualSize(*args, **kwargs)
GetBestVirtualSize(self) -> Size
  GetBorder(*args)
GetBorder(self, long flags) -> int GetBorder(self) -> int
  GetCapture(*args, **kwargs)
GetCapture() -> Window (Static method)
  GetCaret(*args, **kwargs)
GetCaret(self) -> Caret
  GetCharHeight(*args, **kwargs)
GetCharHeight(self) -> int
  GetCharWidth(*args, **kwargs)
GetCharWidth(self) -> int
  GetChildren(*args, **kwargs)
GetChildren(self) -> PyObject
  GetClientRect(*args, **kwargs)
GetClientRect(self) -> Rect
  GetClientSize(*args, **kwargs)
GetClientSize(self) -> Size
  GetClientSizeTuple(*args, **kwargs)
GetClientSizeTuple() -> (width, height)
  GetConstraints(*args, **kwargs)
GetConstraints(self) -> LayoutConstraints
  GetContainingSizer(*args, **kwargs)
GetContainingSizer(self) -> Sizer
  GetCursor(*args, **kwargs)
GetCursor(self) -> Cursor
  GetDefaultAttributes(*args, **kwargs)
GetDefaultAttributes(self) -> VisualAttributes
  GetDefaultItem(*args, **kwargs)
GetDefaultItem(self) -> Window
  GetDropTarget(*args, **kwargs)
GetDropTarget(self) -> DropTarget
  GetEventHandler(*args, **kwargs)
GetEventHandler(self) -> EvtHandler
  GetExtraStyle(*args, **kwargs)
GetExtraStyle(self) -> long
  GetFont(*args, **kwargs)
GetFont(self) -> Font
  GetForegroundColour(*args, **kwargs)
GetForegroundColour(self) -> Colour
  GetFullTextExtent(*args, **kwargs)
GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font.
  GetGrandParent(*args, **kwargs)
GetGrandParent(self) -> Window
  GetHandle(*args, **kwargs)
GetHandle(self) -> long
  GetHelpText(*args, **kwargs)
GetHelpText(self) -> String
  GetId(*args, **kwargs)
GetId(self) -> int
  GetLabel(*args, **kwargs)
GetLabel(self) -> String
  GetMaxHeight(*args, **kwargs)
GetMaxHeight(self) -> int
  GetMaxSize(*args, **kwargs)
GetMaxSize(self) -> Size
  GetMaxWidth(*args, **kwargs)
GetMaxWidth(self) -> int
  GetMinHeight(*args, **kwargs)
GetMinHeight(self) -> int
  GetMinSize(*args, **kwargs)
GetMinSize(self) -> Size
  GetMinWidth(*args, **kwargs)
GetMinWidth(self) -> int
  GetName(*args, **kwargs)
GetName(self) -> String
  GetParent(*args, **kwargs)
GetParent(self) -> Window
  GetPosition(*args, **kwargs)
GetPosition(self) -> Point
  GetPositionTuple(*args, **kwargs)
GetPositionTuple() -> (x,y)
  GetRect(*args, **kwargs)
GetRect(self) -> Rect
  GetScrollPos(*args, **kwargs)
GetScrollPos(self, int orientation) -> int
  GetScrollRange(*args, **kwargs)
GetScrollRange(self, int orientation) -> int
  GetScrollThumb(*args, **kwargs)
GetScrollThumb(self, int orientation) -> int
  GetSize(*args, **kwargs)
GetSize(self) -> Size
  GetSizer(*args, **kwargs)
GetSizer(self) -> Sizer
  GetSizeTuple(*args, **kwargs)
GetSizeTuple() -> (width, height)
  GetTextExtent(*args, **kwargs)
GetTextExtent(String string) -> (width, height)
  GetThemeEnabled(*args, **kwargs)
GetThemeEnabled(self) -> bool
  GetToolTip(*args, **kwargs)
GetToolTip(self) -> ToolTip
  GetUpdateClientRect(*args, **kwargs)
GetUpdateClientRect(self) -> Rect
  GetUpdateRegion(*args, **kwargs)
GetUpdateRegion(self) -> Region
  GetValidator(*args, **kwargs)
GetValidator(self) -> Validator
  GetVirtualSize(*args, **kwargs)
GetVirtualSize(self) -> Size
  GetVirtualSizeTuple(*args, **kwargs)
GetVirtualSizeTuple() -> (width, height)
  GetWindowStyle(*args, **kwargs)
GetWindowStyleFlag(self) -> long
  GetWindowStyleFlag(*args, **kwargs)
GetWindowStyleFlag(self) -> long
  GetWindowVariant(*args, **kwargs)
GetWindowVariant(self) -> int
  HasCapture(*args, **kwargs)
HasCapture(self) -> bool
  HasFlag(*args, **kwargs)
HasFlag(self, int flag) -> bool
  HasScrollbar(*args, **kwargs)
HasScrollbar(self, int orient) -> bool
  HasTransparentBackground(*args, **kwargs)
HasTransparentBackground(self) -> bool
  Hide(*args, **kwargs)
Hide(self) -> bool
  HitTest(*args, **kwargs)
HitTest(self, Point pt) -> int
  HitTestXY(*args, **kwargs)
HitTestXY(self, int x, int y) -> int
  InheritAttributes(*args, **kwargs)
InheritAttributes(self)
  InheritsBackgroundColour(*args, **kwargs)
InheritsBackgroundColour(self) -> bool
  InitDialog(*args, **kwargs)
InitDialog(self)
  InvalidateBestSize(*args, **kwargs)
InvalidateBestSize(self)
  IsBeingDeleted(*args, **kwargs)
IsBeingDeleted(self) -> bool
  IsEnabled(*args, **kwargs)
IsEnabled(self) -> bool
  IsExposed(*args, **kwargs)
IsExposed(self, int x, int y, int w=1, int h=1) -> bool
  IsExposedPoint(*args, **kwargs)
IsExposedPoint(self, Point pt) -> bool
  IsExposedRect(*args, **kwargs)
IsExposedRect(self, Rect rect) -> bool
  IsRetained(*args, **kwargs)
IsRetained(self) -> bool
  IsShown(*args, **kwargs)
IsShown(self) -> bool
  IsTopLevel(*args, **kwargs)
IsTopLevel(self) -> bool
  Layout(*args, **kwargs)
Layout(self) -> bool
  LineDown(*args, **kwargs)
LineDown(self) -> bool
  LineUp(*args, **kwargs)
LineUp(self) -> bool
  Lower(*args, **kwargs)
Lower(self)
  MakeModal(*args, **kwargs)
MakeModal(self, bool modal=True)
  Move(*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
  MoveAfterInTabOrder(*args, **kwargs)
MoveAfterInTabOrder(self, Window win)
  MoveBeforeInTabOrder(*args, **kwargs)
MoveBeforeInTabOrder(self, Window win)
  MoveXY(*args, **kwargs)
MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
  Navigate(*args, **kwargs)
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
  NewControlId(*args, **kwargs)
NewControlId() -> int (Static method)
  NextControlId(*args, **kwargs)
NextControlId(int winid) -> int (Static method)
  PageDown(*args, **kwargs)
PageDown(self) -> bool
  PageUp(*args, **kwargs)
PageUp(self) -> bool
  PopEventHandler(*args, **kwargs)
PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
  PopupMenu(*args, **kwargs)
PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
  PopupMenuXY(*args, **kwargs)
PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
  PostCreate(self, pre)
Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.
  PrepareDC(*args, **kwargs)
PrepareDC(self, DC dc)
  PrevControlId(*args, **kwargs)
PrevControlId(int winid) -> int (Static method)
  PushEventHandler(*args, **kwargs)
PushEventHandler(self, EvtHandler handler)
  Raise(*args, **kwargs)
Raise(self)
  Refresh(*args, **kwargs)
Refresh(self, bool eraseBackground=True, Rect rect=None)
  RefreshRect(*args, **kwargs)
RefreshRect(self, Rect rect, bool eraseBackground=True)
  RegisterHotKey(*args, **kwargs)
RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
  ReleaseMouse(*args, **kwargs)
ReleaseMouse(self)
  RemoveChild(*args, **kwargs)
RemoveChild(self, Window child)
  RemoveEventHandler(*args, **kwargs)
RemoveEventHandler(self, EvtHandler handler) -> bool
  Reparent(*args, **kwargs)
Reparent(self, Window newParent) -> bool
  ScreenToClient(*args, **kwargs)
ScreenToClient(self, Point pt) -> Point
  ScreenToClientXY(*args, **kwargs)
ScreenToClientXY(int x, int y) -> (x,y)
  ScrollLines(*args, **kwargs)
ScrollLines(self, int lines) -> bool
  ScrollPages(*args, **kwargs)
ScrollPages(self, int pages) -> bool
  ScrollWindow(*args, **kwargs)
ScrollWindow(self, int dx, int dy, Rect rect=None)
  SetAcceleratorTable(*args, **kwargs)
SetAcceleratorTable(self, AcceleratorTable accel)
  SetAutoLayout(*args, **kwargs)
SetAutoLayout(self, bool autoLayout)
  SetBackgroundColour(*args, **kwargs)
SetBackgroundColour(self, Colour colour) -> bool
  SetBackgroundStyle(*args, **kwargs)
SetBackgroundStyle(self, int style) -> bool Returns the background style of the window.
  SetBestFittingSize(*args, **kwargs)
SetBestFittingSize(self, Size size=DefaultSize)
  SetCaret(*args, **kwargs)
SetCaret(self, Caret caret)
  SetClientRect(*args, **kwargs)
SetClientRect(self, Rect rect)
  SetClientSize(*args, **kwargs)
SetClientSize(self, Size size)
  SetClientSizeWH(*args, **kwargs)
SetClientSizeWH(self, int width, int height)
  SetConstraints(*args, **kwargs)
SetConstraints(self, LayoutConstraints constraints)
  SetContainingSizer(*args, **kwargs)
SetContainingSizer(self, Sizer sizer)
  SetCursor(*args, **kwargs)
SetCursor(self, Cursor cursor) -> bool
  SetDefaultItem(*args, **kwargs)
SetDefaultItem(self, Window child) -> Window
  SetDimensions(*args, **kwargs)
SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels.
  SetDropTarget(*args, **kwargs)
SetDropTarget(self, DropTarget dropTarget)
  SetEventHandler(*args, **kwargs)
SetEventHandler(self, EvtHandler handler)
  SetExtraStyle(*args, **kwargs)
SetExtraStyle(self, long exStyle)
  SetFocus(*args, **kwargs)
SetFocus(self)
  SetFocusFromKbd(*args, **kwargs)
SetFocusFromKbd(self)
  SetFont(*args, **kwargs)
SetFont(self, Font font) -> bool
  SetForegroundColour(*args, **kwargs)
SetForegroundColour(self, Colour colour) -> bool
  SetHelpText(*args, **kwargs)
SetHelpText(self, String text)
  SetHelpTextForId(*args, **kwargs)
SetHelpTextForId(self, String text)
  SetId(*args, **kwargs)
SetId(self, int winid)
  SetLabel(*args, **kwargs)
SetLabel(self, String label)
  SetMaxSize(*args, **kwargs)
SetMaxSize(self, Size maxSize)
  SetMinSize(*args, **kwargs)
SetMinSize(self, Size minSize)
  SetName(*args, **kwargs)
SetName(self, String name)
  SetOwnBackgroundColour(*args, **kwargs)
SetOwnBackgroundColour(self, Colour colour)
  SetOwnFont(*args, **kwargs)
SetOwnFont(self, Font font)
  SetOwnForegroundColour(*args, **kwargs)
SetOwnForegroundColour(self, Colour colour)
  SetPosition(*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
  SetRect(*args, **kwargs)
SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
  SetScrollbar(*args, **kwargs)
SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar.
  SetScrollPos(*args, **kwargs)
SetScrollPos(self, int orientation, int pos, bool refresh=True)
  SetSize(*args, **kwargs)
SetSize(self, Size size)
  SetSizeHints(*args, **kwargs)
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments.
  SetSizeHintsSz(*args, **kwargs)
SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
  SetSizer(*args, **kwargs)
SetSizer(self, Sizer sizer, bool deleteOld=True)
  SetSizerAndFit(*args, **kwargs)
SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
  SetSizeWH(*args, **kwargs)
SetSizeWH(self, int width, int height)
  SetThemeEnabled(*args, **kwargs)
SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code.
  SetTmpDefaultItem(*args, **kwargs)
SetTmpDefaultItem(self, Window win)
  SetToolTip(*args, **kwargs)
SetToolTip(self, ToolTip tip)
  SetToolTipString(*args, **kwargs)
SetToolTipString(self, String tip)
  SetValidator(*args, **kwargs)
SetValidator(self, Validator validator)
  SetVirtualSize(*args, **kwargs)
SetVirtualSize(self, Size size)
  SetVirtualSizeHints(*args, **kwargs)
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
  SetVirtualSizeHintsSz(*args, **kwargs)
SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
  SetVirtualSizeWH(*args, **kwargs)
SetVirtualSizeWH(self, int w, int h)
  SetWindowStyle(*args, **kwargs)
SetWindowStyleFlag(self, long style)
  SetWindowStyleFlag(*args, **kwargs)
SetWindowStyleFlag(self, long style)
  SetWindowVariant(*args, **kwargs)
SetWindowVariant(self, int variant)
  ShouldInheritColours(*args, **kwargs)
ShouldInheritColours(self) -> bool
  Show(*args, **kwargs)
Show(self, bool show=True) -> bool
  Thaw(*args, **kwargs)
Thaw(self)
  TransferDataFromWindow(*args, **kwargs)
TransferDataFromWindow(self) -> bool
  TransferDataToWindow(*args, **kwargs)
TransferDataToWindow(self) -> bool
  UnregisterHotKey(*args, **kwargs)
UnregisterHotKey(self, int hotkeyId) -> bool
  Update(*args, **kwargs)
Update(self)
  UpdateWindowUI(*args, **kwargs)
UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
  UseBgCol(*args, **kwargs)
UseBgCol(self) -> bool
  Validate(*args, **kwargs)
Validate(self) -> bool
  WarpPointer(*args, **kwargs)
WarpPointer(self, int x, int y)
    Inherited from EvtHandler
  _setOORInfo(*args, **kwargs)
_setOORInfo(self, PyObject _self, bool incref=True)
  AddPendingEvent(*args, **kwargs)
AddPendingEvent(self, Event event)
  Bind(self, event, handler, source, id, id2)
Bind an event to an event handler.
  Connect(*args, **kwargs)
Connect(self, int id, int lastId, int eventType, PyObject func)
  Disconnect(*args, **kwargs)
Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool
  GetEvtHandlerEnabled(*args, **kwargs)
GetEvtHandlerEnabled(self) -> bool
  GetNextHandler(*args, **kwargs)
GetNextHandler(self) -> EvtHandler
  GetPreviousHandler(*args, **kwargs)
GetPreviousHandler(self) -> EvtHandler
  ProcessEvent(*args, **kwargs)
ProcessEvent(self, Event event) -> bool
  ProcessPendingEvents(*args, **kwargs)
ProcessPendingEvents(self)
  SetEvtHandlerEnabled(*args, **kwargs)
SetEvtHandlerEnabled(self, bool enabled)
  SetNextHandler(*args, **kwargs)
SetNextHandler(self, EvtHandler handler)
  SetPreviousHandler(*args, **kwargs)
SetPreviousHandler(self, EvtHandler handler)
  Unbind(self, event, source, id, id2)
Disconencts the event handler binding for event from self.
    Inherited from Object
  GetClassName(*args, **kwargs)
GetClassName(self) -> String
    Inherited from Interface
  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
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
int ABOUT = 8838                                                                  
int CONTENTS = 5009                                                                  
int COPY = 5031                                                                  
int CUT = 5030                                                                  
str DEFAULT_EXTENSION = '.ccm'
dict event_to_name = {0: 'zzub_event_type_double_click', 1: '...
int EXIT = 5006                                                                  
str filename = ''
int i = 31                                                                    
int INFO = 8849                                                                  
int LOOP = 8847                                                                  
int MACHINES = 8840                                                                  
int MENUITEMBASE = 8980                                                                  
int NEW = 5002                                                                  
int nextmenuitemid = 8980                                                                  
int nexttoolid = 9012                                                                  
int OPEN = 5000                                                                  
int PAGE_INFO = 4                                                                     
int PAGE_PATTERN = 0                                                                     
int PAGE_ROUTE = 1                                                                     
int PAGE_SEQUENCER = 2                                                                     
int PAGE_WAVETABLE = 3                                                                     
int PANIC = 8850                                                                  
int PANIC_ACCEL = 8851                                                                  
int PASTE = 5032                                                                  
int PATTERNS = 8839                                                                  
int PLAY = 8842                                                                  
int PLAY_FROM_CURSOR = 8843                                                                  
int PREFERENCES = 8836                                                                  
int RECENTFILE = 5050                                                                  
int RECORD = 8844                                                                  
int RECORD_ACCEL = 8845                                                                  
int SAVE = 5003                                                                  
int SAVE_AS = 5004                                                                  
str SAVE_SONG_WILDCARD = 'CCM Songs (*.ccm)|*.ccm'
int SEQUENCER = 8841                                                                  
str SONG_WILDCARD = 'All songs (*.ccm,*.bmw,*.bmx)|*.ccm;*.b...
int STOP = 8846                                                                  
int THEMEBASE = 8852                                                                  
int THEMES = 8835                                                                  
str title = 'Aldrin'
int TOGGLE_CPU_MONITOR = 8828                                                                  
int TOGGLE_HARD_DISK_RECORDER = 8829                                                                  
int TOGGLE_MASTER = 8830                                                                  
int TOGGLE_SKINS = 8833                                                                  
int TOGGLE_STANDARD = 8834                                                                  
int TOGGLE_STATUS_BAR = 8831                                                                  
int TOGGLE_TIME = 8832                                                                  
int TOOLBASE = 9012                                                                  
int TOTD = 8837                                                                  
int WAVETABLE = 8848                                                                  
str x = 'zzub_wavetable_index_value_none'

Instance Method Details

__init__(self, *args, **kwds)
(Constructor)

Initializer.
Overrides:
wx._windows.Frame.__init__

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)
Overrides:
aldrin.interface.IMainFrame.add_click_handler

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)
Overrides:
aldrin.interface.IMainFrame.add_menuitem

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)
Overrides:
aldrin.interface.IMainFrame.add_submenu

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.
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)
Overrides:
aldrin.interface.IMainFrame.add_tool_button

clear(self)

Clears the current document.

document_changed(self)

Event handler triggered when the document has changed. You should call this on occasions where the entire document has changed, else there are specialized handlers in the panel classes.

get_active_view(self)

Returns the active panel view.

get_window(self)

Returns the window object associated with the mainframe.
Returns:
Window object.
           (type=wx.Window)
Overrides:
aldrin.interface.IMainFrame.get_window

init_lunar(self)

Initializes the lunar dsp scripting system

load_view(self)

Called to load view settings from config

new(self, event)

Event handler triggered by the "New" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_about(self, event)

Event handler triggered by the "About" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_close(self, event)

Event handler triggered when the window is being closed.
Parameters:
event - event.
           (type=wx.Event)

on_close_cpumonitor(self, event)

Called when the cpu monitor is closed manually.
Parameters:
event - event.
           (type=wx.Event)

on_close_hdrecorder(self, event)

Called when the hd recorder is closed manually.
Parameters:
event - event.
           (type=wx.Event)

on_copy(self, event)

Sent when the copy function is selected from the menu.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_cut(self, event)

Sent when the cut function is selected from the menu.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_destroy(self, event)

Event handler triggered when the window is being destroyed.
Parameters:
event - event.
           (type=wx.Event)

on_exit(self, event)

Event handler triggered by the "Exit" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_framepanel_size(self, event)

Event handler that resizes the client panels, when the main window is being resized.
Parameters:
event - size event.
           (type=wx.SizeEvent)

on_handle_events(self, event)

Handler triggered by the default timer. Calls player.handle_events() to work off the players message queue.
Parameters:
event - timer event
           (type=wx.TimerEvent)

on_help_contents(self, event)

Event handler triggered by the help menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_key_down(self, event)

Event handler for key events.
Parameters:
event - key event.
           (type=wx.KeyEvent)

on_open(self, event)

Event handler triggered by the "Open File" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_paste(self, event)

Sent when the paste function is selected from the menu.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_preferences(self, event)

Event handler triggered by the "Preferences" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_save(self, event)

Event handler triggered by the "Save" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_save_as(self, event)

Event handler triggered by the "Save As" menu option.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_select_theme(self, event)

Event handler for theme radio menu items.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

on_toggle_automation(self, event)

handler triggered by the record toolbar button. Decides whether changes to parameters are recorded or not.
Parameters:
event - Command event.
           (type=wx.CommandEvent)

on_toggle_automation_accel(self, event)

Handler triggered by the f7 accellerator. Enables/disables automation.

@param event command event.
Parameters:
event
           (type=wx.CommandEvent)

on_toggle_cpu_monitor(self, event)

Handler triggered by the "Toggle CPU Monitor" menu option. Shows and hides the CPU Monitor panel.
Parameters:
event - Command event.
           (type=wx.CommandEvent)

on_toggle_hard_disk_recorder(self, event)

Handler triggered by the "Toggle Hard Disk Recorder" menu option. Shows and hides the Hard Disk Recorder panel.
Parameters:
event - command event.
           (type=wx.CommandEvent)

on_toggle_loop(self, event)

Handler triggered by the loop toolbar button. Decides whether the song loops or not.

@param event command event.
Parameters:
event
           (type=wx.CommandEvent)

on_toggle_mastertoolbar(self, event)

Handler triggered by the "Toggle Master Toolbar" menu option. Shows and hides the master toolbar.
Parameters:
event - command event.
           (type=wx.CommandEvent)

on_toggle_panic(self, event)

Handler triggered by the mute toolbar button. Deinits/reinits sound device.

@param event command event.
Parameters:
event
           (type=wx.CommandEvent)

on_toggle_panic_accel(self, event)

Handler triggered by the f12 accellerator. Deinits/reinits sound device.

@param event command event.
Parameters:
event
           (type=wx.CommandEvent)

on_toggle_statusbar(self, event)

Handler triggered by the "Toggle Status Bar" menu option. Shows and hides the status bar.
Parameters:
event - command event.
           (type=wx.CommandEvent)

on_toggle_timetoolbar(self, event)

Handler triggered by the "Toggle Time Toolbar" menu option. Shows and hides the time toolbar.
Parameters:
event - command event.
           (type=wx.CommandEvent)

on_toggle_toolbar(self, event)

Handler triggered by the "Toggle Default" menu option. Shows and hides the toolbar.
Parameters:
event - command event.
           (type=wx.CommandEvent)

open(self)

Shows the open file dialog and if successful, loads the selected song from disk.

open_file(self, filename)

Loads a song from disk. The old document will be wiped, and the song will be added to the recent file list.
Parameters:
filename - Path to song.
           (type=str)

open_recent_file(self, event)

Event handler triggered by recent file menu options.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

play(self, event)

Event handler triggered by the "Play" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

play_from_cursor(self, event)

Event handler triggered by the F6 key.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

player_callback(self, player, plugin, data)

Default callback for ui events sent by zzub.
Parameters:
player - player instance.
           (type=zzub.Player)
plugin - plugin instance
           (type=zzub.Plugin)
data - event data.
           (type=zzub_event_data_t)

save(self)

Shows a save file dialog if filename is unknown and saves the file.

save_as(self)

Shows a save file dialog and saves the file.

save_changes(self)

Asks whether to save changes or not. Throws a {CancelException} if cancelled.

save_file(self, filename)

Saves a song to disk. The document will also be added to the recent file list.
Parameters:
filename - Path to song.
           (type=str)

save_view(self)

Called to store view settings to config

select_page(self, index)

Selects a client panel. If the client panel has a view attribute, that view attribute is being interpreted as a window and will be focused, else the panel itself will be focused.
Parameters:
index - Index of the panel (use one of the self.PAGE_* constants)
           (type=int)

show_info(self, event)

Event handler triggered by the "Info" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

show_machines(self, event)

Event handler triggered by the "Machines" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

show_mastertoolbar(self, enable)

Shows or hides the mastertoolbar.
Parameters:
enable - If True, toolbar will be shown.
           (type=bool)

show_patterns(self, event)

Event handler triggered by the "Patterns" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

show_sequencer(self, event)

Event handler triggered by the "Sequencer" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

show_statusbar(self, enable)

Shows or hides the status bar.
Parameters:
enable - If True, status bar will be shown.
           (type=bool)

show_timetoolbar(self, enable)

Shows or hides the timetoolbar.
Parameters:
enable - If True, toolbar will be shown.
           (type=bool)

show_toolbar(self, enable)

Shows or hides the toolbar.
Parameters:
enable - If True, toolbar will be shown.
           (type=bool)

show_wavetable(self, event)

Event handler triggered by the "Wavetable" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

stop(self, event)

Event handler triggered by the "Stop" toolbar button.
Parameters:
event - menu event.
           (type=wx.MenuEvent)

update_filemenu(self, event=None)

Updates the most recent files in the file menu.
Parameters:
event - Event.
           (type=wx.Event)

update_title(self)

Updates the title to display the filename of the currently loaded document.

update_view(self)

Called to update all viewstates.

__do_layout(self)

Layouts available controls.

__set_properties(self)

Assigns properties to dialog controls.

Class Variable Details

ABOUT

Type:
int
Value:
8838                                                                  

CONTENTS

Type:
int
Value:
5009                                                                  

COPY

Type:
int
Value:
5031                                                                  

CUT

Type:
int
Value:
5030                                                                  

DEFAULT_EXTENSION

Type:
str
Value:
'.ccm'                                                                 

event_to_name

Type:
dict
Value:
{0: 'zzub_event_type_double_click',
 1: 'zzub_event_type_new_plugin',
 2: 'zzub_event_type_delete_plugin',
 3: 'zzub_event_type_disconnect',
 4: 'zzub_event_type_connect',
 7: 'zzub_event_type_parameter_changed',
 8: 'zzub_event_type_load_progress',
 11: 'zzub_event_type_midi_control',
...                                                                    

EXIT

Type:
int
Value:
5006                                                                  

filename

Type:
str
Value:
''                                                                     

i

Type:
int
Value:
31                                                                    

INFO

Type:
int
Value:
8849                                                                  

LOOP

Type:
int
Value:
8847                                                                  

MACHINES

Type:
int
Value:
8840                                                                  

MENUITEMBASE

Type:
int
Value:
8980                                                                  

NEW

Type:
int
Value:
5002                                                                  

nextmenuitemid

Type:
int
Value:
8980                                                                  

nexttoolid

Type:
int
Value:
9012                                                                  

OPEN

Type:
int
Value:
5000                                                                  

PAGE_INFO

Type:
int
Value:
4                                                                     

PAGE_PATTERN

Type:
int
Value:
0                                                                     

PAGE_ROUTE

Type:
int
Value:
1                                                                     

PAGE_SEQUENCER

Type:
int
Value:
2                                                                     

PAGE_WAVETABLE

Type:
int
Value:
3                                                                     

PANIC

Type:
int
Value:
8850                                                                  

PANIC_ACCEL

Type:
int
Value:
8851                                                                  

PASTE

Type:
int
Value:
5032                                                                  

PATTERNS

Type:
int
Value:
8839                                                                  

PLAY

Type:
int
Value:
8842                                                                  

PLAY_FROM_CURSOR

Type:
int
Value:
8843                                                                  

PREFERENCES

Type:
int
Value:
8836                                                                  

RECENTFILE

Type:
int
Value:
5050                                                                  

RECORD

Type:
int
Value:
8844                                                                  

RECORD_ACCEL

Type:
int
Value:
8845                                                                  

SAVE

Type:
int
Value:
5003                                                                  

SAVE_AS

Type:
int
Value:
5004                                                                  

SAVE_SONG_WILDCARD

Type:
str
Value:
'CCM Songs (*.ccm)|*.ccm'                                              

SEQUENCER

Type:
int
Value:
8841                                                                  

SONG_WILDCARD

Type:
str
Value:
'All songs (*.ccm,*.bmw,*.bmx)|*.ccm;*.bmw;*.bmx|CCM Songs (*.ccm)|*.c\
cm|BMX Songs with waves (*.bmx)|*.bmx|BMX Songs without waves (*.bmw)|\
*.bmw'                                                                 

STOP

Type:
int
Value:
8846                                                                  

THEMEBASE

Type:
int
Value:
8852                                                                  

THEMES

Type:
int
Value:
8835                                                                  

title

Type:
str
Value:
'Aldrin'                                                               

TOGGLE_CPU_MONITOR

Type:
int
Value:
8828                                                                  

TOGGLE_HARD_DISK_RECORDER

Type:
int
Value:
8829                                                                  

TOGGLE_MASTER

Type:
int
Value:
8830                                                                  

TOGGLE_SKINS

Type:
int
Value:
8833                                                                  

TOGGLE_STANDARD

Type:
int
Value:
8834                                                                  

TOGGLE_STATUS_BAR

Type:
int
Value:
8831                                                                  

TOGGLE_TIME

Type:
int
Value:
8832                                                                  

TOOLBASE

Type:
int
Value:
9012                                                                  

TOTD

Type:
int
Value:
8837                                                                  

WAVETABLE

Type:
int
Value:
8848                                                                  

x

Type:
str
Value:
'zzub_wavetable_index_value_none'                                      

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