Package aldrin :: Module patterns
[show private | hide private]
[frames | no frames]

Module aldrin.patterns

Contains all classes and functions needed to render the pattern editor and its associated dialogs.
Classes
PatternDialog Pattern Dialog Box.
PatternPanel Panel containing the pattern toolbar and pattern view.
PatternToolBar Pattern Toolbar
PatternView Pattern viewer class.

Function Summary
  get_length_from_param(p)
Gets length of a parameter.
  get_str_from_param(p, v)
Extracts a string representation from value in context of a parameter.
  get_subindexcount_from_param(p)
Gets subindex count of a parameter.
  get_subindexoffsets_from_param(p)
(string, int) show_pattern_dialog(parent, name, length, dlgmode)
Shows the pattern creation/modification dialog.
(int,int) key_to_note(k)
uses the active keymap to determine note and octave from a pressed key.

Function Details

get_length_from_param(p)

Gets length of a parameter.
Parameters:
p - Parameter.
           (type=zzub.Parameter)

get_str_from_param(p, v)

Extracts a string representation from value in context of a parameter.
Parameters:
p - Parameter.
           (type=zzub.Parameter)
v - Value.
           (type=int)

get_subindexcount_from_param(p)

Gets subindex count of a parameter.
Parameters:
p - Parameter.
           (type=zzub.Parameter)

show_pattern_dialog(parent, name, length, dlgmode)

Shows the pattern creation/modification dialog.
Parameters:
parent - Parent container
           (type=wx.Window)
name - Pattern name
           (type=string)
length - Pattern name
           (type=int)
dlgmode - Dialog mode (DLGMODE_NEW: create new pattern, DLGMODE_COPY: create copy of pattern, DLGMODE_CHANGE: modify pattern)
           (type=int)
Returns:
Tuple containing pattern name and length
           (type=(string, int))

key_to_note(k)

uses the active keymap to determine note and octave from a pressed key.
Parameters:
k - Pressed key.
           (type=int)
Returns:
a tuple consisting of octave and note or None.
           (type=(int,int))

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