Package aldrin :: Module router :: Class ParameterDialog
[show private | hide private]
[frames | no frames]

Type ParameterDialog

object --+                    
         |                    
    Object --+                
             |                
    EvtHandler --+            
                 |            
            Window --+        
                     |        
        TopLevelWindow --+    
                         |    
                     Frame --+
                             |
                            ParameterDialog


Displays parameter sliders for a plugin in a new Dialog.
Method Summary
  __init__(self, rootwindow, plugin, *args, **kwds)
Initializer.
  apply_preset(self, preset)
  Destroy(self)
  on_bind_controller(self, event)
Handles clicks on controller names in the context menu.
  on_button_copy(self, event)
Handler for clicks on the 'Copy' button.
  on_button_edit(self, event)
Handler for clicks on the 'Edit' button.
  on_button_help(self, event)
Handler for clicks on the 'Help' button.
  on_button_random(self, event)
Handler for clicks on the 'Random' button.
  on_callback(self, player, plugin, data)
parameter window callback for ui events sent by zzub.
  on_close(self, event)
Handles close events.
  on_context_menu(self, event)
Event handler for requests to show the context menu.
  on_destroy(self, event)
Handles destroy events.
  on_key_down(self, event)
Callback that responds to key stroke.
  on_mousewheel(self, event)
Sent when the mousewheel is used on a slider.
  on_scroll_changed(self, event)
Event handler for changes in slider movements.
  on_select_preset(self, event)
Handler for changes of the choice box.
  on_unbind_all(self, event)
Unbinds all controllers from the selected parameter.
  update_all_sliders(self)
Updates all sliders.
  update_presets(self)
Updates the preset box.
  update_valuelabel(self, g, t, i)
Updates the right label for a parameter slider.
    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 CONTROLLER = 112                                                                   
int i = 255                                                                   
int UNBIND_ALL = 111                                                                   

Instance Method Details

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

Initializer.
Parameters:
plugin - The plugin object for which to display parameters.
           (type=zzub.Plugin)
Overrides:
wx._windows.Frame.__init__

on_bind_controller(self, event)

Handles clicks on controller names in the context menu. Associates a controller with a plugin parameter.
Parameters:
event - Event.
           (type=wx.Event)

on_button_copy(self, event)

Handler for clicks on the 'Copy' button. Constructs a paste buffer which can be used for pasting in the pattern editor.
Parameters:
event - Command event.
           (type=wx.CommandEvent)

on_button_edit(self, event)

Handler for clicks on the 'Edit' button. Opens the preset dialog.

on_button_help(self, event)

Handler for clicks on the 'Help' button.
Parameters:
event - Command event.
           (type=wx.CommandEvent)

on_button_random(self, event)

Handler for clicks on the 'Random' button.
Parameters:
event - Command event.
           (type=wx.CommandEvent)

on_callback(self, player, plugin, data)

parameter window 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)

on_close(self, event)

Handles close events.

on_context_menu(self, event)

Event handler for requests to show the context menu.
Parameters:
event - event.
           (type=wx.Event)

on_destroy(self, event)

Handles destroy events.

on_key_down(self, event)

Callback that responds to key stroke.
Parameters:
event - Key event
           (type=wx.KeyEvent)

on_mousewheel(self, event)

Sent when the mousewheel is used on a slider.
Parameters:
event - A mouse event.
           (type=wx.MouseEvent)

on_scroll_changed(self, event)

Event handler for changes in slider movements.
Parameters:
event - A scroll event.
           (type=wx.ScrollEvent)

on_select_preset(self, event)

Handler for changes of the choice box. Changes the current parameters according to preset.
Parameters:
event - Command event.
           (type=wx.CommandEvent)

on_unbind_all(self, event)

Unbinds all controllers from the selected parameter.
Parameters:
event - Event.
           (type=wx.Event)

update_all_sliders(self)

Updates all sliders. Should only be called when most sliders have been changed at once, e.g. after a preset change.

update_presets(self)

Updates the preset box.

update_valuelabel(self, g, t, i)

Updates the right label for a parameter slider.
Parameters:
g - The group this parameter belongs to.
           (type=int)
t - The track of the group this parameter belongs to.
           (type=int)
i - The parameter index within the track.
           (type=int)

Class Variable Details

CONTROLLER

Type:
int
Value:
112                                                                   

i

Type:
int
Value:
255                                                                   

UNBIND_ALL

Type:
int
Value:
111                                                                   

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