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 &);
76 void set_name_text_color ();
78 uint32_t get_fill_color () const;
80 ArdourCanvas::Item* get_canvas_frame();
81 ArdourCanvas::Group* get_canvas_group();
82 ArdourCanvas::Item* get_name_highlight();
84 virtual void set_samples_per_pixel (double);
86 double get_samples_per_pixel () const;
88 virtual void drag_start() { _dragging = true; }
89 virtual void drag_end() { _dragging = false; }
90 bool dragging() const { return _dragging; }
92 virtual void raise () { return; }
93 virtual void raise_to_top () { return; }
94 virtual void lower () { return; }
95 virtual void lower_to_bottom () { return; }
97 virtual void hide_rect ();
98 virtual void show_rect ();
100 /** @return true if the name area should respond to events */
101 bool name_active() const { return name_connected; }
103 // Default sizes, font and spacing
104 static Pango::FontDescription NAME_FONT;
105 static void set_constant_heights ();
106 static const double NAME_X_OFFSET;
107 static const double GRAB_HANDLE_TOP;
108 static const double GRAB_HANDLE_WIDTH;
110 /* these are not constant, but vary with the pixel size
111 of the font used to display the item name.
113 static int NAME_HEIGHT;
114 static double NAME_Y_OFFSET;
115 static double NAME_HIGHLIGHT_SIZE;
116 static double NAME_HIGHLIGHT_THRESH;
118 /* if this is 1.0, we move the right boundary
119 of the item frame so that it is 1 pixel
120 after the end of the item. This gives nice
121 effects when splitting items.
123 if this is zero, the right edge coincides
124 with the end of the item, and things don't
127 this exists to allow easy debugging of the
130 static const double RIGHT_EDGE_SHIFT;
133 * Emitted when this Group has been removed.
134 * This is different to the CatchDeletion signal in that this signal
135 * is emitted during the deletion of this Time Axis, and not during
136 * the destructor, this allows us to capture the source of the deletion
140 sigc::signal<void,std::string,void*> ItemRemoved;
142 /** Emitted when the name of this item is changed */
143 sigc::signal<void,std::string,std::string,void*> NameChanged;
145 /** Emiited when the position of this item changes */
146 sigc::signal<void,framepos_t,void*> PositionChanged;
148 /** Emitted when the position lock of this item is changed */
149 sigc::signal<void,bool,void*> PositionLockChanged;
151 /** Emitted when the duration of this item changes */
152 sigc::signal<void,framecnt_t,void*> DurationChanged;
154 /** Emitted when the maximum item duration is changed */
155 sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
157 /** Emitted when the mionimum item duration is changed */
158 sigc::signal<void,framecnt_t,void*> MinDurationChanged;
162 ShowNameHighlight = 0x2,
165 HideFrameLeft = 0x10,
166 HideFrameRight = 0x20,
168 FullWidthNameHighlight = 0x80
172 TimeAxisViewItem(const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, Gdk::Color const &,
173 framepos_t, framecnt_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
175 TimeAxisViewItem (const TimeAxisViewItem&);
177 void init (ArdourCanvas::Group*, double, Gdk::Color const &, framepos_t, framepos_t, Visibility, bool, bool);
179 virtual bool canvas_group_event (GdkEvent*);
181 virtual void compute_colors (Gdk::Color const &);
182 virtual void set_colors();
183 virtual void set_frame_color();
184 virtual void set_frame_gradient ();
185 void set_trim_handle_colors();
187 virtual void reset_width_dependent_items (double);
189 static gint idle_remove_this_item(TimeAxisViewItem*, void*);
191 /** time axis that this item is on */
192 TimeAxisView& trackview;
194 /** indicates whether this item is locked to its current position */
195 bool position_locked;
197 /** position of this item on the timeline */
198 framepos_t frame_position;
200 /** duration of this item upon the timeline */
201 framecnt_t item_duration;
203 /** maximum duration that this item can have */
204 framecnt_t max_item_duration;
206 /** minimum duration that this item can have */
207 framecnt_t min_item_duration;
209 /** indicates whether the max duration constraint is active */
210 bool max_duration_active;
212 /** indicates whether the min duration constraint is active */
213 bool min_duration_active;
215 /** frames per canvas pixel */
216 double samples_per_pixel;
218 /** should the item respond to events */
222 * The unique item name of this Item.
223 * Each item upon a time axis must have a unique id.
225 std::string item_name;
227 /** true if the name should respond to events */
230 /** true if a small vestigial rect should be shown when the item gets very narrow */
233 uint32_t fill_opacity;
235 uint32_t frame_color_r;
236 uint32_t frame_color_g;
237 uint32_t frame_color_b;
238 uint32_t selected_frame_color_r;
239 uint32_t selected_frame_color_g;
240 uint32_t selected_frame_color_b;
241 uint32_t label_color;
243 uint32_t handle_color_r;
244 uint32_t handle_color_g;
245 uint32_t handle_color_b;
246 uint32_t lock_handle_color_r;
247 uint32_t lock_handle_color_g;
248 uint32_t lock_handle_color_b;
249 uint32_t last_item_width;
251 bool wide_enough_for_name;
252 bool high_enough_for_name;
255 ArdourCanvas::Group* group;
256 ArdourCanvas::Rectangle* vestigial_frame;
257 ArdourCanvas::Rectangle* frame;
258 ArdourCanvas::Text* name_text;
259 ArdourCanvas::Rectangle* name_highlight;
261 /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
262 ArdourCanvas::Rectangle* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
263 ArdourCanvas::Rectangle* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
265 bool frame_handle_crossing (GdkEvent*, ArdourCanvas::Rectangle*);
268 Visibility visibility;
270 bool _automation; ///< true if this is an automation region view
276 void parameter_changed (std::string);
277 void manage_name_highlight ();
278 void manage_name_text ();
280 }; /* class TimeAxisViewItem */
282 #endif /* __gtk_ardour_time_axis_view_item_h__ */