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;
120 * Emitted when this Group has been removed.
121 * This is different to the CatchDeletion signal in that this signal
122 * is emitted during the deletion of this Time Axis, and not during
123 * the destructor, this allows us to capture the source of the deletion
127 sigc::signal<void,std::string,void*> ItemRemoved;
129 /** Emitted when the name of this item is changed */
130 sigc::signal<void,std::string,std::string,void*> NameChanged;
132 /** Emiited when the position of this item changes */
133 sigc::signal<void,framepos_t,void*> PositionChanged;
135 /** Emitted when the position lock of this item is changed */
136 sigc::signal<void,bool,void*> PositionLockChanged;
138 /** Emitted when the duration of this item changes */
139 sigc::signal<void,framecnt_t,void*> DurationChanged;
141 /** Emitted when the maximum item duration is changed */
142 sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
144 /** Emitted when the mionimum item duration is changed */
145 sigc::signal<void,framecnt_t,void*> MinDurationChanged;
149 ShowNameHighlight = 0x2,
152 HideFrameLeft = 0x10,
153 HideFrameRight = 0x20,
155 FullWidthNameHighlight = 0x80
159 TimeAxisViewItem (const std::string &, ArdourCanvas::Item&, TimeAxisView&, double, uint32_t fill_color,
160 framepos_t, framecnt_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
162 TimeAxisViewItem (const TimeAxisViewItem&);
164 void init (ArdourCanvas::Item*, double, uint32_t, framepos_t, framepos_t, Visibility, bool, bool);
166 virtual bool canvas_group_event (GdkEvent*);
168 virtual void set_colors();
169 virtual void set_frame_color();
170 virtual void set_frame_gradient ();
171 void set_trim_handle_colors();
173 virtual void reset_width_dependent_items (double);
175 static gint idle_remove_this_item(TimeAxisViewItem*, void*);
177 /** time axis that this item is on */
178 TimeAxisView& trackview;
180 /** indicates whether this item is locked to its current position */
181 bool position_locked;
183 /** position of this item on the timeline */
184 framepos_t frame_position;
186 /** duration of this item upon the timeline */
187 framecnt_t item_duration;
189 /** maximum duration that this item can have */
190 framecnt_t max_item_duration;
192 /** minimum duration that this item can have */
193 framecnt_t min_item_duration;
195 /** indicates whether the max duration constraint is active */
196 bool max_duration_active;
198 /** indicates whether the min duration constraint is active */
199 bool min_duration_active;
201 /** frames per canvas pixel */
202 double samples_per_pixel;
204 /** should the item respond to events */
208 * The unique item name of this Item.
209 * Each item upon a time axis must have a unique id.
211 std::string item_name;
213 /** true if the name should respond to events */
216 /** true if a small vestigial rect should be shown when the item gets very narrow */
221 virtual uint32_t fill_opacity() const;
223 uint32_t last_item_width;
225 bool wide_enough_for_name;
226 bool high_enough_for_name;
229 ArdourCanvas::Container* group;
230 ArdourCanvas::Rectangle* vestigial_frame;
231 ArdourCanvas::Rectangle* frame;
232 ArdourCanvas::Rectangle* selection_frame;
233 ArdourCanvas::Text* name_text;
234 ArdourCanvas::Rectangle* name_highlight;
236 /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
237 ArdourCanvas::Rectangle* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
238 ArdourCanvas::Rectangle* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
240 bool frame_handle_crossing (GdkEvent*, ArdourCanvas::Rectangle*);
243 Visibility visibility;
244 std::string _fill_color_name;
246 bool _automation; ///< true if this is an automation region view
252 void parameter_changed (std::string);
253 void manage_name_highlight ();
254 void manage_name_text ();
256 }; /* class TimeAxisViewItem */
258 #endif /* __gtk_ardour_time_axis_view_item_h__ */