Guitar

---

Object Hierarchy:

Description:

Content:

Classes:

• MarkedNoteStyle - Style for marked notes

Properties:

• public bool auto_update { get; set; }
  Auto-redraw when a note is added (disable for manual management)
• public bool detailed_labels { get; set; }
  Show octaves in labels (e.g.: E4)
• public RGBA fret_color { get; set; }
  Fret color as a RGBA array of floats
• public HashSet<GuitarFretMark> fret_marks { get; set; }
  Collection of fret marks
• public ushort fret_number { get; set; }
  Number of frets
• public RGBA grid_bg_color { get; set; }
  Grid background color as a RGBA array of floats
• public ArrayList<GuitarString> guitar_strings { get; set; }
  Collection of strings
• public bool highlight_first_fret { get; set; }
  Draw additional line in 1st fret
• public bool show_labels { get; set; }
  Render string labels (e.g.: EADGBE)

Creation methods:

• public Guitar ()

Methods:

• public override bool button_press_event (EventButton event)
  Customized button_press_event
• public override bool button_release_event (EventButton event)
  Customized button_released_event
• public override bool draw (Context cr)
  Draw the guitar widget
• public HashSet<GuitarPosition>? find_positions (string note)
  Find all positions of a given note
• public void mark_note (string note, RGBA color = {0.0f, 0.0f, 0.0f, 1.0f})
  Highlight all positions corresponding to a note
• public void mark_position (ushort string_index, ushort fret_index, RGBA color = {0.0f, 0.0f, 0.0f, 1.0f})
  Highlight a position (string and fret) in the instrument
• public short note_position_in_string (ushort string_index, string note)
  Compute the fret index to accomplish a given note in a given string
• public ushort position_to_midi (GuitarPosition position)
  Get a MIDI code from a guitar position
• public string position_to_note (GuitarPosition position)
  Convenient function for getting a note name from a guitar position
• public void redraw ()
  Force a complete redraw of the widget
• public override void size_allocate (Allocation allocation)
• public void start_animation ()
  Start the animation on strings set to vibrate
• public void stop_animation ()
  Stop the string vibration animation
• public void unmark_all ()
  Remove all marked notes in the Guitar view
• public void unmark_note (string note)
  Remove the marks in all positions corresponding to a note
• public void unmark_position (ushort string_index, ushort fret_index)
  Remove the mark of a position (string and fret) in the instrument

Signals:

• public signal void note_pressed (EventButton event, GuitarPosition pos)
  Signal emitted when a note has been pressed with the mouse
• public signal void note_released (EventButton event, GuitarPosition pos)
  Signal emitted when a note has been released (mouse button released)

Fields:

• public HashMap<GuitarPosition,MarkedNoteStyle> marked_notes
  Marked notes dictionary (position and mark style)

Inherited Members: