summaryrefslogtreecommitdiff
path: root/gtk2_ardour
diff options
context:
space:
mode:
authorCarl Hetherington <carl@carlh.net>2010-04-07 11:03:00 +0000
committerCarl Hetherington <carl@carlh.net>2010-04-07 11:03:00 +0000
commit0130c1e8213bf3ec5da7e972eaa3bc8e090faa8d (patch)
tree3ea85db47dd6b94be7c9b5c2fde2e7f1b8805a1a /gtk2_ardour
parent2148c34c6a1c558174b4125323462aeb305bacbb (diff)
No-op: copy-edit comments, remove duplicate comments, coding style.
git-svn-id: svn://localhost/ardour2/branches/3.0@6870 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'gtk2_ardour')
-rw-r--r--gtk2_ardour/time_axis_view_item.cc306
-rw-r--r--gtk2_ardour/time_axis_view_item.h633
2 files changed, 312 insertions, 627 deletions
diff --git a/gtk2_ardour/time_axis_view_item.cc b/gtk2_ardour/time_axis_view_item.cc
index f36e5f4eb5..416a1741dc 100644
--- a/gtk2_ardour/time_axis_view_item.cc
+++ b/gtk2_ardour/time_axis_view_item.cc
@@ -48,26 +48,20 @@ using namespace Glib;
using namespace PBD;
using namespace ARDOUR;
-//------------------------------------------------------------------------------
-/** Initialize const static memeber data */
-
Pango::FontDescription* TimeAxisViewItem::NAME_FONT = 0;
bool TimeAxisViewItem::have_name_font = false;
const double TimeAxisViewItem::NAME_X_OFFSET = 15.0;
-const double TimeAxisViewItem::GRAB_HANDLE_LENGTH = 6 ;
+const double TimeAxisViewItem::GRAB_HANDLE_LENGTH = 6;
int TimeAxisViewItem::NAME_HEIGHT;
double TimeAxisViewItem::NAME_Y_OFFSET;
double TimeAxisViewItem::NAME_HIGHLIGHT_SIZE;
double TimeAxisViewItem::NAME_HIGHLIGHT_THRESH;
-//---------------------------------------------------------------------------------------//
-// Constructor / Desctructor
-
/**
- * Constructs a new TimeAxisViewItem.
+ * Construct a new TimeAxisViewItem.
*
- * @param it_name the unique name/Id of this item
+ * @param it_name the unique name of this item
* @param parant the parent canvas group
* @param tv the TimeAxisView we are going to be added to
* @param spu samples per unit
@@ -78,7 +72,9 @@ double TimeAxisViewItem::NAME_HIGHLIGHT_THRESH;
TimeAxisViewItem::TimeAxisViewItem(const string & it_name, ArdourCanvas::Group& parent, TimeAxisView& tv, double spu, Gdk::Color const & base_color,
nframes64_t start, nframes64_t duration, bool recording,
Visibility vis)
- : trackview (tv), _height (1.0), _recregion(recording)
+ : trackview (tv)
+ , _height (1.0)
+ , _recregion (recording)
{
if (!have_name_font) {
@@ -108,7 +104,6 @@ TimeAxisViewItem::TimeAxisViewItem(const string & it_name, ArdourCanvas::Group&
group = new ArdourCanvas::Group (parent);
init (it_name, spu, base_color, start, duration, vis, true, true);
-
}
TimeAxisViewItem::TimeAxisViewItem (const TimeAxisViewItem& other)
@@ -143,16 +138,16 @@ TimeAxisViewItem::init (
const string& it_name, double spu, Gdk::Color const & base_color, nframes64_t start, nframes64_t duration, Visibility vis, bool wide, bool high
)
{
- item_name = it_name ;
- samples_per_unit = spu ;
+ item_name = it_name;
+ samples_per_unit = spu;
should_show_selection = true;
- frame_position = start ;
- item_duration = duration ;
+ frame_position = start;
+ item_duration = duration;
name_connected = false;
fill_opacity = 60;
- position_locked = false ;
+ position_locked = false;
max_item_duration = ARDOUR::max_frames;
- min_item_duration = 0 ;
+ min_item_duration = 0;
show_vestigial = true;
visibility = vis;
_sensitive = true;
@@ -162,7 +157,7 @@ TimeAxisViewItem::init (
high_enough_for_name = high;
if (duration == 0) {
- warning << "Time Axis Item Duration == 0" << endl ;
+ warning << "Time Axis Item Duration == 0" << endl;
}
vestigial_frame = new ArdourCanvas::SimpleRect (*group, 0.0, 1.0, 2.0, trackview.current_height());
@@ -227,31 +222,26 @@ TimeAxisViewItem::init (
frame_handle_end = new ArdourCanvas::SimpleRect (*group, 0.0, TimeAxisViewItem::GRAB_HANDLE_LENGTH, 5.0, trackview.current_height());
frame_handle_end->property_outline_what() = 0x0;
- set_color (base_color) ;
+ set_color (base_color);
- set_duration (item_duration, this) ;
- set_position (start, this) ;
+ set_duration (item_duration, this);
+ set_position (start, this);
}
-/**
- * Destructor
- */
TimeAxisViewItem::~TimeAxisViewItem()
{
delete group;
}
-//---------------------------------------------------------------------------------------//
-// Position and duration Accessors/Mutators
-
/**
- * Set the position of this item upon the timeline to the specified value
+ * Set the position of this item on the timeline.
*
* @param pos the new position
* @param src the identity of the object that initiated the change
- * @return true if the position change was a success, false otherwise
+ * @return true on success
*/
+
bool
TimeAxisViewItem::set_position(nframes64_t pos, void* src, double* delta)
{
@@ -270,8 +260,8 @@ TimeAxisViewItem::set_position(nframes64_t pos, void* src, double* delta)
version of GNOME Canvas rectifies this issue cleanly.
*/
- double old_unit_pos ;
- double new_unit_pos = pos / samples_per_unit ;
+ double old_unit_pos;
+ double new_unit_pos = pos / samples_per_unit;
old_unit_pos = group->property_x();
@@ -283,16 +273,12 @@ TimeAxisViewItem::set_position(nframes64_t pos, void* src, double* delta)
(*delta) = new_unit_pos - old_unit_pos;
}
- PositionChanged (frame_position, src) ; /* EMIT_SIGNAL */
+ PositionChanged (frame_position, src); /* EMIT_SIGNAL */
return true;
}
-/**
- * Return the position of this item upon the timeline
- *
- * @return the position of this item
- */
+/** @return position of this item on the timeline */
nframes64_t
TimeAxisViewItem::get_position() const
{
@@ -300,12 +286,13 @@ TimeAxisViewItem::get_position() const
}
/**
- * Sets the duration of this item
+ * Set the duration of this item.
*
* @param dur the new duration of this item
* @param src the identity of the object that initiated the change
- * @return true if the duration change was succesful, false otherwise
+ * @return true on success
*/
+
bool
TimeAxisViewItem::set_duration (nframes64_t dur, void* src)
{
@@ -323,22 +310,19 @@ TimeAxisViewItem::set_duration (nframes64_t dur, void* src)
reset_width_dependent_items (trackview.editor().frame_to_pixel (dur));
- DurationChanged (dur, src) ; /* EMIT_SIGNAL */
+ DurationChanged (dur, src); /* EMIT_SIGNAL */
return true;
}
-/**
- * Returns the duration of this item
- *
- */
+/** @return duration of this item */
nframes64_t
TimeAxisViewItem::get_duration() const
{
- return (item_duration);
+ return item_duration;
}
/**
- * Sets the maximum duration that this item make have.
+ * Set the maximum duration that this item can have.
*
* @param dur the new maximum duration
* @param src the identity of the object that initiated the change
@@ -346,23 +330,19 @@ TimeAxisViewItem::get_duration() const
void
TimeAxisViewItem::set_max_duration(nframes64_t dur, void* src)
{
- max_item_duration = dur ;
- MaxDurationChanged(max_item_duration, src) ; /* EMIT_SIGNAL */
+ max_item_duration = dur;
+ MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
}
-/**
- * Returns the maxmimum duration that this item may be set to
- *
- * @return the maximum duration that this item may be set to
- */
+/** @return the maximum duration that this item may have */
nframes64_t
TimeAxisViewItem::get_max_duration() const
{
- return (max_item_duration) ;
+ return max_item_duration;
}
/**
- * Sets the minimu duration that this item may be set to
+ * Set the minimum duration that this item may have.
*
* @param the minimum duration that this item may be set to
* @param src the identity of the object that initiated the change
@@ -370,50 +350,41 @@ TimeAxisViewItem::get_max_duration() const
void
TimeAxisViewItem::set_min_duration(nframes64_t dur, void* src)
{
- min_item_duration = dur ;
- MinDurationChanged(max_item_duration, src) ; /* EMIT_SIGNAL */
+ min_item_duration = dur;
+ MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
}
-/**
- * Returns the minimum duration that this item mey be set to
- *
- * @return the nimum duration that this item mey be set to
- */
+/** @return the minimum duration that this item mey have */
nframes64_t
TimeAxisViewItem::get_min_duration() const
{
- return(min_item_duration) ;
+ return min_item_duration;
}
/**
- * Sets whether the position of this Item is locked to its current position
+ * Set whether this item is locked to its current position.
* Locked items cannot be moved until the item is unlocked again.
*
- * @param yn set to true to lock this item to its current position
+ * @param yn true to lock this item to its current position
* @param src the identity of the object that initiated the change
*/
void
TimeAxisViewItem::set_position_locked(bool yn, void* src)
{
- position_locked = yn ;
- set_trim_handle_colors() ;
+ position_locked = yn;
+ set_trim_handle_colors();
PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
}
-/**
- * Returns whether this item is locked to its current position
- *
- * @return true if this item is locked to its current posotion
- * false otherwise
- */
+/** @return true if this item is locked to its current position */
bool
TimeAxisViewItem::get_position_locked() const
{
- return (position_locked);
+ return position_locked;
}
/**
- * Sets whether the Maximum Duration constraint is active and should be enforced
+ * Set whether the maximum duration constraint is active.
*
* @param active set true to enforce the max duration constraint
* @param src the identity of the object that initiated the change
@@ -424,78 +395,61 @@ TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
max_duration_active = active;
}
-/**
- * Returns whether the Maximum Duration constraint is active and should be enforced
- *
- * @return true if the maximum duration constraint is active, false otherwise
- */
+/** @return true if the maximum duration constraint is active */
bool
TimeAxisViewItem::get_max_duration_active() const
{
- return(max_duration_active) ;
+ return max_duration_active;
}
/**
- * Sets whether the Minimum Duration constraint is active and should be enforced
+ * Set whether the minimum duration constraint is active.
*
* @param active set true to enforce the min duration constraint
* @param src the identity of the object that initiated the change
*/
+
void
TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
{
- min_duration_active = active ;
+ min_duration_active = active;
}
-/**
- * Returns whether the Maximum Duration constraint is active and should be enforced
- *
- * @return true if the maximum duration constraint is active, false otherwise
- */
+/** @return true if the maximum duration constraint is active */
bool
TimeAxisViewItem::get_min_duration_active() const
{
- return(min_duration_active) ;
+ return min_duration_active;
}
-//---------------------------------------------------------------------------------------//
-// Name/Id Accessors/Mutators
-
/**
- * Set the name/Id of this item.
+ * Set the name of this item.
*
* @param new_name the new name of this item
* @param src the identity of the object that initiated the change
*/
+
void
TimeAxisViewItem::set_item_name(std::string new_name, void* src)
{
if (new_name != item_name) {
- std::string temp_name = item_name ;
- item_name = new_name ;
- NameChanged (item_name, temp_name, src) ; /* EMIT_SIGNAL */
+ std::string temp_name = item_name;
+ item_name = new_name;
+ NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
}
}
-/**
- * Returns the name/id of this item
- *
- * @return the name/id of this item
- */
+/** @return the name of this item */
std::string
TimeAxisViewItem::get_item_name() const
{
- return(item_name) ;
+ return item_name;
}
-//---------------------------------------------------------------------------------------//
-// Selection Methods
-
/**
- * Set to true to indicate that this item is currently selected
+ * Set selection status.
*
* @param yn true if this item is currently selected
- * @param src the identity of the object that initiated the change
*/
void
TimeAxisViewItem::set_selected(bool yn)
@@ -506,6 +460,12 @@ TimeAxisViewItem::set_selected(bool yn)
}
}
+/**
+ * Set whether an item should show its selection status.
+ *
+ * @param yn true if this item should show its selected status
+ */
+
void
TimeAxisViewItem::set_should_show_selection (bool yn)
{
@@ -515,28 +475,20 @@ TimeAxisViewItem::set_should_show_selection (bool yn)
}
}
-//---------------------------------------------------------------------------------------//
-// Parent Componenet Methods
-
-/**
- * Returns the TimeAxisView that this item is upon
- *
- * @return the timeAxisView that this item is placed upon
- */
+/** @return the TimeAxisView that this item is on */
TimeAxisView&
TimeAxisViewItem::get_time_axis_view()
{
return trackview;
}
-//---------------------------------------------------------------------------------------//
-// ui methods & data
/**
- * Sets the displayed item text
- * This item is the visual text name displayed on the canvas item, this can be different to the name of the item
+ * Set the displayed item text.
+ * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
*
* @param new_name the new name text to display
*/
+
void
TimeAxisViewItem::set_name_text(const ustring& new_name)
{
@@ -551,9 +503,9 @@ TimeAxisViewItem::set_name_text(const ustring& new_name)
/**
- * Set the height of this item
+ * Set the height of this item.
*
- * @param h the new height
+ * @param h new height
*/
void
TimeAxisViewItem::set_height (double height)
@@ -596,9 +548,6 @@ TimeAxisViewItem::set_height (double height)
update_name_pixbuf_visibility ();
}
-/**
- *
- */
void
TimeAxisViewItem::set_color (Gdk::Color const & base_color)
{
@@ -606,60 +555,48 @@ TimeAxisViewItem::set_color (Gdk::Color const & base_color)
set_colors ();
}
-/**
- *
- */
ArdourCanvas::Item*
TimeAxisViewItem::get_canvas_frame()
{
- return(frame) ;
+ return frame;
}
-/**
- *
- */
ArdourCanvas::Group*
TimeAxisViewItem::get_canvas_group()
{
- return (group) ;
+ return group;
}
-/**
- *
- */
ArdourCanvas::Item*
TimeAxisViewItem::get_name_highlight()
{
- return (name_highlight) ;
+ return name_highlight;
}
-/**
- *
- */
ArdourCanvas::Pixbuf*
TimeAxisViewItem::get_name_pixbuf()
{
- return (name_pixbuf) ;
+ return name_pixbuf;
}
/**
- * Calculates some contrasting color for displaying various parts of this item, based upon the base color
+ * Calculate some contrasting color for displaying various parts of this item, based upon the base color.
*
* @param color the base color of the item
*/
void
TimeAxisViewItem::compute_colors (Gdk::Color const & base_color)
{
- unsigned char radius ;
- char minor_shift ;
+ unsigned char radius;
+ char minor_shift;
- unsigned char r,g,b ;
+ unsigned char r,g,b;
/* FILL: this is simple */
- r = base_color.get_red()/256 ;
- g = base_color.get_green()/256 ;
- b = base_color.get_blue()/256 ;
- fill_color = RGBA_TO_UINT(r,g,b,160) ;
+ r = base_color.get_red()/256;
+ g = base_color.get_green()/256;
+ b = base_color.get_blue()/256;
+ fill_color = RGBA_TO_UINT(r,g,b,160);
/* for minor colors:
if the overall saturation is strong, make the minor colors light.
@@ -669,8 +606,8 @@ TimeAxisViewItem::compute_colors (Gdk::Color const & base_color)
central circle in the color wheel from where we started.
*/
- radius = (unsigned char) rint (floor (sqrt (static_cast<double>(r*r + g*g + b+b))/3.0f)) ;
- minor_shift = 125 - radius ;
+ radius = (unsigned char) rint (floor (sqrt (static_cast<double>(r*r + g*g + b+b))/3.0f));
+ minor_shift = 125 - radius;
/* LABEL: rotate around color wheel by 120 degrees anti-clockwise */
@@ -710,14 +647,14 @@ TimeAxisViewItem::compute_colors (Gdk::Color const & base_color)
g += minor_shift;
label_color = RGBA_TO_UINT(r,g,b,255);
- r = (base_color.get_red()/256) + 127 ;
- g = (base_color.get_green()/256) + 127 ;
- b = (base_color.get_blue()/256) + 127 ;
+ r = (base_color.get_red()/256) + 127;
+ g = (base_color.get_green()/256) + 127;
+ b = (base_color.get_blue()/256) + 127;
label_color = RGBA_TO_UINT(r,g,b,255);
/* XXX can we do better than this ? */
- /* We're trying ;) */
+ /* We're trying;) */
/* NUKECOLORS */
//frame_color_r = 192;
@@ -728,10 +665,10 @@ TimeAxisViewItem::compute_colors (Gdk::Color const & base_color)
//selected_frame_color_g = 145;
//selected_frame_color_b = 168;
- //handle_color_r = 25 ;
- //handle_color_g = 0 ;
- //handle_color_b = 255 ;
- //lock_handle_color_r = 235 ;
+ //handle_color_r = 25;
+ //handle_color_g = 0;
+ //handle_color_b = 255;
+ //lock_handle_color_r = 235;
//lock_handle_color_g = 16;
//lock_handle_color_b = 16;
}
@@ -742,13 +679,13 @@ TimeAxisViewItem::compute_colors (Gdk::Color const & base_color)
void
TimeAxisViewItem::set_colors()
{
- set_frame_color() ;
+ set_frame_color();
if (name_highlight) {
name_highlight->property_fill_color_rgba() = fill_color;
name_highlight->property_outline_color_rgba() = fill_color;
}
- set_trim_handle_colors() ;
+ set_trim_handle_colors();
}
/**
@@ -776,8 +713,7 @@ TimeAxisViewItem::set_frame_color()
}
/**
- * Sets the colors of the start and end trim handle depending on object state
- *
+ * Set the colors of the start and end trim handle depending on object state
*/
void
TimeAxisViewItem::set_trim_handle_colors()
@@ -793,16 +729,24 @@ TimeAxisViewItem::set_trim_handle_colors()
}
}
+/** @return the samples per unit of this item */
double
TimeAxisViewItem::get_samples_per_unit()
{
- return(samples_per_unit) ;
+ return samples_per_unit;
}
+/**
+ * Set the samples per unit of this item.
+ * This item is used to determine the relative visual size and position of this item
+ * based upon its duration and start value.
+ *
+ * @param spu the new samples per unit value
+ */
void
TimeAxisViewItem::set_samples_per_unit (double spu)
{
- samples_per_unit = spu ;
+ samples_per_unit = spu;
set_position (this->get_position(), this);
reset_width_dependent_items ((double)get_duration() / samples_per_unit);
}
@@ -923,42 +867,18 @@ TimeAxisViewItem::reset_name_width (double /*pixel_width*/)
}
}
-
-//---------------------------------------------------------------------------------------//
-// Handle time axis removal
-
-/**
- * Handles the Removal of this time axis item
- * This _needs_ to be called to alert others of the removal properly, ie where the source
- * of the removal came from.
- *
- * XXX Although im not too happy about this method of doing things, I cant think of a cleaner method
- * just now to capture the source of the removal
- *
- * @param src the identity of the object that initiated the change
- */
-void
-TimeAxisViewItem::remove_this_item(void* src)
-{
- /*
- defer to idle loop, otherwise we'll delete this object
- while we're still inside this function ...
- */
- Glib::signal_idle().connect(sigc::bind (sigc::ptr_fun (&TimeAxisViewItem::idle_remove_this_item), this, src));
-}
-
/**
- * Callback used to remove this time axis item during the gtk idle loop
+ * Callback used to remove this time axis item during the gtk idle loop.
* This is used to avoid deleting the obejct while inside the remove_this_item
- * method
+ * method.
*
- * @param item the TimeAxisViewItem to remove
- * @param src the identity of the object that initiated the change
+ * @param item the TimeAxisViewItem to remove.
+ * @param src the identity of the object that initiated the change.
*/
gint
TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
{
- item->ItemRemoved (item->get_item_name(), src) ; /* EMIT_SIGNAL */
+ item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
delete item;
item = 0;
return false;
diff --git a/gtk2_ardour/time_axis_view_item.h b/gtk2_ardour/time_axis_view_item.h
index 0c4d5a3291..390b3ee2f5 100644
--- a/gtk2_ardour/time_axis_view_item.h
+++ b/gtk2_ardour/time_axis_view_item.h
@@ -20,7 +20,6 @@
#ifndef __gtk_ardour_time_axis_view_item_h__
#define __gtk_ardour_time_axis_view_item_h__
-#include <jack/jack.h>
#include <string>
#include <libgnomecanvasmm/pixbuf.h>
@@ -34,443 +33,209 @@
class TimeAxisView;
/**
- * A base class for 'items' that may appear upon a TimeAxisView
- *
+ * Base class for items that may appear upon a TimeAxisView.
*/
+
class TimeAxisViewItem : public Selectable, public PBD::ScopedConnectionList
{
public:
- virtual ~TimeAxisViewItem() ;
-
- /**
- * Set the position of this item upon the timeline to the specified value
- *
- * @param pos the new position
- * @param src the identity of the object that initiated the change
- * @return true if the position change was a success, false otherwise
- */
- virtual bool set_position(nframes64_t pos, void* src, double* delta = 0) ;
-
- /**
- * Return the position of this item upon the timeline
- *
- * @return the position of this item
- */
- nframes64_t get_position() const ;
-
- /**
- * Sets the duration of this item
- *
- * @param dur the new duration of this item
- * @param src the identity of the object that initiated the change
- * @return true if the duration change was succesful, false otherwise
- */
- virtual bool set_duration(nframes64_t dur, void* src) ;
-
- /**
- * Returns the duration of this item
- *
- */
- nframes64_t get_duration() const ;
-
- /**
- * Sets the maximum duration that this item make have.
- *
- * @param dur the new maximum duration
- * @param src the identity of the object that initiated the change
- */
- virtual void set_max_duration(nframes64_t dur, void* src) ;
-
- /**
- * Returns the maxmimum duration that this item may be set to
- *
- * @return the maximum duration that this item may be set to
- */
- nframes64_t get_max_duration() const ;
-
- /**
- * Sets the minimu duration that this item may be set to
- *
- * @param the minimum duration that this item may be set to
- * @param src the identity of the object that initiated the change
- */
- virtual void set_min_duration(nframes64_t dur, void* src) ;
-
- /**
- * Returns the minimum duration that this item mey be set to
- *
- * @return the nimum duration that this item mey be set to
- */
- nframes64_t get_min_duration() const ;
-
- /**
- * Sets whether the position of this Item is locked to its current position
- * Locked items cannot be moved until the item is unlocked again.
- *
- * @param yn set to true to lock this item to its current position
- * @param src the identity of the object that initiated the change
- */
- virtual void set_position_locked(bool yn, void* src) ;
-
- /**
- * Returns whether this item is locked to its current position
- *
- * @return true if this item is locked to its current posotion
- * false otherwise
- */
- bool get_position_locked() const ;
-
- /**
- * Sets whether the Maximum Duration constraint is active and should be enforced
- *
- * @param active set true to enforce the max duration constraint
- * @param src the identity of the object that initiated the change
- */
- void set_max_duration_active(bool active, void* src) ;
-
- /**
- * Returns whether the Maximum Duration constraint is active and should be enforced
- *
- * @return true if the maximum duration constraint is active, false otherwise
- */
- bool get_max_duration_active() const ;
-
- /**
- * Sets whether the Minimum Duration constraint is active and should be enforced
- *
- * @param active set true to enforce the min duration constraint
- * @param src the identity of the object that initiated the change
- */
- void set_min_duration_active(bool active, void* src) ;
-
- /**
- * Returns whether the Maximum Duration constraint is active and should be enforced
- *
- * @return true if the maximum duration constraint is active, false otherwise
- */
- bool get_min_duration_active() const ;
-
- /**
- * Set the name/Id of this item.
- *
- * @param new_name the new name of this item
- * @param src the identity of the object that initiated the change
- */
- void set_item_name(std::string new_name, void* src) ;
-
- /**
- * Returns the name/id of this item
- *
- * @return the name/id of this item
- */
- virtual std::string get_item_name() const ;
-
- /**
- * Set to true to indicate that this item is currently selected
- *
- * @param yn true if this item is currently selected
- */
- virtual void set_selected(bool yn) ;
-
- /**
- * Set to true to indicate that this item should show its selection status
- *
- * @param yn true if this item should show its selected status
- */
- virtual void set_should_show_selection (bool yn) ;
-
- void set_sensitive (bool yn) { _sensitive = yn; }
- bool sensitive () const { return _sensitive; }
-
- //---------------------------------------------------------------------------------------//
- // Parent Component Methods
-
- /**
- * Returns the TimeAxisView that this item is upon
- *
- * @return the timeAxisView that this item is placed upon
- */
- TimeAxisView& get_time_axis_view() ;
-
- //---------------------------------------------------------------------------------------//
- // ui methods & data
-
- /**
- * Sets the displayed item text
- * This item is the visual text name displayed on the canvas item, this can be different to the name of the item
- *
- * @param new_name the new name text to display
- */
- void set_name_text(const Glib::ustring& new_name) ;
-
- /**
- * Set the height of this item
- *
- * @param h the new height
- */
- virtual void set_height(double h) ;
-
- void set_y (double);
-
- /**
- *
- */
- void set_color (Gdk::Color const &);
-
- /**
- *
- */
- ArdourCanvas::Item* get_canvas_frame() ;
-
- /**
- *
- */
- ArdourCanvas::Group* get_canvas_group();
-
- /**
- *
- */
- ArdourCanvas::Item* get_name_highlight();
-
- /**
- *
- */
- ArdourCanvas::Pixbuf* get_name_pixbuf();
-
-
- /**
- * Returns the time axis that this item is upon
- */
- TimeAxisView& get_trackview() const { return trackview; }
-
- /**
- * Sets the samples per unit of this item.
- * this item is used to determine the relative visual size and position of this item
- * based upon its duration and start value.
- *
- * @param spu the new samples per unit value
- */
- virtual void set_samples_per_unit(double spu) ;
-
- /**
- * Returns the current samples per unit of this item
- *
- * @return the samples per unit of this item
- */
- double get_samples_per_unit() ;
-
- virtual void raise () { return; }
- virtual void raise_to_top () { return; }
- virtual void lower () { return; }
- virtual void lower_to_bottom () { return; }
-
- /**
- * returns true if the name area should respond to events.
- */
- bool name_active() const { return name_connected; }
-
- // Default sizes, font and spacing
- static Pango::FontDescription* NAME_FONT ;
- static bool have_name_font;
- static const double NAME_X_OFFSET ;
- static const double GRAB_HANDLE_LENGTH ;
- /* these are not constant, but vary with the pixel size
- of the font used to display the item name.
- */
- static int NAME_HEIGHT;
- static double NAME_Y_OFFSET ;
- static double NAME_HIGHLIGHT_SIZE ;
- static double NAME_HIGHLIGHT_THRESH ;
-
- /**
- * Handles the Removal of this time axis item
- * This _needs_ to be called to alert others of the removal properly, ie where the source
- * of the removal came from.
- *
- * XXX Although im not too happy about this method of doing things, I cant think of a cleaner method
- * just now to capture the source of the removal
- *
- * @param src the identity of the object that initiated the change
- */
- virtual void remove_this_item(void* src) ;
-
- /**
- * Emitted when this Group has been removed
- * This is different to the CatchDeletion signal in that this signal
- * is emitted during the deletion of this Time Axis, and not during
- * the destructor, this allows us to capture the source of the deletion
- * event
- */
-
- sigc::signal<void,std::string,void*> ItemRemoved ;
-
- /** Emitted when the name/Id of this item is changed */
- sigc::signal<void,std::string,std::string,void*> NameChanged ;
-
- /** Emiited when the position of this item changes */
- sigc::signal<void,nframes64_t,void*> PositionChanged ;
-
- /** Emitted when the position lock of this item is changed */
- sigc::signal<void,bool,void*> PositionLockChanged ;
-
- /** Emitted when the duration of this item changes */
- sigc::signal<void,nframes64_t,void*> DurationChanged ;
-
- /** Emitted when the maximum item duration is changed */
- sigc::signal<void,nframes64_t,void*> MaxDurationChanged ;
-
- /** Emitted when the mionimum item duration is changed */
- sigc::signal<void,nframes64_t,void*> MinDurationChanged ;
-
- enum Visibility {
- ShowFrame = 0x1,
- ShowNameHighlight = 0x2,
- ShowNameText = 0x4,
- ShowHandles = 0x8,
- HideFrameLeft = 0x10,
- HideFrameRight = 0x20,
- HideFrameTB = 0x40,
- FullWidthNameHighlight = 0x80
- };
- protected:
- /**
- * Constructs a new TimeAxisViewItem.
- *
- * @param it_name the unique name/Id of this item
- * @param parent the parent canvas group
- * @param tv the TimeAxisView we are going to be added to
- * @param spu samples per unit
- * @param base_color
- * @param start the start point of this item
- * @param duration the duration of this item
- */
- TimeAxisViewItem(const std::string & it_name, ArdourCanvas::Group& parent, TimeAxisView& tv, double spu, Gdk::Color const & base_color,
- nframes64_t start, nframes64_t duration, bool recording = false, Visibility v = Visibility (0));
-
- TimeAxisViewItem (const TimeAxisViewItem& other);
-
- void init (const std::string& it_name, double spu, Gdk::Color const & base_color, nframes64_t start, nframes64_t duration, Visibility vis, bool, bool);
-
- /**
- * Calculates some contrasting color for displaying various parts of this item, based upon the base color
- *
- * @param color the base color of the item
- */
- virtual void compute_colors (Gdk::Color const & color);
-
- /**
- * convenience method to set the various canvas item colors
- */
- virtual void set_colors() ;
-
- /**
- * Sets the frame color depending on whether this item is selected
- */
- virtual void set_frame_color() ;
-
- /**
- * Sets the colors of the start and end trim handle depending on object state
- *
- */
- void set_trim_handle_colors() ;
-
- virtual void reset_width_dependent_items (double pixel_width);
- void reset_name_width (double pixel_width);
- void update_name_pixbuf_visibility ();
-
- /**
- * Callback used to remove this item during the gtk idle loop
- * This is used to avoid deleting the obejct while inside the remove_this_group
- * method
- *
- * @param item the time axis item to remove
- * @param src the identity of the object that initiated the change
- */
- static gint idle_remove_this_item(TimeAxisViewItem* item, void* src) ;
-
- /** The time axis that this item is upon */
- TimeAxisView& trackview ;
-
- /** indicates whether this item is locked to its current position */
- bool position_locked ;
-
- /** The posotion of this item on the timeline */
- nframes64_t frame_position ;
-
- /** the duration of this item upon the timeline */
- nframes64_t item_duration ;
-
- /** the maximum duration that we allow this item to take */
- nframes64_t max_item_duration ;
-
- /** the minimu duration that we allow this item to take */
- nframes64_t min_item_duration ;
-
- /** indicates whether this Max Duration constraint is active */
- bool max_duration_active ;
-
- /** indicates whether this Min Duration constraint is active */
- bool min_duration_active ;
-
- /** the curretn samples per canvas unit */
- double samples_per_unit ;
-
- /** should the item show its selected status */
- bool should_show_selection;
-
- /** should the item respond to events */
- bool _sensitive;
-
- /**
- * The unique item name of this Item
- * Each item upon a time axis must have a unique id
- */
- std::string item_name ;
-
- /**
- * true if the name should respond to events
- */
- bool name_connected;
-
- /**
- * true if a small vestigial rect should be shown when the item gets very narrow
- */
-
- bool show_vestigial;
-
- uint32_t fill_opacity;
- uint32_t fill_color ;
- uint32_t frame_color_r ;
- uint32_t frame_color_g ;
- uint32_t frame_color_b ;
- uint32_t selected_frame_color_r ;
- uint32_t selected_frame_color_g ;
- uint32_t selected_frame_color_b ;
- uint32_t label_color ;
-
- uint32_t handle_color_r ;
- uint32_t handle_color_g ;
- uint32_t handle_color_b ;
- uint32_t lock_handle_color_r ;
- uint32_t lock_handle_color_g ;
- uint32_t lock_handle_color_b ;
- uint32_t last_item_width;
- int name_pixbuf_width;
- bool wide_enough_for_name;
- bool high_enough_for_name;
-
- ArdourCanvas::Group* group;
- ArdourCanvas::SimpleRect* vestigial_frame;
- ArdourCanvas::SimpleRect* frame;
- ArdourCanvas::Pixbuf* name_pixbuf;
- ArdourCanvas::SimpleRect* name_highlight;
- ArdourCanvas::SimpleRect* frame_handle_start;
- ArdourCanvas::SimpleRect* frame_handle_end;
-
- double _height;
- Visibility visibility;
- bool _recregion;
-
+ virtual ~TimeAxisViewItem();
+
+ virtual bool set_position(nframes64_t, void*, double* delta = 0);
+ nframes64_t get_position() const;
+ virtual bool set_duration(nframes64_t, void*);
+ nframes64_t get_duration() const;
+ virtual void set_max_duration(nframes64_t, void*);
+ nframes64_t get_max_duration() const;
+ virtual void set_min_duration(nframes64_t, void*);
+ nframes64_t get_min_duration() const;
+ virtual void set_position_locked(bool, void*);
+ bool get_position_locked() const;
+ void set_max_duration_active(bool, void*);
+ bool get_max_duration_active() const;
+ void set_min_duration_active(bool, void*);
+ bool get_min_duration_active() const;
+ void set_item_name(std::string, void*);
+ virtual std::string get_item_name() const;
+ virtual void set_selected(bool yn);
+ virtual void set_should_show_selection (bool yn);
+ void set_sensitive (bool yn) { _sensitive = yn; }
+ bool sensitive () const { return _sensitive; }
+ TimeAxisView& get_time_axis_view();
+ void set_name_text(const Glib::ustring&);
+ virtual void set_height(double h);
+ void set_y (double);
+ void set_color (Gdk::Color const &);
+
+ ArdourCanvas::Item* get_canvas_frame();
+ ArdourCanvas::Group* get_canvas_group();
+ ArdourCanvas::Item* get_name_highlight();
+ ArdourCanvas::Pixbuf* get_name_pixbuf();
+
+ TimeAxisView& get_trackview() const { return trackview; }
+
+ virtual void set_samples_per_unit(double spu);
+
+ double get_samples_per_unit();
+
+ virtual void raise () { return; }
+ virtual void raise_to_top () { return; }
+ virtual void lower () { return; }
+ virtual void lower_to_bottom () { return; }
+
+ /** @return true if the name area should respond to events */
+ bool name_active() const { return name_connected; }
+
+ // Default sizes, font and spacing
+ static Pango::FontDescription* NAME_FONT;
+ static bool have_name_font;
+ static const double NAME_X_OFFSET;
+ static const double GRAB_HANDLE_LENGTH;
+
+ /* these are not constant, but vary with the pixel size
+ of the font used to display the item name.
+ */
+ static int NAME_HEIGHT;
+ static double NAME_Y_OFFSET;
+ static double NAME_HIGHLIGHT_SIZE;
+ static double NAME_HIGHLIGHT_THRESH;
+
+ /**
+ * Emitted when this Group has been removed.
+ * This is different to the CatchDeletion signal in that this signal
+ * is emitted during the deletion of this Time Axis, and not during
+ * the destructor, this allows us to capture the source of the deletion
+ * event
+ */
+
+ sigc::signal<void,std::string,void*> ItemRemoved;
+
+ /** Emitted when the name of this item is changed */
+ sigc::signal<void,std::string,std::string,void*> NameChanged;
+
+ /** Emiited when the position of this item changes */
+ sigc::signal<void,nframes64_t,void*> PositionChanged;
+
+ /** Emitted when the position lock of this item is changed */
+ sigc::signal<void,bool,void*> PositionLockChanged;
+
+ /** Emitted when the duration of this item changes */
+ sigc::signal<void,nframes64_t,void*> DurationChanged;
+
+ /** Emitted when the maximum item duration is changed */
+ sigc::signal<void,nframes64_t,void*> MaxDurationChanged;
+
+ /** Emitted when the mionimum item duration is changed */
+ sigc::signal<void,nframes64_t,void*> MinDurationChanged;
+
+ enum Visibility {
+ ShowFrame = 0x1,
+ ShowNameHighlight = 0x2,
+ ShowNameText = 0x4,
+ ShowHandles = 0x8,
+ HideFrameLeft = 0x10,
+ HideFrameRight = 0x20,
+ HideFrameTB = 0x40,
+ FullWidthNameHighlight = 0x80
+ };
+
+protected:
+ TimeAxisViewItem(const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, Gdk::Color const &,
+ nframes64_t, nframes64_t, bool recording = false, Visibility v = Visibility (0));
+
+ TimeAxisViewItem (const TimeAxisViewItem&);
+
+ void init (const std::string&, double, Gdk::Color const &, nframes64_t, nframes64_t, Visibility, bool, bool);
+
+ virtual void compute_colors (Gdk::Color const &);
+ virtual void set_colors();
+ virtual void set_frame_color();
+ void set_trim_handle_colors();
+
+ virtual void reset_width_dependent_items (double);
+ void reset_name_width (double);
+ void update_name_pixbuf_visibility ();
+
+ static gint idle_remove_this_item(TimeAxisViewItem*, void*);
+
+ /** time axis that this item is on */
+ TimeAxisView& trackview;
+
+ /** indicates whether this item is locked to its current position */
+ bool position_locked;
+
+ /** position of this item on the timeline */
+ nframes64_t frame_position;
+
+ /** duration of this item upon the timeline */
+ nframes64_t item_duration;
+
+ /** maximum duration that this item can have */
+ nframes64_t max_item_duration;
+
+ /** minimum duration that this item can have */
+ nframes64_t min_item_duration;
+
+ /** indicates whether the max duration constraint is active */
+ bool max_duration_active;
+
+ /** indicates whether the min duration constraint is active */
+ bool min_duration_active;
+
+ /** samples per canvas unit */
+ double samples_per_unit;
+
+ /** should the item show its selected status */
+ bool should_show_selection;
+
+ /** should the item respond to events */
+ bool _sensitive;
+
+ /**
+ * The unique item name of this Item.
+ * Each item upon a time axis must have a unique id.
+ */
+ std::string item_name;
+
+ /** true if the name should respond to events */
+ bool name_connected;
+
+ /** true if a small vestigial rect should be shown when the item gets very narrow */
+ bool show_vestigial;
+
+ uint32_t fill_opacity;
+ uint32_t fill_color;
+ uint32_t frame_color_r;
+ uint32_t frame_color_g;
+ uint32_t frame_color_b;
+ uint32_t selected_frame_color_r;
+ uint32_t selected_frame_color_g;
+ uint32_t selected_frame_color_b;
+ uint32_t label_color;
+
+ uint32_t handle_color_r;
+ uint32_t handle_color_g;
+ uint32_t handle_color_b;
+ uint32_t lock_handle_color_r;
+ uint32_t lock_handle_color_g;
+ uint32_t lock_handle_color_b;
+ uint32_t last_item_width;
+ int name_pixbuf_width;
+ bool wide_enough_for_name;
+ bool high_enough_for_name;
+
+ ArdourCanvas::Group* group;
+ ArdourCanvas::SimpleRect* vestigial_frame;
+ ArdourCanvas::SimpleRect* frame;
+ ArdourCanvas::Pixbuf* name_pixbuf;
+ ArdourCanvas::SimpleRect* name_highlight;
+ ArdourCanvas::SimpleRect* frame_handle_start;
+ ArdourCanvas::SimpleRect* frame_handle_end;
+
+ double _height;
+ Visibility visibility;
+ bool _recregion;
+
}; /* class TimeAxisViewItem */
#endif /* __gtk_ardour_time_axis_view_item_h__ */