/*
  timeline-track.hpp  -  Declaration of the timeline group track object
 
  Copyright (C)         Lumiera.org
    2008,               Joel Holdsworth <joel@airwebreathe.org.uk>
 
  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
*/
/** @file widgets/timeline/timeline-track.hpp
 ** This file contains the definition of timeline track object
 */

#include "../../gtk-lumiera.hpp"
#include "../../model/track.hpp"
#include "../menu-button.hpp"
#include "timeline-header-container.hpp"

#ifndef TIMELINE_TRACK_HPP
#define TIMELINE_TRACK_HPP

namespace gui {
namespace widgets { 
namespace timeline {
  
class TimelineViewWindow;

class Track : public sigc::trackable
{
public:
  
  enum ExpandDirection
  {
    Expand,
    Collapse
  };
  
public:
  Track(TimelineWidget &timeline_widget,
    boost::shared_ptr<model::Track> track);
  
  Gtk::Widget& get_header_widget();
  
  boost::shared_ptr<model::Track> get_model_track() const;
  
  int get_height() const;
  
  bool get_expanded() const;
  
  void expand_collapse(ExpandDirection direction);
  
  // -1 for no animation
  int get_expand_animation_state() const;
  
  void tick_expand_animation();
  
  Gtk::ExpanderStyle get_expander_style() const;
  
  void show_header_context_menu(guint button, guint32 time);

  virtual void draw_track(Cairo::RefPtr<Cairo::Context> cairo,
    TimelineViewWindow* const window)
    const = 0;
    
public:
  static const int NoAnimationState;
  static const int MaxExpandAnimation;
  static const double ExpandAnimationPeriod;

private:
  //----- Internals -----//
  void update_name();
  
private:

  //----- Event Handlers -----//
  void on_set_name();

  void on_remove_track();
  
protected:

  TimelineWidget &timelineWidget;
  boost::shared_ptr<model::Track> model_track;

private:
  bool expanded;
  
  ExpandDirection expandDirection;
  double expandAnimationState;
  
  static Glib::Timer timer;
  double lastTickTime;

  //----- Header Widgets ------//
  
  Gtk::VBox headerWidget;
  
  MenuButton titleMenuButton;
  
  Gtk::ToolButton enableButton;
  Gtk::ToolButton lockButton;
  
  Gtk::Entry titleBox;
  Gtk::Toolbar buttonBar;
  
  Gtk::Menu contextMenu;
};


}   // namespace timeline
}   // namespace widgets
}   // namespace gui

#endif // TIMELINE_TRACK_HPP