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 __gtk_ardour_time_axis_view_item_h__
21 #define __gtk_ardour_time_axis_view_item_h__
25 #include <libgnomecanvasmm/pixbuf.h>
27 #include "pbd/signals.h"
29 #include "selectable.h"
30 #include "simplerect.h"
35 using ARDOUR::framepos_t;
36 using ARDOUR::framecnt_t;
39 * Base class for items that may appear upon a TimeAxisView.
42 class TimeAxisViewItem : public Selectable, public PBD::ScopedConnectionList
45 virtual ~TimeAxisViewItem();
47 virtual bool set_position(framepos_t, void*, double* delta = 0);
48 framepos_t get_position() const;
49 virtual bool set_duration(framecnt_t, void*);
50 framecnt_t get_duration() const;
51 virtual void set_max_duration(framecnt_t, void*);
52 framecnt_t get_max_duration() const;
53 virtual void set_min_duration(framecnt_t, void*);
54 framecnt_t get_min_duration() const;
55 virtual void set_position_locked(bool, void*);
56 bool get_position_locked() const;
57 void set_max_duration_active(bool, void*);
58 bool get_max_duration_active() const;
59 void set_min_duration_active(bool, void*);
60 bool get_min_duration_active() const;
61 void set_item_name(std::string, void*);
62 virtual std::string get_item_name() const;
63 virtual void set_selected(bool yn);
64 void set_sensitive (bool yn) { _sensitive = yn; }
65 bool sensitive () const { return _sensitive; }
66 TimeAxisView& get_time_axis_view () const;
67 void set_name_text(const std::string&);
68 virtual void set_height(double h);
70 void set_color (Gdk::Color const &);
72 ArdourCanvas::Item* get_canvas_frame();
73 ArdourCanvas::Group* get_canvas_group();
74 ArdourCanvas::Item* get_name_highlight();
75 ArdourCanvas::Pixbuf* get_name_pixbuf();
77 virtual void set_samples_per_unit(double spu);
79 double get_samples_per_unit();
81 virtual void raise () { return; }
82 virtual void raise_to_top () { return; }
83 virtual void lower () { return; }
84 virtual void lower_to_bottom () { return; }
86 /** @return true if the name area should respond to events */
87 bool name_active() const { return name_connected; }
89 // Default sizes, font and spacing
90 static Pango::FontDescription* NAME_FONT;
91 static void set_constant_heights ();
92 static const double NAME_X_OFFSET;
93 static const double GRAB_HANDLE_LENGTH;
95 /* these are not constant, but vary with the pixel size
96 of the font used to display the item name.
98 static int NAME_HEIGHT;
99 static double NAME_Y_OFFSET;
100 static double NAME_HIGHLIGHT_SIZE;
101 static double NAME_HIGHLIGHT_THRESH;
104 * Emitted when this Group has been removed.
105 * This is different to the CatchDeletion signal in that this signal
106 * is emitted during the deletion of this Time Axis, and not during
107 * the destructor, this allows us to capture the source of the deletion
111 sigc::signal<void,std::string,void*> ItemRemoved;
113 /** Emitted when the name of this item is changed */
114 sigc::signal<void,std::string,std::string,void*> NameChanged;
116 /** Emiited when the position of this item changes */
117 sigc::signal<void,framepos_t,void*> PositionChanged;
119 /** Emitted when the position lock of this item is changed */
120 sigc::signal<void,bool,void*> PositionLockChanged;
122 /** Emitted when the duration of this item changes */
123 sigc::signal<void,framecnt_t,void*> DurationChanged;
125 /** Emitted when the maximum item duration is changed */
126 sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
128 /** Emitted when the mionimum item duration is changed */
129 sigc::signal<void,framecnt_t,void*> MinDurationChanged;
133 ShowNameHighlight = 0x2,
136 HideFrameLeft = 0x10,
137 HideFrameRight = 0x20,
139 FullWidthNameHighlight = 0x80
143 TimeAxisViewItem(const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, Gdk::Color const &,
144 framepos_t, framepos_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
146 TimeAxisViewItem (const TimeAxisViewItem&);
148 void init (const std::string&, double, Gdk::Color const &, framepos_t, framepos_t, Visibility, bool, bool);
150 virtual void compute_colors (Gdk::Color const &);
151 virtual void set_colors();
152 virtual void set_frame_color();
153 void set_trim_handle_colors();
155 virtual void reset_width_dependent_items (double);
156 void reset_name_width (double);
157 void update_name_pixbuf_visibility ();
159 static gint idle_remove_this_item(TimeAxisViewItem*, void*);
161 /** time axis that this item is on */
162 TimeAxisView& trackview;
164 /** indicates whether this item is locked to its current position */
165 bool position_locked;
167 /** position of this item on the timeline */
168 framepos_t frame_position;
170 /** duration of this item upon the timeline */
171 framecnt_t item_duration;
173 /** maximum duration that this item can have */
174 framecnt_t max_item_duration;
176 /** minimum duration that this item can have */
177 framecnt_t min_item_duration;
179 /** indicates whether the max duration constraint is active */
180 bool max_duration_active;
182 /** indicates whether the min duration constraint is active */
183 bool min_duration_active;
185 /** samples per canvas unit */
186 double samples_per_unit;
188 /** should the item respond to events */
192 * The unique item name of this Item.
193 * Each item upon a time axis must have a unique id.
195 std::string item_name;
197 /** true if the name should respond to events */
200 /** true if a small vestigial rect should be shown when the item gets very narrow */
203 uint32_t fill_opacity;
205 uint32_t frame_color_r;
206 uint32_t frame_color_g;
207 uint32_t frame_color_b;
208 uint32_t selected_frame_color_r;
209 uint32_t selected_frame_color_g;
210 uint32_t selected_frame_color_b;
211 uint32_t label_color;
213 uint32_t handle_color_r;
214 uint32_t handle_color_g;
215 uint32_t handle_color_b;
216 uint32_t lock_handle_color_r;
217 uint32_t lock_handle_color_g;
218 uint32_t lock_handle_color_b;
219 uint32_t last_item_width;
220 int name_pixbuf_width;
221 bool wide_enough_for_name;
222 bool high_enough_for_name;
224 ArdourCanvas::Group* group;
225 ArdourCanvas::SimpleRect* vestigial_frame;
226 ArdourCanvas::SimpleRect* frame;
227 ArdourCanvas::Pixbuf* name_pixbuf;
228 ArdourCanvas::SimpleRect* name_highlight;
230 /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
231 ArdourCanvas::SimpleRect* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
232 ArdourCanvas::SimpleRect* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
235 Visibility visibility;
237 bool _automation; ///< true if this is an automation region view
241 void parameter_changed (std::string);
243 }; /* class TimeAxisViewItem */
245 #endif /* __gtk_ardour_time_axis_view_item_h__ */