gui/widgets/timeline/timeline-header-container.cpp

/*
  timeline-header-container.cpp  -  Implementation of the timeline
  header container widget
 
  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.
 
* *****************************************************/

#include <boost/foreach.hpp>

#include "timeline-header-container.hpp"
#include "timeline-track.hpp"
#include "../timeline-widget.hpp"

using namespace Gtk;
using namespace std;
using namespace boost;
using namespace util;

namespace gui {
namespace widgets {
namespace timeline {

TimelineHeaderContainer::TimelineHeaderContainer(
  gui::widgets::TimelineWidget *timeline_widget) :
    Glib::ObjectBase("TimelineHeaderContainer"),
    timelineWidget(timeline_widget),
    margin(-1),
    expand_button_size(12)
{
  REQUIRE(timeline_widget != NULL);

  // This widget will not have a window at first
  set_flags(Gtk::NO_WINDOW);
  
  set_redraw_on_allocate(false);
  
  // Connect to the timeline widget's vertical scroll event,
  // so that we get notified when the view shifts
  timelineWidget->verticalAdjustment.signal_value_changed().connect(
    sigc::mem_fun(this, &TimelineHeaderContainer::on_scroll) );
    
  // Connect to the timeline widget's hover event,
  // so that we get notified when tracks are hovered on
  timelineWidget->hovering_track_changed_signal().connect(
    sigc::mem_fun(this,
    &TimelineHeaderContainer::on_hovering_track_changed) );
    
  // Create the context menu
  Menu::MenuList& menu_list = contextMenu.items();
  menu_list.push_back( Menu_Helpers::MenuElem(_("_Add Track"),
    sigc::mem_fun(timelineWidget,
    &TimelineWidget::on_add_track_command) ) );
    
  // Install style properties
  register_styles();
}
 
void
TimelineHeaderContainer::update_headers()
{    
  // Add fresh headers  
  BOOST_FOREACH( shared_ptr<model::Track> model_track, get_tracks() )
    set_parent_recursive(model_track);
}
  
void
TimelineHeaderContainer::on_realize()
{
  set_flags(Gtk::NO_WINDOW);
  
  // Call base class:
  Gtk::Container::on_realize();
  
  // Create the GdkWindow:
  GdkWindowAttr attributes;
  memset(&attributes, 0, sizeof(attributes));

  Allocation allocation = get_allocation();

  // Set initial position and size of the Gdk::Window:
  attributes.x = allocation.get_x();
  attributes.y = allocation.get_y();
  attributes.width = allocation.get_width();
  attributes.height = allocation.get_height();

  attributes.event_mask = get_events () | Gdk::EXPOSURE_MASK; 
  attributes.window_type = GDK_WINDOW_CHILD;
  attributes.wclass = GDK_INPUT_OUTPUT;

  gdkWindow = Gdk::Window::create(get_window(), &attributes,
          GDK_WA_X | GDK_WA_Y);
  unset_flags(Gtk::NO_WINDOW);
  set_window(gdkWindow);
  
  // Unset the background so as to make the colour match the parent
  // window
  unset_bg(STATE_NORMAL);

  // Make the widget receive expose events
  gdkWindow->set_user_data(gobj());
  
  // Make the widget sensitive to mouse events
  add_events(
    Gdk::POINTER_MOTION_MASK |
    Gdk::BUTTON_PRESS_MASK |
    Gdk::BUTTON_RELEASE_MASK);
}
  
void
TimelineHeaderContainer::on_unrealize()
{
  // Unreference any window we may have created
  gdkWindow.clear();

  // Call base class:
  Container::on_unrealize();
}

bool TimelineHeaderContainer::on_button_press_event (
  GdkEventButton* event)
{
  REQUIRE(event != NULL);
  
  switch(event->button)
    {
    case 1: // Left Click
      // Did the user press the button on an expander?
      if(hoveringExpander != NULL)
        {
          // Yes? The prime for a release event
          clickedExpander = hoveringExpander;
          queue_draw();
        }
      break;
      
    case 3: // Right Click
      {
        // Popup the context menu
        shared_ptr<Track> header = header_from_point(
          Gdk::Point(event->x, event->y));
        
        // Are we hovering on a header?
        if(header)
          {
            // Yes - show the header's context menu
            header->show_header_context_menu(
              event->button, event->time);
          }
        else
          {
            // No - show the default context menu
            contextMenu.popup(event->button, event->time);
          }
        break;
      }
    }
  
  return true;
}

bool TimelineHeaderContainer::on_button_release_event (
  GdkEventButton* event)
{
  // Did the user release the button on an expander?
  if(clickedExpander != NULL)
    {
      // Yes? The toggle the expanding
      clickedExpander->set_expanded(!clickedExpander->get_expanded());
      clickedExpander.reset();
      layout_headers();
    }

  return Container::on_button_release_event(event);    
}

bool TimelineHeaderContainer::on_motion_notify_event (
  GdkEventMotion* event)
{
  REQUIRE(event != NULL);
 
  // Are we hovering on an expander?
  shared_ptr<timeline::Track> expander = expander_button_from_point(
    Gdk::Point(event->x, event->y));
  
  if(expander != hoveringExpander)
    {
      hoveringExpander = expander;
      queue_draw();
    }
    
  return Container::on_motion_notify_event(event);
}

void
TimelineHeaderContainer::on_size_request (Requisition* requisition)
{ 
  // We don't care about the size of all the child widgets, but if we
  // don't send the size request down the tree, some widgets fail to
  // calculate their text layout correctly. 
  BOOST_FOREACH( shared_ptr<model::Track> model_track, get_tracks() )
    size_request_recursive(model_track);
    
  // Initialize the output parameter:
  *requisition = Gtk::Requisition();
  requisition->width = TimelineWidget::HeaderWidth; 
  requisition->height = 0;
}
  
void
TimelineHeaderContainer::on_size_allocate (Allocation& allocation)
{ 
  // Use the offered allocation for this container:
  set_allocation(allocation);
  
  // Resize the widget's window
  if(gdkWindow)
    {
      gdkWindow->move(allocation.get_x(), allocation.get_y());
      gdkWindow->resize(
        allocation.get_width(), allocation.get_height());
    }
  
  // Relayout the child widgets of the headers
  layout_headers();
}
  
void
TimelineHeaderContainer::forall_vfunc(gboolean /* include_internals */,
        GtkCallback callback, gpointer callback_data)
{ 
  REQUIRE(callback != NULL);
  
  BOOST_FOREACH( shared_ptr<model::Track> track, get_tracks() )
    {
      REQUIRE(track);
      forall_vfunc_recursive(track, callback, callback_data);
    }
}

void
TimelineHeaderContainer::on_remove(Widget* widget)
{
  // Do nothing - this is just to keep Gtk::Container happy
}

bool
TimelineHeaderContainer::on_expose_event(GdkEventExpose *event)
{ 
  if(gdkWindow)
    {
      // Start at an offset from the scroll offset
      int offset = -timelineWidget->get_y_scroll_offset();

      const Allocation container_allocation = get_allocation();
      
      read_styles();
       
      // Paint a border underneath all the root headers
      BOOST_FOREACH( shared_ptr<model::Track> model_track,
        get_tracks() )
        {
          REQUIRE(model_track);
          
          draw_header_decoration(model_track,
            Gdk::Rectangle(0, 0,
              container_allocation.get_width(),
              container_allocation.get_height()));
        }
    }

  return Container::on_expose_event(event);
}
  
void
TimelineHeaderContainer::on_scroll()
{
  // If the scroll has changed, we will have to shift all the
  // header widgets
  layout_headers();
}

void
TimelineHeaderContainer::on_hovering_track_changed(
  boost::shared_ptr<timeline::Track> hovering_track)
{
  // The hovering track has changed, redraw so we can light the header
  queue_draw();
}
  
void
TimelineHeaderContainer::layout_headers()
{  
  // We can't layout before the widget has been set up
  if(!gdkWindow)
    return;

  // Make sure the style are loaded
  read_styles();
    
  // Clear previously cached layout
  headerBoxes.clear();

  // Start at minus-the-scroll offset
  int offset = -timelineWidget->get_y_scroll_offset();
    
  const Allocation container_allocation = get_allocation();
  const int header_width = container_allocation.get_width();
  
  BOOST_FOREACH( shared_ptr<model::Track> model_track, get_tracks() )
    layout_headers_recursive(
      model_track, offset, header_width, 0, true);
    
  // Repaint the background of our parenting
  queue_draw ();
}

void
TimelineHeaderContainer::layout_headers_recursive(
  shared_ptr<model::Track> model_track, int &offset,
  const int header_width, const int depth, bool parent_expanded)
{
  REQUIRE(depth >= 0);
  REQUIRE(model_track != NULL);
  
  shared_ptr<timeline::Track> timeline_track =
    lookup_timeline_track(model_track);
  
  const int indent = depth * 10;
  Widget &widget = timeline_track->get_header_widget();
  
  if(parent_expanded)
    {
      const int track_height = timeline_track->get_height();
      
      // Calculate the box of the header
      Gdk::Rectangle header_box(
        indent,                                               // x
        offset,                                               // y
        max( header_width - indent, 0 ),                      // width
        track_height);                                        // height
      REQUIRE(header_box.get_height() >= 0);
      
      // Cache the bounding box
      headerBoxes[timeline_track] = header_box;
        
      // Calculate the allocation of the header widget
      Allocation header_allocation(
        header_box.get_x() + margin + expand_button_size,     // x
        header_box.get_y() + margin,                          // y
        max( header_box.get_width() - expand_button_size -
          margin * 2, 0 ),                                    // width
        header_box.get_height() - margin * 2);                // height
      
      // Apply the allocation to the header
      widget.size_allocate (header_allocation);
      if(!widget.is_visible())
        widget.show();
      
      // Offset for the next header
      offset += track_height + TimelineWidget::TrackPadding;
    }
  else
    if(widget.is_visible())
      widget.hide();
    
  // Recurse through all the children
  BOOST_FOREACH( boost::shared_ptr<model::Track> child,
    model_track->get_child_tracks() ) 
    layout_headers_recursive(
      child, offset, header_width, depth + 1,
      timeline_track->get_expanded() && parent_expanded);
}

void
TimelineHeaderContainer::set_parent_recursive(
  boost::shared_ptr<model::Track> model_track)
{ 
  // Set the header's parent widget
  Widget &widget = lookup_timeline_track(model_track)->
    get_header_widget();
  
  const Container *parent = widget.get_parent();
  if(parent == NULL)  // Is the header unparented?
    widget.set_parent(*this);
  else if(parent != this) // The header is parented by another container
    widget.reparent(*this);
  
  // Recurse through all the children
  BOOST_FOREACH( shared_ptr<model::Track> child,
    model_track->get_child_tracks() )
    set_parent_recursive(child);
}

void
TimelineHeaderContainer::size_request_recursive(
  shared_ptr<model::Track> const model_track)
{  
  Widget &widget =
    lookup_timeline_track(model_track)->get_header_widget();
  if(widget.is_visible())
    widget.size_request();
  
  // Recurse through all the children
  BOOST_FOREACH( shared_ptr<model::Track> child,
    model_track->get_child_tracks() )
    size_request_recursive(child);
}

void
TimelineHeaderContainer::forall_vfunc_recursive(
  shared_ptr<model::Track> model_track, GtkCallback callback,
  gpointer callback_data)
{
  REQUIRE(callback != NULL);
    
  callback( lookup_timeline_track(model_track)->
    get_header_widget().gobj(), callback_data) ;
  
  // Recurse through all the children
  BOOST_FOREACH( shared_ptr<model::Track> child,
    model_track->get_child_tracks() )
    forall_vfunc_recursive(child, callback, callback_data);
}

void
TimelineHeaderContainer::draw_header_decoration(
    shared_ptr<model::Track> model_track,
    const Gdk::Rectangle &clip_rect)
{
  REQUIRE(model_track != NULL);
  REQUIRE(clip_rect.get_width() > 0);
  REQUIRE(clip_rect.get_height() > 0);
  
  Glib::RefPtr<Style> style = get_style();
  REQUIRE(style);
  
  shared_ptr<timeline::Track> timeline_track =
    lookup_timeline_track(model_track);
  
  // Get the cached header box
  weak_ptr<timeline::Track> ptr(timeline_track);
  REQUIRE(contains(headerBoxes, ptr));  
  const Gdk::Rectangle &box = headerBoxes[timeline_track];
  
  // Paint the box, if it will be visible
  if(box.get_x() < clip_rect.get_width() &&
    box.get_height() > 0 &&
    box.get_y() + box.get_height() > clip_rect.get_y()  &&
    box.get_y() < clip_rect.get_y() + clip_rect.get_height())
    {
      // Use paint_box to draw a themed bevel around the header
      style->paint_box(gdkWindow, STATE_NORMAL,
        SHADOW_OUT, clip_rect, *this, "",
        box.get_x(), box.get_y(),
        box.get_width(), box.get_height());
        
      // Paint the expander if there are child tracks
      StateType state_type = STATE_NORMAL;
      if(clickedExpander == timeline_track)
        state_type = STATE_SELECTED;
      else if(hoveringExpander == timeline_track)
        state_type = STATE_PRELIGHT;
      
      const ExpanderStyle expander_style = 
        timeline_track->get_expanded() ?
          EXPANDER_EXPANDED : EXPANDER_COLLAPSED;
      
      if(!model_track->get_child_tracks().empty())
        style->paint_expander (gdkWindow,
          state_type, 
          clip_rect, *this, "",
          box.get_x() + expand_button_size / 2 + margin,
          box.get_y() + box.get_height() / 2,
          expander_style);
    }
  
  // Recurse through all the children
  if(timeline_track->get_expanded())
    BOOST_FOREACH( shared_ptr<model::Track> child,
      model_track->get_child_tracks() )
      draw_header_decoration(child, clip_rect);
}

boost::shared_ptr<timeline::Track>
TimelineHeaderContainer::header_from_point(const Gdk::Point &point)
{
  std::pair<shared_ptr<timeline::Track>, Gdk::Rectangle> pair; 
  BOOST_FOREACH( pair, headerBoxes )
    {
      // Hit test the rectangle
      const Gdk::Rectangle &rect = pair.second;
      
      if(point.get_x() >= rect.get_x() &&
        point.get_x() < rect.get_x() + rect.get_width() &&
        point.get_y() >= rect.get_y() &&
        point.get_y() < rect.get_y() + rect.get_height())
        return pair.first;
    }
    
  return shared_ptr<timeline::Track>();
}

shared_ptr<timeline::Track>
TimelineHeaderContainer::expander_button_from_point(
  const Gdk::Point &point)
{
  std::pair<shared_ptr<timeline::Track>, Gdk::Rectangle> pair; 
  BOOST_FOREACH( pair, headerBoxes )
    {
      // Hit test the rectangle
      const Gdk::Rectangle rect =
        get_expander_button_rectangle(pair.first);
      
      if(point.get_x() >= rect.get_x() &&
        point.get_x() < rect.get_x() + rect.get_width() &&
        point.get_y() >= rect.get_y() &&
        point.get_y() < rect.get_y() + rect.get_height())
        return pair.first;
    }
    
  return shared_ptr<timeline::Track>();
}

const Gdk::Rectangle
TimelineHeaderContainer::get_expander_button_rectangle(
  shared_ptr<Track> track)
{
  REQUIRE(track != NULL);
  weak_ptr<timeline::Track> ptr(track);
  REQUIRE(contains(headerBoxes, ptr));  
  
  const Gdk::Rectangle &box = headerBoxes[track];
  return Gdk::Rectangle(
    margin + box.get_x(), margin + box.get_y(),
    expand_button_size, box.get_height() - margin * 2);
}

shared_ptr<timeline::Track>
TimelineHeaderContainer::lookup_timeline_track(
  shared_ptr<model::Track> model_track)
{
  REQUIRE(model_track != NULL);
  REQUIRE(timelineWidget != NULL);
  
  shared_ptr<timeline::Track> timeline_track =
    timelineWidget->lookup_timeline_track(model_track);
  ENSURE(timeline_track);
  
  return timeline_track;
}

const std::list< boost::shared_ptr<model::Track> >
TimelineHeaderContainer::get_tracks() const
{
  REQUIRE(timelineWidget != NULL);
  REQUIRE(timelineWidget->sequence);
  return timelineWidget->sequence->get_child_tracks();
}

void
TimelineHeaderContainer::register_styles() const
{
  static bool registered = false;
  if(registered) return;
  registered = true;
  
  GtkWidgetClass *klass = GTK_WIDGET_CLASS(G_OBJECT_GET_CLASS(gobj()));

  gtk_widget_class_install_style_property(klass, 
    g_param_spec_int("heading_margin",
    "Heading Margin",
    "The amount of padding around each header pixels.",
    0, G_MAXINT, 4, G_PARAM_READABLE));
}

void
TimelineHeaderContainer::read_styles()
{
  if(margin <= 0)
    get_style_property("heading_margin", margin);
}

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

---