From 75d2890ab72c30edac39df33007bf000cd0b8ca3 Mon Sep 17 00:00:00 2001
From: Joel Holdsworth <joel@joel-desktop.(none)>
Date: Wed, 14 Jan 2009 23:22:04 +0000
Subject: [PATCH] WIP: Added new header code

---
 .../timeline/timeline-header-widget.cpp       | 330 ++++++++++++++++++
 .../timeline/timeline-header-widget.hpp       | 138 ++++++++
 2 files changed, 468 insertions(+)
 create mode 100644 src/gui/widgets/timeline/timeline-header-widget.cpp
 create mode 100644 src/gui/widgets/timeline/timeline-header-widget.hpp

diff --git a/src/gui/widgets/timeline/timeline-header-widget.cpp b/src/gui/widgets/timeline/timeline-header-widget.cpp
new file mode 100644
index 000000000..d11f96ce1
--- /dev/null
+++ b/src/gui/widgets/timeline/timeline-header-widget.cpp
@@ -0,0 +1,330 @@
+/*
+  timeline-header-widget.cpp  -  Implementation of the timeline
+  header 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-widget.hpp"
+#include "../../util/rectangle.hpp"
+
+using namespace Gtk;
+using namespace std;
+using namespace boost;
+using namespace util;
+
+namespace gui {
+namespace widgets {
+namespace timeline {
+
+TimelineHeaderWidget::TimelineHeaderWidget(
+  timeline::Track &timeline_track) :
+  Glib::ObjectBase("TimelineHeaderWidget"),
+  track(timeline_track),
+  widget(NULL),
+  hoveringExpander(false),
+  clickedExpander(false),
+  margin(-1),
+  expand_button_size(12)
+{
+  set_flags(Gtk::NO_WINDOW);
+  set_redraw_on_allocate(false);
+  
+  // Install style properties
+  register_styles();
+  
+  // Load the styles up
+  read_styles();
+}
+
+void
+TimelineHeaderWidget::on_realize()
+{
+  set_flags(Gtk::NO_WINDOW);
+   
+  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
+TimelineHeaderWidget::on_unrealize()
+{
+  // Unreference any window we may have created
+  gdkWindow.clear();
+
+  // Call base class:
+  Container::on_unrealize();
+}
+
+void
+TimelineHeaderWidget::set_child_widget(Widget& child)
+{
+  widget = &child;
+  widget->set_parent(*this);
+}
+
+void
+TimelineHeaderWidget::on_size_request(Requisition* requisition)
+{
+  REQUIRE(requisition); 
+
+  Requisition child_requisition = {0, 0};
+
+  if(widget && widget->is_visible())
+    child_requisition = widget->size_request();
+
+  requisition->width = child_requisition.width,
+  requisition->height = child_requisition.height;
+  
+  ENSURE(requisition->width >= 0);
+  ENSURE(requisition->height >= 0);
+}
+
+void
+TimelineHeaderWidget::on_size_allocate(Gtk::Allocation& allocation)
+{
+  //Use the offered allocation for this container:
+  set_allocation(allocation);
+  
+  // Resize the widget's window
+  if(gdkWindow)
+    {
+      gdkWindow->move_resize(allocation.get_x(), allocation.get_y(),
+        allocation.get_width(), allocation.get_height());
+    }
+
+  //Assign sign space to the child:
+  Gtk::Allocation child_allocation(
+    margin + expand_button_size,
+    margin,
+    max(allocation.get_width() - expand_button_size - margin * 2, 0),
+    allocation.get_height() - margin*2);
+
+  if(widget && widget->is_visible())
+    widget->size_allocate(child_allocation);
+}
+
+bool
+TimelineHeaderWidget::on_expose_event(GdkEventExpose *event)
+{  
+  Glib::RefPtr<Style> style = get_style();
+  REQUIRE(style);
+  REQUIRE(gdkWindow);
+  
+  shared_ptr<model::Track> model_track = track.get_model_track();
+  REQUIRE(model_track);
+    
+  // Get the header box  
+  const Gdk::Rectangle allocation = get_allocation();
+  const Gdk::Rectangle box(0, 0,
+    allocation.get_width(), allocation.get_height());
+  
+  // Use paint_box to draw a themed bevel around the header
+  style->paint_box(gdkWindow, STATE_NORMAL,
+    SHADOW_OUT, box, *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)
+    state_type = STATE_SELECTED;
+  else if(hoveringExpander)
+    state_type = STATE_PRELIGHT;
+  
+  if(!model_track->get_child_tracks().empty())
+    style->paint_expander (gdkWindow,
+      state_type, 
+      box, *this, "",
+      box.get_x() + expand_button_size / 2 + margin,
+      box.get_y() + box.get_height() / 2,
+      track.get_expander_style());
+
+  return Container::on_expose_event(event);
+}
+
+bool
+TimelineHeaderWidget::on_button_press_event (GdkEventButton* event)
+{
+  clickedExpander = hoveringExpander;
+  
+  return Container::on_button_press_event(event);   
+}
+
+bool
+TimelineHeaderWidget::on_button_release_event (GdkEventButton* event)
+{
+  TimelineLayoutHelper &layout = track.timelineWidget.layoutHelper;
+  
+  // Did the user release the button on an expander?
+  if(clickedExpander)
+    {
+      // Yes? The toggle the expanding
+      track.expand_collapse(track.get_expanded() ?
+        Track::Collapse : Track::Expand);
+      clickedExpander = false;
+      
+      layout.update_layout();
+    }
+  
+  return Container::on_button_release_event(event);   
+}
+
+bool
+TimelineHeaderWidget::on_motion_notify_event (GdkEventMotion* event)
+{
+  bool hovering = false;
+  
+  const Gdk::Rectangle box = get_allocation();
+  if(util::pt_in_rect(Gdk::Point(event->x, event->y),
+    Gdk::Rectangle(margin, margin,
+    expand_button_size, box.get_height() - margin * 2)))
+    hovering = true;
+    
+  if(hovering != hoveringExpander)
+    {
+      hoveringExpander = hovering;
+      queue_draw();
+    }
+  
+  return Container::on_motion_notify_event(event);  
+}
+
+void
+TimelineHeaderWidget::forall_vfunc(gboolean /* include_internals */,
+  GtkCallback callback, gpointer callback_data)
+{
+  if(widget)
+    callback(widget->gobj(), callback_data);
+}
+
+void
+TimelineHeaderWidget::on_add(Gtk::Widget* child)
+{
+  REQUIRE(child);
+  
+  if(!widget)
+    {
+      widget = child;
+      widget->set_parent(*this);
+    }
+}
+
+void
+TimelineHeaderWidget::on_remove(Gtk::Widget* child)
+{
+  REQUIRE(child);
+  
+  if(child)
+    {
+      const bool visible = child->is_visible();
+
+      if(child == widget)
+        {
+          widget = NULL;
+          child->unparent();
+
+          if(visible)
+            queue_resize();
+        }
+    }
+}
+
+GtkType
+TimelineHeaderWidget::child_type_vfunc() const
+{
+  // If there is still space for one widget, then report the type of
+  // widget that may be added.
+  if(!widget)
+    return Gtk::Widget::get_type();
+  else
+    {
+      //No more widgets may be added.
+      return G_TYPE_NONE;
+    }
+}
+
+void
+TimelineHeaderWidget::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("margin",
+    "Heading Margin",
+    "The amount of padding around each header pixels.",
+    0, G_MAXINT, 4, G_PARAM_READABLE));
+
+  gtk_widget_class_install_style_property(klass, 
+    g_param_spec_int("expand_button_size",
+    "Expand Button Size",
+    "The width of the expander button in pixels.",
+    0, G_MAXINT, 12, G_PARAM_READABLE));
+}
+
+void
+TimelineHeaderWidget::read_styles()
+{
+  get_style_property("margin", margin);
+  get_style_property("expand_button_size", expand_button_size);
+}
+
+}   // namespace timeline
+}   // namespace widgets
+}   // namespace gui
+
diff --git a/src/gui/widgets/timeline/timeline-header-widget.hpp b/src/gui/widgets/timeline/timeline-header-widget.hpp
new file mode 100644
index 000000000..93ae93b8d
--- /dev/null
+++ b/src/gui/widgets/timeline/timeline-header-widget.hpp
@@ -0,0 +1,138 @@
+/*
+  timeline-header-widget.hpp  -  Declaration of the timeline
+  header 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.
+ 
+*/
+/** @file timeline-header-widget.hpp
+ ** This file contains the definition of the header widget
+ */
+
+#ifndef HEADER_WIDGET_HPP
+#define HEADER_WIDGET_HPP
+
+#include "../../gtk-lumiera.hpp"
+
+namespace gui {  
+namespace widgets {
+namespace timeline {
+
+class Track;
+
+class TimelineHeaderWidget : public Gtk::Container
+{
+public:
+  TimelineHeaderWidget(timeline::Track &timeline_track);
+
+  void set_child_widget(Widget& child);
+
+private:
+  /* ===== Overrides ===== */
+private:
+
+  /**
+   * An event handler for the window realized signal.
+   */
+  void on_realize();
+  
+  /**
+   * An event handler for the window unrealized signal.
+   */
+  void on_unrealize();
+
+  //Overrides:
+  void on_size_request(Gtk::Requisition* requisition);
+  void on_size_allocate(Gtk::Allocation& allocation);
+  
+  /**
+   * An event handler for when the window must be redrawn.
+   */
+  bool on_expose_event(GdkEventExpose *event);
+  
+  /**
+   * An event handler for mouse button press events.
+   * @param event The GDK event containing details of the event.
+   */
+  bool on_button_press_event (GdkEventButton* event);
+  
+  /**
+   * An event handler for mouse button release events.
+   * @param event The GDK event containing details of the event.
+   */
+  bool on_button_release_event (GdkEventButton* event);
+  
+  /**
+   * An event handler for mouse movement events.
+   * @param event The GDK event containing details of the event.
+   */
+  bool on_motion_notify_event (GdkEventMotion* event);
+
+  void forall_vfunc(gboolean include_internals, GtkCallback callback, gpointer callback_data);
+
+  void on_add(Gtk::Widget* child);
+  void on_remove(Gtk::Widget* child);
+  GtkType child_type_vfunc() const;
+
+  /**
+   * Registers all the styles that this class will respond to.
+   */
+  void register_styles() const;
+  
+  /**
+   * Reads styles from the present stylesheet.
+   */
+  void read_styles();
+
+private:
+
+  timeline::Track &track;
+
+  Gtk::Widget* widget;
+  
+  bool hoveringExpander;
+  
+  bool clickedExpander;
+  
+  /**
+   * The widget's window object. 
+   **/
+  Glib::RefPtr<Gdk::Window> gdkWindow;
+  
+  //----- Style Values -----//
+  
+  /**
+   * The style value which indicates the amount of padding around each
+   * header pixels.
+   **/
+  int margin;
+  
+  /**
+   * The style value which indicates the size to draw the expand button
+   * in pixels.
+   **/
+  int expand_button_size;
+};
+
+}   // namespace timeline
+}   // namespace widgets
+}   // namespace gui
+
+#endif // HEADER_WIDGET_HPP
+
+