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);
74 virtual double height() const { return _height; }
76 void set_color (uint32_t);
77 void set_name_text_color ();
79 uint32_t get_fill_color () const;
81 ArdourCanvas::Item* get_canvas_frame();
82 ArdourCanvas::Item* get_canvas_group();
83 ArdourCanvas::Item* get_name_highlight();
85 virtual void set_samples_per_pixel (double);
87 double get_samples_per_pixel () const;
89 virtual void drag_start();
90 virtual void drag_end();
91 bool dragging() const { return _dragging; }
93 virtual void raise () { return; }
94 virtual void raise_to_top () { return; }
95 virtual void lower () { return; }
96 virtual void lower_to_bottom () { return; }
98 virtual void hide_rect ();
99 virtual void show_rect ();
101 /** @return true if the name area should respond to events */
102 bool name_active() const { return name_connected; }
104 // Default sizes, font and spacing
105 static Pango::FontDescription NAME_FONT;
106 static void set_constant_heights ();
107 static const double NAME_X_OFFSET;
108 static const double GRAB_HANDLE_TOP;
109 static const double GRAB_HANDLE_WIDTH;
111 /* these are not constant, but vary with the pixel size
112 of the font used to display the item name.
114 static int NAME_HEIGHT;
115 static double NAME_Y_OFFSET;
116 static double NAME_HIGHLIGHT_SIZE;
117 static double NAME_HIGHLIGHT_THRESH;
119 /* if this is 1.0, we move the right boundary
120 of the item frame so that it is 1 pixel
121 after the end of the item. This gives nice
122 effects when splitting items.
124 if this is zero, the right edge coincides
125 with the end of the item, and things don't
128 this exists to allow easy debugging of the
131 static const double RIGHT_EDGE_SHIFT;
134 * Emitted when this Group has been removed.
135 * This is different to the CatchDeletion signal in that this signal
136 * is emitted during the deletion of this Time Axis, and not during
137 * the destructor, this allows us to capture the source of the deletion
141 sigc::signal<void,std::string,void*> ItemRemoved;
143 /** Emitted when the name of this item is changed */
144 sigc::signal<void,std::string,std::string,void*> NameChanged;
146 /** Emiited when the position of this item changes */
147 sigc::signal<void,framepos_t,void*> PositionChanged;
149 /** Emitted when the position lock of this item is changed */
150 sigc::signal<void,bool,void*> PositionLockChanged;
152 /** Emitted when the duration of this item changes */
153 sigc::signal<void,framecnt_t,void*> DurationChanged;
155 /** Emitted when the maximum item duration is changed */
156 sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
158 /** Emitted when the mionimum item duration is changed */
159 sigc::signal<void,framecnt_t,void*> MinDurationChanged;
163 ShowNameHighlight = 0x2,
166 HideFrameLeft = 0x10,
167 HideFrameRight = 0x20,
169 FullWidthNameHighlight = 0x80
173 TimeAxisViewItem (const std::string &, ArdourCanvas::Item&, TimeAxisView&, double, uint32_t fill_color,
174 framepos_t, framecnt_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
176 TimeAxisViewItem (const TimeAxisViewItem&);
178 void init (ArdourCanvas::Item*, double, uint32_t, framepos_t, framepos_t, Visibility, bool, bool);
180 virtual bool canvas_group_event (GdkEvent*);
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 */
235 virtual uint32_t fill_opacity() const;
237 uint32_t last_item_width;
239 bool wide_enough_for_name;
240 bool high_enough_for_name;
243 ArdourCanvas::Container* group;
244 ArdourCanvas::Rectangle* vestigial_frame;
245 ArdourCanvas::Rectangle* frame;
246 ArdourCanvas::Text* name_text;
247 ArdourCanvas::Rectangle* name_highlight;
249 /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
250 ArdourCanvas::Rectangle* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
251 ArdourCanvas::Rectangle* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
253 bool frame_handle_crossing (GdkEvent*, ArdourCanvas::Rectangle*);
256 Visibility visibility;
258 bool _automation; ///< true if this is an automation region view
264 void parameter_changed (std::string);
265 void manage_name_highlight ();
266 void manage_name_text ();
268 }; /* class TimeAxisViewItem */
270 #endif /* __gtk_ardour_time_axis_view_item_h__ */