root/trunk/FRII/gui/HorizontalSequenceView.hh

/*
 * This file is part of the FamilyRelations II source distribution.
 *
 * FamilyRelations II is part of the FamilyJewels package for comparative
 * sequence analysis: http://family.caltech.edu/.
 *
 * Contact author: C. Titus Brown, titus@caltech.edu.
 *
 * This program and all associated source code files are Copyright (C) 2003,
 * 2004 the California Institute of Technology, Pasadena, CA, 91125 USA.  It
 * is under the Lesser GNU Public License; please see the included
 * LICENSE.txt file for more information, or contact Titus directly.
 *
 */

// A (horizontal) sequence-view class that draws a sequence line, tick marks,
// and features on the sequence.

#ifndef HORIZONTAL_SEQUENCE_VIEW_HH
#define HORIZONTAL_SEQUENCE_VIEW_HH

#include <FL/Fl.H>
#include <FL/Fl_Window.H>
#include <FL/Fl_Box.H>
#include <FL/fl_draw.H>

#include "SequenceView.hh"

namespace gui {
  class HorizontalSequenceView : public SequenceView {
  protected:
    //
    // customizable in subclasses
    //

    // size of the border on either side of the sequence line
    const static unsigned int border = 60;

    // thickness of the sequence line
    const static unsigned int line_thickness = 6;

    // height of tick marks / 2
    const static unsigned int half_tick_height = 5;

    // thickness of the line used to draw ticks
    const static unsigned int tick_thickness = 2;

    // half the size of the text label
    const static unsigned int half_label_height = 6;

    // the width of the text label
    const static unsigned int label_width = border - 2;

    // drawing stuff
    void draw();
    void draw_ticks();
    void draw_ticks_at_spacing(int);
    void draw_labels();
    void draw_selection_box();
    void draw_features();
    bool _show_sequence_line;

    // Specific event handler
    virtual int handle(int e);

    // internal access to some of the drawing information.
    unsigned int get_left(), get_width(), get_mid();
  public:
    // constructor with only sequence length.
    HorizontalSequenceView(int x, int y,
                           unsigned int width, unsigned int seq_len) :
      SequenceView(x, y, width, height, seq_len) {
      _show_sequence_line = true;
    };

    // constructor with sequence, too.
    HorizontalSequenceView(int x, int y, unsigned int width,
                           std::string seq_name, std::string seq) :
      SequenceView(x, y, width, height, seq.length()) {
      _sequence_name = seq_name;
      _sequence_text = seq;
      _show_sequence_line = true;
    };

    // public access to the height; this must sometimes be used by groups,
    // before the sequence is instantiated, which is why it's a static
    // variable by default.
    const static unsigned int height = 20;
    virtual void h(unsigned int _h) { SequenceView::h(_h); }
    virtual unsigned int h() { return SequenceView::h(); }

    // coordinate stuff
    unsigned int base_to_pos(int base);
    unsigned int pos_to_base(int pos);

    // display info: draw lines/ticks?
    void show_sequence_line(bool s) { _show_sequence_line = s; }
    bool show_sequence_line() { return _show_sequence_line; }
  };
}

#endif // HORIZONTAL_SEQUENCE_VIEW_HH