/*
  timeline-layout-helper.hpp  -  Declaration of the timeline
  layout helper class
 
  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 timeline-layout-helper.cpp
 ** This file contains the definition of the layout helpeer class
 */

#ifndef TIMELINE_LAYOUT_HELPER_HPP
#define TIMELINE_LAYOUT_HELPER_HPP

#include "../../gtk-lumiera.hpp"
#include "../../../lib/tree.hpp"

namespace gui {

namespace model {
class Track;
}
  
namespace widgets {

class TimelineWidget;
  
namespace timeline {
  
class Track;

/**
 * A helper class for the TimelineWidget. TimelineLayoutHelper
 * is a class which calculates the layout of tracks in the timeline
 * track tree.
 */
class TimelineLayoutHelper : public boost::noncopyable
{
public:
  TimelineLayoutHelper(TimelineWidget &owner);
protected:
  
  void clone_tree_from_sequence();
  
  void add_branch(
    lumiera::tree< boost::shared_ptr<model::Track> >::iterator_base
      parent_iterator, 
    boost::shared_ptr<model::Track> parent);
  
protected:
  TimelineWidget &timelineWidget;
  
  lumiera::tree< boost::shared_ptr<model::Track> > layoutTree;
};

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

#endif // TIMELINE_LAYOUT_HELPER_HPP