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.
21 #ifndef __ardour_imageframe_time_axis_view_h__
22 #define __ardour_imageframe_time_axis_view_h__
27 #include <gdkmm/color.h>
29 #include <jack/jack.h>
31 #include <libgnomecanvasmm.h>
33 #include "simplerect.h"
37 class ImageFrameTimeAxis ;
38 class ImageFrameView ;
39 class ImageFrameTimeAxisGroup ;
42 * ImageFrameTimeAxisView defines the time axis view helper
43 * This object is responsible for the time axis canvas view, and
44 * maintains the list of items that have been added to it
47 class ImageFrameTimeAxisView : public sigc::trackable
50 //---------------------------------------------------------------------------------------//
51 // Constructor / Desctructor
54 * Constructs a new ImageFrameTimeAxisView.
56 * @param ifta the parent ImageFrameTimeAxis of this view helper
58 ImageFrameTimeAxisView(ImageFrameTimeAxis& ifta) ;
62 * Responsible for destroying all items tat may have been added to this time axis
64 ~ImageFrameTimeAxisView () ;
66 //---------------------------------------------------------------------------------------//
67 // Parent/Child helper object accessors
70 * Returns the TimeAxisView thatt his object is acting as a helper for
72 * @return the TimeAxisView that this object is acting as a view helper for
74 ImageFrameTimeAxis& trackview() { return _trackview; }
79 ArdourCanvas::Group * canvas_item() { return &canvas_group; }
82 //---------------------------------------------------------------------------------------//
86 * Sets the height of the time axis view and the item upon it
88 * @param height the new height
90 int set_height(gdouble) ;
93 * Sets the position of this view helper on the canvas
95 * @param x the x position upon the canvas
96 * @param y the y position upon the canvas
98 int set_position(gdouble x, gdouble y) ;
101 * Sets the current samples per unit.
102 * this method tells each item upon the time axis of the change
104 * @param spu the new samples per canvas unit value
106 int set_samples_per_unit(gdouble spu) ;
109 * Returns the current samples per unit of this time axis view helper
111 * @return the current samples per unit of this time axis view helper
113 gdouble get_samples_per_unit() { return _samples_per_unit; }
116 * Sets the color of the items contained uopn this view helper
118 * @param color the new base color
120 void apply_color (Gdk::Color&) ;
122 //---------------------------------------------------------------------------------------//
123 // Child ImageFrameTimeAxisGroup Accessors/Mutators
126 * Adds an ImageFrameTimeAxisGroup to the list of items upon this time axis view helper
127 * the new ImageFrameTimeAxisGroup is returned
129 * @param group_id the unique id of the new group
130 * @param src the identity of the object that initiated the change
132 ImageFrameTimeAxisGroup* add_imageframe_group(std::string group_id, void* src) ;
135 * Returns the named ImageFrameTimeAxisGroup or 0 if the named group does not exist on this view helper
137 * @param group_id the unique id of the group to search for
138 * @return the named ImageFrameTimeAxisGroup, or 0 if it is not held upon this view
140 ImageFrameTimeAxisGroup* get_named_imageframe_group(std::string group_id) ;
143 * Removes and returns the named ImageFrameTimeAxisGroup from the list of ImageFrameTimeAxisGroup held by this view helper
145 * @param group_id the ImageFrameTimeAxisGroup unique id to remove
146 * @param src the identity of the object that initiated the change
147 * @see add_imageframe_group
149 ImageFrameTimeAxisGroup* remove_named_imageframe_group(std::string group_id, void* src) ;
152 * Removes the specified ImageFrameTimeAxisGroup from the list of ImageFrameTimeAxisGroups upon this TimeAxis.
154 * @param iftag the ImageFrameView to remove
156 void remove_imageframe_group(ImageFrameTimeAxisGroup* iftag, void* src) ;
159 //---------------------------------------------------------------------------------------//
160 // Selected group methods
163 * Sets the currently selected group upon this time axis
165 * @param ifv the item to set selected
167 void set_selected_imageframe_group(ImageFrameTimeAxisGroup* iftag) ;
170 * Clears the currently selected image frame group unpo this time axis
173 void clear_selected_imageframe_group() ;
176 * Returns the currently selected group upon this time axis
178 * @return the currently selected group upon this time axis
180 ImageFrameTimeAxisGroup* get_selected_imageframe_group() const ;
184 * Sets the duration of the selected ImageFrameView to the specified number of seconds
186 * @param sec the duration to set the ImageFrameView to, in seconds
188 void set_imageframe_duration_sec(double sec) ;
190 //---------------------------------------------------------------------------------------//
191 // Selected item methods
194 * Sets the currently selected image frame view item
196 * @param iftag the group the selected item is part
197 * @param ifv the selected item
199 void set_selected_imageframe_view(ImageFrameTimeAxisGroup* iftag, ImageFrameView* ifv) ;
202 * Clears the currently selected image frame view item
204 * @param clear_group set true if the selected parent group of the item should be cleared also
206 void clear_selected_imageframe_item(bool clear_group) ;
209 * Returns the currently selected image frame view item upon this time axis
211 * @return the currently selected image frame view item
213 ImageFrameView* get_selected_imageframe_view() const ;
218 * Removes the currently selected ImageFrameTimeAxisGroup
220 * @param src the identity of the object that initiated the change
221 * @see add_imageframe_group
223 void remove_selected_imageframe_item(void* src) ;
226 //---------------------------------------------------------------------------------//
229 /** Emitted when and ImageFrameGroup is added to this time axis */
230 sigc::signal<void,ImageFrameTimeAxisGroup*,void*> ImageFrameGroupAdded ;
232 /** Emitted when an ImageFrameGroup is removed from this time axis */
233 sigc::signal<void,std::string,void*> ImageFrameGroupRemoved ;
240 * convenience method to re-get the samples per unit and tell items upon this view
243 void reset_samples_per_unit() ;
246 * The list of ImageFrameViews held by this view helper */
247 typedef std::list<ImageFrameTimeAxisGroup *> ImageFrameGroupList ;
248 ImageFrameGroupList imageframe_groups ;
250 /** the currently selected time axis item upon this time axis */
251 ImageFrameTimeAxisGroup* selected_imageframe_group ;
254 * thecurrently selected image frame view
255 * we keep this here so that we only have one per view, not one per group
257 ImageFrameView* selected_imageframe_view ;
261 /* the TimeAxisView that this object is acting as the view helper for */
262 ImageFrameTimeAxis& _trackview ;
264 ArdourCanvas::Group canvas_group ;
265 ArdourCanvas::SimpleRect canvas_rect; /* frame around the whole thing */
267 /** the current samples per unit */
268 double _samples_per_unit ;
270 /* XXX why are these different? */
271 Gdk::Color region_color ;
272 uint32_t stream_base_color ;
274 } ; /* class ImageFrameTimeAxisView */
276 #endif /* __ardour_imageframe_time_axis_view_h__ */