Package jazzparser :: Package harmonical :: Module tsgui :: Class TonalSpaceWindow
[hide private]
[frames] | no frames]

Class TonalSpaceWindow

source code

        object --+                        
                 |                        
        ??.GObject --+                    
                     |                    
            gtk.Object --+                
                         |                
        object --+       |                
                 |       |                
gobject.GInterface --+   |                
                     |   |                
  atk.ImplementorIface --+                
                         |                
        object --+       |                
                 |       |                
gobject.GInterface --+   |                
                     |   |                
         gtk.Buildable --+                
                         |                
                gtk.Widget --+            
                             |            
                 gtk.Container --+        
                                 |        
                           gtk.Bin --+    
                                     |    
                            gtk.Window --+
                                         |
                                        TonalSpaceWindow
Known Subclasses:

A window that displays an interactive tonal space.

Instance Methods [hide private]
 
__init__(self, left, bottom, right, top, sequencer, *args, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
get_cell_label(self, col, row) source code
 
toggle_fullscreen(self) source code
 
get_cell(self, x, y)
Returns the cell for the given 2D tonal space coordinate.
source code
 
get_point(self, x, y)
Returns the cell corresponding to the 2D TS coordinate, whether or not it's in the visible region, creating it if necessary.
source code
 
center_grid(self, x, y)
Put the coordinate (x,y) in the centre of the visible grid by shifting the portion visible.
source code
 
shift_grid(self, x, y)
Shift the visible portion of the tonal space covered by the grid.
source code
 
remove_all_cells(self) source code
 
add_all_cells(self) source code
 
create_cell(self, col, row) source code
 
create_buffer_cells(self)
Create some extra cells around the edge while we're not doing anything else, so it doesn't take time when we need them.
source code
 
on_key_press(self, widget, event) source code
 
destroy(self, widget, data=None)
Handler for window destruction.
source code
 
all_notes_off(self) source code
 
clear_selection(self) source code
 
select_et_equivs(self, coord)
Select all equal-temperament equivalents of the given coord (not including the coord itself).
source code
 
add_et_equivs(self)
Add to the current selection all equal-temperament equivalents of the notes currently selected.
source code
 
show_chord_menu(self, event) source code
 
cell_clicked(self, cell, event)
Called by each cell when it gets clicked.
source code
 
point_selected(self, cell, octave, item)
Works like cell_clicked, but called when a 3D position (i.e., cell plus octave) is selected.
source code
 
play_chord(self, chord_name)
Set the notes of a particular chord going.
source code
 
play_note(self, coord)
Set the note playing corresponding to a 3D coordinate, if that note is in the current portion of the tonal space.
source code
 
set_cursor(self, coord, absolute=False)
Set the 2D coord to be under the current cursor.
source code

Inherited from gtk.Window: __iter__, activate_default, activate_focus, activate_key, add_accel_group, add_mnemonic, begin_move_drag, begin_resize_drag, deiconify, do_activate_default, do_activate_focus, do_frame_event, do_keys_changed, do_move_focus, do_set_focus, fullscreen, get_accept_focus, get_decorated, get_default_size, get_default_widget, get_deletable, get_destroy_with_parent, get_focus, get_focus_on_map, get_frame_dimensions, get_gravity, get_group, get_has_frame, get_icon, get_icon_list, get_icon_name, get_mnemonic_modifier, get_mnemonics_visible, get_modal, get_opacity, get_position, get_resizable, get_role, get_screen, get_size, get_skip_pager_hint, get_skip_taskbar_hint, get_title, get_transient_for, get_type_hint, get_urgency_hint, get_window_type, has_group, has_toplevel_focus, iconify, is_active, maximize, mnemonic_activate, move, parse_geometry, present, present_with_time, propagate_key_event, remove_accel_group, remove_mnemonic, reshow_with_initial_size, resize, set_accept_focus, set_decorated, set_default, set_default_size, set_deletable, set_destroy_with_parent, set_focus, set_focus_on_map, set_frame_dimensions, set_geometry_hints, set_gravity, set_has_frame, set_icon, set_icon_from_file, set_icon_list, set_icon_name, set_keep_above, set_keep_below, set_mnemonic_modifier, set_mnemonics_visible, set_modal, set_opacity, set_policy, set_position, set_resizable, set_role, set_screen, set_skip_pager_hint, set_skip_taskbar_hint, set_startup_id, set_title, set_transient_for, set_type_hint, set_urgency_hint, set_wmclass, stick, tooltips_get_info_from_tip_window, unfullscreen, unmaximize, unstick

Inherited from gtk.Bin: get_child

Inherited from gtk.Container: __len__, __nonzero__, add, add_with_properties, check_resize, child_get, child_get_property, child_set, child_set_property, child_type, children, do_add, do_check_resize, do_child_type, do_composite_name, do_forall, do_get_child_property, do_remove, do_set_child_property, do_set_focus_child, forall, foreach, get_border_width, get_children, get_focus_chain, get_focus_child, get_focus_hadjustment, get_focus_vadjustment, get_resize_mode, install_child_property, list_child_properties, propagate_expose, remove, resize_children, set_border_width, set_focus_chain, set_focus_child, set_focus_hadjustment, set_focus_vadjustment, set_reallocate_redraws, set_resize_mode, unset_focus_chain

Inherited from gtk.Widget: activate, add_accelerator, add_events, add_mnemonic_label, can_activate_accel, child_focus, child_notify, class_path, create_pango_context, create_pango_layout, do_button_press_event, do_button_release_event, do_can_activate_accel, do_client_event, do_composited_changed, do_configure_event, do_delete_event, do_destroy_event, do_direction_changed, do_drag_begin, do_drag_data_delete, do_drag_data_get, do_drag_data_received, do_drag_drop, do_drag_end, do_drag_leave, do_drag_motion, do_enter_notify_event, do_event, do_expose_event, do_focus, do_focus_in_event, do_focus_out_event, do_get_accessible, do_grab_broken_event, do_grab_focus, do_grab_notify, do_hide, do_hide_all, do_hierarchy_changed, do_key_press_event, do_key_release_event, do_leave_notify_event, do_map, do_map_event, do_mnemonic_activate, do_motion_notify_event, do_no_expose_event, do_parent_set, do_popup_menu, do_property_notify_event, do_proximity_in_event, do_proximity_out_event, do_realize, do_screen_changed, do_scroll_event, do_selection_clear_event, do_selection_get, do_selection_notify_event, do_selection_received, do_selection_request_event, do_show, do_show_all, do_show_help, do_size_allocate, do_size_request, do_state_changed, do_style_set, do_unmap, do_unmap_event, do_unrealize, do_visibility_notify_event, do_window_state_event, drag_begin, drag_check_threshold, drag_dest_add_image_targets, drag_dest_add_text_targets, drag_dest_add_uri_targets, drag_dest_find_target, drag_dest_get_target_list, drag_dest_get_track_motion, drag_dest_set, drag_dest_set_proxy, drag_dest_set_target_list, drag_dest_set_track_motion, drag_dest_unset, drag_get_data, drag_highlight, drag_source_add_image_targets, drag_source_add_text_targets, drag_source_add_uri_targets, drag_source_get_target_list, drag_source_set, drag_source_set_icon, drag_source_set_icon_name, drag_source_set_icon_pixbuf, drag_source_set_icon_stock, drag_source_set_target_list, drag_source_unset, drag_unhighlight, draw, ensure_style, error_bell, event, freeze_child_notify, get_accessible, get_action, get_activate_signal, get_allocation, get_ancestor, get_app_paintable, get_can_default, get_can_focus, get_child_requisition, get_child_visible, get_clipboard, get_colormap, get_composite_name, get_direction, get_display, get_double_buffered, get_events, get_extension_events, get_has_tooltip, get_has_window, get_mapped, get_modifier_style, get_name, get_no_show_all, get_pango_context, get_parent, get_parent_window, get_pointer, get_realized, get_receives_default, get_requisition, get_root_window, get_sensitive, get_settings, get_size_request, get_snapshot, get_state, get_style, get_tooltip_markup, get_tooltip_text, get_tooltip_window, get_toplevel, get_visible, get_visual, get_window, grab_add, grab_default, grab_focus, grab_remove, has_default, has_grab, has_rc_style, has_screen, hide, hide_all, hide_on_delete, input_shape_combine_mask, intersect, is_ancestor, is_composited, is_drawable, is_focus, is_sensitive, is_toplevel, keynav_failed, list_accel_closures, list_mnemonic_labels, map, menu_get_for_attach_widget, modify_base, modify_bg, modify_cursor, modify_fg, modify_font, modify_style, modify_text, path, queue_clear, queue_clear_area, queue_draw, queue_draw_area, queue_resize, queue_resize_no_redraw, rc_get_style, realize, region_intersect, remove_accelerator, remove_mnemonic_label, render_icon, reparent, reset_rc_styles, reset_shapes, selection_add_target, selection_add_targets, selection_clear_targets, selection_convert, selection_owner_set, selection_remove_all, send_expose, send_focus_change, set_accel_path, set_activate_signal, set_allocation, set_app_paintable, set_can_default, set_can_focus, set_child_visible, set_colormap, set_composite_name, set_direction, set_double_buffered, set_events, set_extension_events, set_has_tooltip, set_has_window, set_mapped, set_name, set_no_show_all, set_parent, set_parent_window, set_realized, set_receives_default, set_redraw_on_allocate, set_scroll_adjustments, set_sensitive, set_set_scroll_adjustments_signal, set_size_request, set_state, set_style, set_tooltip_markup, set_tooltip_text, set_tooltip_window, set_uposition, set_usize, set_visible, set_window, shape_combine_mask, show, show_all, show_now, size_allocate, size_request, style_attach, style_get_property, thaw_child_notify, translate_coordinates, trigger_tooltip_query, unmap, unparent, unrealize

Inherited from gtk.Object: do_destroy, flags, remove_data, remove_no_notify, set_flags, unset_flags

Inherited from unreachable.GObject: __copy__, __deepcopy__, __delattr__, __eq__, __gdoc__, __ge__, __gobject_init__, __gt__, __hash__, __le__, __lt__, __ne__, __new__, __repr__, __setattr__, chain, connect, connect_after, connect_object, connect_object_after, disconnect, disconnect_by_func, emit, emit_stop_by_name, freeze_notify, get_data, get_properties, get_property, handler_block, handler_block_by_func, handler_disconnect, handler_is_connected, handler_unblock, handler_unblock_by_func, notify, props, set_data, set_properties, set_property, stop_emission, thaw_notify, weak_ref

Inherited from atk.ImplementorIface: ref_accessible

Inherited from gtk.Buildable: add_child, construct_child, do_add_child, do_construct_child, do_get_internal_child, do_parser_finished, do_set_name, get_internal_child, parser_finished

Inherited from object: __format__, __getattribute__, __reduce__, __reduce_ex__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  HELP = 'The following keyboard commands are available from the...

Inherited from gtk.Window: __gtype__

Properties [hide private]
  cursor_cell

Inherited from gtk.Window: allow_grow, allow_shrink, configure_notify_received, configure_request_count, decorated, default_widget, destroy_with_parent, focus_widget, frame, frame_bottom, frame_left, frame_right, frame_top, gravity, group, has_focus, has_frame, has_user_ref_count, iconify_initially, keys_changed_handler, maximize_initially, mnemonic_modifier, modal, need_default_position, need_default_size, position, stick_initially, title, transient_parent, type, type_hint, wm_role, wmclass_class, wmclass_name

Inherited from gtk.Bin: child

Inherited from gtk.Container: border_width, focus_child, has_focus_chain, need_resize, reallocate_redraws, resize_mode

Inherited from gtk.Widget: allocation, name, parent, requisition, saved_state, state, style, window

Inherited from unreachable.GObject: __grefcount__

Inherited from object: __class__

Method Details [hide private]

__init__(self, left, bottom, right, top, sequencer, *args, **kwargs)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • left (int) - leftmost column to include
  • right (int) - rightmost column
  • bottom (int) - lowest row
  • top (int) - highest row
  • sequencer (midi.sequencer_pygame.RealtimeSequencer) - sequencer to use for playing notes
  • font_size (int or float) - size in points of the font used to draw the cell labels
  • chord_types (dict of coordinate lists (3-tuples)) - chord types to allow the user to add
  • chord_type_order (list of strings) - ordered list giving the order of the chord types (optional)
  • vfill (bool) - expand the tonal space to fill the vertical size of the window. Default: True.
  • hfill (bool) - expand the tonal space to fill the horizontal size of the window. Default: True.
Overrides: object.__init__

get_cell(self, x, y)

source code 

Returns the cell for the given 2D tonal space coordinate. Returns None if this cell isn't in the visible region.

destroy(self, widget, data=None)

source code 

Handler for window destruction.

Overrides: gtk.Object.destroy

cell_clicked(self, cell, event)

source code 

Called by each cell when it gets clicked. If we return True here, it means the cell shouldn't do its usual click actions, because we're doing something that replaces them. Otherwise, the cell can go ahead and do its usual thing.

play_chord(self, chord_name)

source code 

Set the notes of a particular chord going.

The first thing this does is to wait for the user to select a chord root. Then it positions the note cluster around the root and plays those notes.

set_cursor(self, coord, absolute=False)

source code 

Set the 2D coord to be under the current cursor. By default, relative to the previous.


Class Variable Details [hide private]

HELP

Value:
'''The following keyboard commands are available from the GUI:
  F11: toggle fullscreen
  q:   quit
  x:   all notes off
  a:   clear selection
  c:   select a chord to play
  r:   toggle chord replace mode (chords replace all playing notes ins\
tead of 
...

Property Details [hide private]

cursor_cell

Get Method:
unreachable.cursor_cell(self)