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 <gdkmm/color.h>
26 #include <pangomm/fontdescription.h>
27 #include "pbd/signals.h"
28 #include "selectable.h"
32 namespace ArdourCanvas {
40 using ARDOUR::framepos_t;
41 using ARDOUR::framecnt_t;
44 * Base class for items that may appear upon a TimeAxisView.
47 class TimeAxisViewItem : public Selectable, public PBD::ScopedConnectionList
50 virtual ~TimeAxisViewItem();
52 virtual bool set_position(framepos_t, void*, double* delta = 0);
53 framepos_t get_position() const;
54 virtual bool set_duration(framecnt_t, void*);
55 framecnt_t get_duration() const;
56 virtual void set_max_duration(framecnt_t, void*);
57 framecnt_t get_max_duration() const;
58 virtual void set_min_duration(framecnt_t, void*);
59 framecnt_t get_min_duration() const;
60 virtual void set_position_locked(bool, void*);
61 bool get_position_locked() const;
62 void set_max_duration_active(bool, void*);
63 bool get_max_duration_active() const;
64 void set_min_duration_active(bool, void*);
65 bool get_min_duration_active() const;
66 void set_item_name(std::string, void*);
67 virtual std::string get_item_name() const;
68 virtual void set_selected(bool yn);
69 void set_sensitive (bool yn) { _sensitive = yn; }
70 bool sensitive () const { return _sensitive; }
71 TimeAxisView& get_time_axis_view () const;
72 void set_name_text(const std::string&);
73 virtual void set_height(double h);
75 void set_color (Gdk::Color const &);
77 uint32_t get_fill_color () const;
79 ArdourCanvas::Item* get_canvas_frame();
80 ArdourCanvas::Group* get_canvas_group();
81 ArdourCanvas::Item* get_name_highlight();
83 virtual void set_samples_per_pixel (double);
85 double get_samples_per_pixel () const;
87 virtual void drag_start() { _dragging = true; }
88 virtual void drag_end() { _dragging = false; }
89 bool dragging() const { return _dragging; }
91 virtual void raise () { return; }
92 virtual void raise_to_top () { return; }
93 virtual void lower () { return; }
94 virtual void lower_to_bottom () { return; }
96 virtual void hide_rect ();
97 virtual void show_rect ();
99 /** @return true if the name area should respond to events */
100 bool name_active() const { return name_connected; }
102 // Default sizes, font and spacing
103 static Pango::FontDescription NAME_FONT;
104 static void set_constant_heights ();
105 static const double NAME_X_OFFSET;
106 static const double GRAB_HANDLE_TOP;
107 static const double GRAB_HANDLE_WIDTH;
109 /* these are not constant, but vary with the pixel size
110 of the font used to display the item name.
112 static int NAME_HEIGHT;
113 static double NAME_Y_OFFSET;
114 static double NAME_HIGHLIGHT_SIZE;
115 static double NAME_HIGHLIGHT_THRESH;
117 /* if this is 1.0, we move the right boundary
118 of the item frame so that it is 1 pixel
119 after the end of the item. This gives nice
120 effects when splitting items.
122 if this is zero, the right edge coincides
123 with the end of the item, and things don't
126 this exists to allow easy debugging of the
129 static const double RIGHT_EDGE_SHIFT;
132 * Emitted when this Group has been removed.
133 * This is different to the CatchDeletion signal in that this signal
134 * is emitted during the deletion of this Time Axis, and not during
135 * the destructor, this allows us to capture the source of the deletion
139 sigc::signal<void,std::string,void*> ItemRemoved;
141 /** Emitted when the name of this item is changed */
142 sigc::signal<void,std::string,std::string,void*> NameChanged;
144 /** Emiited when the position of this item changes */
145 sigc::signal<void,framepos_t,void*> PositionChanged;
147 /** Emitted when the position lock of this item is changed */
148 sigc::signal<void,bool,void*> PositionLockChanged;
150 /** Emitted when the duration of this item changes */
151 sigc::signal<void,framecnt_t,void*> DurationChanged;
153 /** Emitted when the maximum item duration is changed */
154 sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
156 /** Emitted when the mionimum item duration is changed */
157 sigc::signal<void,framecnt_t,void*> MinDurationChanged;
161 ShowNameHighlight = 0x2,
164 HideFrameLeft = 0x10,
165 HideFrameRight = 0x20,
167 FullWidthNameHighlight = 0x80
171 TimeAxisViewItem(const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, Gdk::Color const &,
172 framepos_t, framecnt_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
174 TimeAxisViewItem (const TimeAxisViewItem&);
176 void init (ArdourCanvas::Group*, double, Gdk::Color const &, framepos_t, framepos_t, Visibility, bool, bool);
178 virtual bool canvas_group_event (GdkEvent*);
180 virtual void compute_colors (Gdk::Color const &);
181 virtual void set_colors();
182 virtual void set_frame_color();
183 virtual void set_frame_gradient ();
184 void set_trim_handle_colors();
186 virtual void reset_width_dependent_items (double);
188 static gint idle_remove_this_item(TimeAxisViewItem*, void*);
190 /** time axis that this item is on */
191 TimeAxisView& trackview;
193 /** indicates whether this item is locked to its current position */
194 bool position_locked;
196 /** position of this item on the timeline */
197 framepos_t frame_position;
199 /** duration of this item upon the timeline */
200 framecnt_t item_duration;
202 /** maximum duration that this item can have */
203 framecnt_t max_item_duration;
205 /** minimum duration that this item can have */
206 framecnt_t min_item_duration;
208 /** indicates whether the max duration constraint is active */
209 bool max_duration_active;
211 /** indicates whether the min duration constraint is active */
212 bool min_duration_active;
214 /** frames per canvas pixel */
215 double samples_per_pixel;
217 /** should the item respond to events */
221 * The unique item name of this Item.
222 * Each item upon a time axis must have a unique id.
224 std::string item_name;
226 /** true if the name should respond to events */
229 /** true if a small vestigial rect should be shown when the item gets very narrow */
232 uint32_t fill_opacity;
234 uint32_t frame_color_r;
235 uint32_t frame_color_g;
236 uint32_t frame_color_b;
237 uint32_t selected_frame_color_r;
238 uint32_t selected_frame_color_g;
239 uint32_t selected_frame_color_b;
240 uint32_t label_color;
242 uint32_t handle_color_r;
243 uint32_t handle_color_g;
244 uint32_t handle_color_b;
245 uint32_t lock_handle_color_r;
246 uint32_t lock_handle_color_g;
247 uint32_t lock_handle_color_b;
248 uint32_t last_item_width;
250 bool wide_enough_for_name;
251 bool high_enough_for_name;
254 ArdourCanvas::Group* group;
255 ArdourCanvas::Rectangle* vestigial_frame;
256 ArdourCanvas::Rectangle* frame;
257 ArdourCanvas::Text* name_text;
258 ArdourCanvas::Rectangle* name_highlight;
260 /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
261 ArdourCanvas::Rectangle* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
262 ArdourCanvas::Rectangle* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
264 bool frame_handle_crossing (GdkEvent*, ArdourCanvas::Rectangle*);
267 Visibility visibility;
269 bool _automation; ///< true if this is an automation region view
275 void parameter_changed (std::string);
276 void manage_name_highlight ();
277 void manage_name_text ();
279 }; /* class TimeAxisViewItem */
281 #endif /* __gtk_ardour_time_axis_view_item_h__ */