2 Copyright (C) 2003 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_marker_time_axis_view_h__
21 #define __ardour_marker_time_axis_view_h__
24 #include <gdkmm/color.h>
26 #include "ardour/location.h"
30 class ImageFrameView ;
33 class TimeAxisViewItem ;
36 * A view helper for handling MarkerView objects.
37 * This object is responsible for the time axis canvas view, and
38 * maintains the list of items that have been added to it
40 class MarkerTimeAxisView : public sigc::trackable
43 //---------------------------------------------------------------------------------------//
44 // Constructor / Desctructor
47 * Construct a new MarkerTimeAxisView helper time axis helper
49 * @param mta the TimeAxsiView that this objbect is the helper for
51 MarkerTimeAxisView(MarkerTimeAxis& mta) ;
55 * Reposinsibly for destroying all marker items that may have been added to this time axis view
58 ~MarkerTimeAxisView () ;
60 //---------------------------------------------------------------------------------------//
61 // Parent/Child helper object accessors
64 * Returns the TimeAxisView thatt his object is acting as a helper for
66 * @return the TimeAxisView that this object is acting as a view helper for
68 MarkerTimeAxis& trackview() { return _trackview; }
73 ArdourCanvas::Item *canvas_item() { return canvas_group; }
76 //---------------------------------------------------------------------------------------//
80 * Sets the height of the time axis view and the item upon it
82 * @param height the new height
84 int set_height(gdouble height) ;
87 * Sets the position of this view helper on the canvas
89 * @param x the x position upon the canvas
90 * @param y the y position upon the canvas
92 int set_position(gdouble x, gdouble y) ;
94 int set_samples_per_pixel (double);
97 * Returns the current samples per unit of this time axis view helper
99 * @return the current samples per unit of this time axis view helper
101 gdouble get_samples_per_pixel() { return _samples_per_pixel; }
104 * Sets the color of the items contained upon this view helper
106 * @param color the new base color
108 void apply_color(Gdk::Color& color) ;
110 //---------------------------------------------------------------------------------------//
111 // Child MarkerView Accessors/Mutators
114 * Adds a marker view to the list of items upon this time axis view helper
115 * the new MarkerView is returned
117 * @param ifv the ImageFrameView that the new item is marking up
118 * @param mark_text the text to be displayed uopn the new marker item
119 * @param mark_id the unique id of the new item
120 * @param start the position the new item should be placed upon the time line
121 * @param duration the duration the new item should be placed upon the timeline
122 * @param src the identity of the object that initiated the change
124 MarkerView* add_marker_view(ImageFrameView* ifv, std::string mark_type, std::string mark_id, nframes_t start, nframes_t dur, void* src) ;
127 * Returns the named MarkerView or 0 if the named marker does not exist
129 * @param item_id the unique id of the item to search for
130 * @return the named MarkerView, or 0 if it is not held upon this view
132 MarkerView* get_named_marker_view(std::string item_id) ;
135 * Removes the currently selected MarverView
136 * Note that this method actually destroys the MarkerView too.
137 * We assume that since we own the object, we are allowed to do this
139 * @param src the identity of the object that initiated the change
140 * @see add_marker_view
142 void remove_selected_marker_view(void* src) ;
145 * Removes and returns the named MarkerView from the list of MarkerView held by this view helper
147 * @param item_id the MarkerView unique id to remove
148 * @param src the identity of the object that initiated the change
149 * @see add_marker_view
151 MarkerView* remove_named_marker_view(std::string item_id, void* src) ;
154 * Removes mv from the list of MarkerView upon this TimeAxis
156 * @param mv the MarkerView to remove
157 * @param src the identity of the object that initiated the change
159 void remove_marker_view(MarkerView* item, void* src) ;
161 //---------------------------------------------------------------------------------------//
162 // Selected item methods
165 * Sets the currently selected item upon this time axis
167 * @param mv the item to set selected
169 void set_selected_time_axis_item(MarkerView* mv) ;
172 * Clears any selected item upon this time axis
175 void clear_selected_time_axis_item() ;
178 * Returnsthe currently selected item upon this time axis
180 * @return the currently selected item pon this time axis
182 MarkerView* get_selected_time_axis_item() ;
186 * Sets the duration of the selected MarkerView to the specified number of seconds
188 * @param sec the duration to set the MArkerView to, in seconds
190 void set_marker_duration_sec(double sec) ;
192 //---------------------------------------------------------------------------------//
195 /** Emitted when a MarkerView is Added */
196 sigc::signal<void,MarkerView*,void*> MarkerViewAdded ;
198 /** Emitted when a MarkerView Item is removed */
199 sigc::signal<void,std::string,void*> MarkerViewRemoved ;
203 * convenience method to re-get the samples per unit and tell items upon this view
206 void reset_samples_per_pixel() ;
208 /** The list of items held by this time axis view helper */
209 typedef std::list<MarkerView *> MarkerViewList ;
210 MarkerViewList marker_view_list;
212 /** the currently selected time axis item upon this time axis */
213 MarkerView* selected_time_axis_item ;
215 /* the TimeAxisView that this object is acting as the view helper for */
216 MarkerTimeAxis& _trackview ;
218 ArdourCanvas::Group *canvas_group ;
219 ArdourCanvas::Rectangle *canvas_rect; /* frame around the whole thing */
221 /** the current frames per pixel */
222 double _samples_per_pixel;
224 /* XXX why are these different? */
225 Gdk::Color region_color;
226 uint32_t stream_base_color;
228 }; /* class MarkerTimeAxisView */
230 #endif /* __ardour_marker_time_axis_view_h__ */