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__
23 #include <jack/jack.h>
26 #include <libgnomecanvasmm/text.h>
28 #include "selectable.h"
29 #include "simplerect.h"
35 * A base class for 'items' that may appear upon a TimeAxisView
38 class TimeAxisViewItem
: public Selectable
41 virtual ~TimeAxisViewItem() ;
44 * Set the position of this item upon the timeline to the specified value
46 * @param pos the new position
47 * @param src the identity of the object that initiated the change
48 * @return true if the position change was a success, false otherwise
50 virtual bool set_position(nframes_t pos
, void* src
, double* delta
= 0) ;
53 * Return the position of this item upon the timeline
55 * @return the position of this item
57 nframes_t
get_position() const ;
60 * Sets the duration of this item
62 * @param dur the new duration of this item
63 * @param src the identity of the object that initiated the change
64 * @return true if the duration change was succesful, false otherwise
66 virtual bool set_duration(nframes_t dur
, void* src
) ;
69 * Returns the duration of this item
72 nframes_t
get_duration() const ;
75 * Sets the maximum duration that this item make have.
77 * @param dur the new maximum duration
78 * @param src the identity of the object that initiated the change
80 virtual void set_max_duration(nframes_t dur
, void* src
) ;
83 * Returns the maxmimum duration that this item may be set to
85 * @return the maximum duration that this item may be set to
87 nframes_t
get_max_duration() const ;
90 * Sets the minimu duration that this item may be set to
92 * @param the minimum duration that this item may be set to
93 * @param src the identity of the object that initiated the change
95 virtual void set_min_duration(nframes_t dur
, void* src
) ;
98 * Returns the minimum duration that this item mey be set to
100 * @return the nimum duration that this item mey be set to
102 nframes_t
get_min_duration() const ;
105 * Sets whether the position of this Item is locked to its current position
106 * Locked items cannot be moved until the item is unlocked again.
108 * @param yn set to true to lock this item to its current position
109 * @param src the identity of the object that initiated the change
111 virtual void set_position_locked(bool yn
, void* src
) ;
114 * Returns whether this item is locked to its current position
116 * @return true if this item is locked to its current posotion
119 bool get_position_locked() const ;
122 * Sets whether the Maximum Duration constraint is active and should be enforced
124 * @param active set true to enforce the max duration constraint
125 * @param src the identity of the object that initiated the change
127 void set_max_duration_active(bool active
, void* src
) ;
130 * Returns whether the Maximum Duration constraint is active and should be enforced
132 * @return true if the maximum duration constraint is active, false otherwise
134 bool get_max_duration_active() const ;
137 * Sets whether the Minimum Duration constraint is active and should be enforced
139 * @param active set true to enforce the min duration constraint
140 * @param src the identity of the object that initiated the change
142 void set_min_duration_active(bool active
, void* src
) ;
145 * Returns whether the Maximum Duration constraint is active and should be enforced
147 * @return true if the maximum duration constraint is active, false otherwise
149 bool get_min_duration_active() const ;
152 * Set the name/Id of this item.
154 * @param new_name the new name of this item
155 * @param src the identity of the object that initiated the change
157 void set_item_name(std::string new_name
, void* src
) ;
160 * Returns the name/id of this item
162 * @return the name/id of this item
164 virtual std::string
get_item_name() const ;
167 * Set to true to indicate that this item is currently selected
169 * @param yn true if this item is currently selected
171 virtual void set_selected(bool yn
) ;
174 * Set to true to indicate that this item should show its selection status
176 * @param yn true if this item should show its selected status
178 virtual void set_should_show_selection (bool yn
) ;
180 void set_sensitive (bool yn
) { _sensitive
= yn
; }
181 bool sensitive () const { return _sensitive
; }
183 //---------------------------------------------------------------------------------------//
184 // Parent Component Methods
187 * Returns the TimeAxisView that this item is upon
189 * @return the timeAxisView that this item is placed upon
191 TimeAxisView
& get_time_axis_view() ;
193 //---------------------------------------------------------------------------------------//
197 * Sets the displayed item text
198 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item
200 * @param new_name the new name text to display
202 void set_name_text(const Glib::ustring
& new_name
) ;
205 * Set the height of this item
207 * @param h the new height
209 virtual void set_height(double h
) ;
214 void set_color(Gdk::Color
& color
) ;
219 ArdourCanvas::Item
* get_canvas_frame() ;
224 ArdourCanvas::Group
* get_canvas_group();
229 ArdourCanvas::Item
* get_name_highlight();
234 ArdourCanvas::Text
* get_name_text();
238 * Returns the time axis that this item is upon
240 TimeAxisView
& get_trackview() const { return trackview
; }
243 * Sets the samples per unit of this item.
244 * this item is used to determine the relative visual size and position of this item
245 * based upon its duration and start value.
247 * @param spu the new samples per unit value
249 virtual void set_samples_per_unit(double spu
) ;
252 * Returns the current samples per unit of this item
254 * @return the samples per unit of this item
256 double get_samples_per_unit() ;
258 virtual void raise () { return; }
259 virtual void raise_to_top () { return; }
260 virtual void lower () { return; }
261 virtual void lower_to_bottom () { return; }
264 * returns true if the name area should respond to events.
266 bool name_active() const { return name_connected
; }
268 // Default sizes, font and spacing
269 static Pango::FontDescription
* NAME_FONT
;
270 static bool have_name_font
;
271 static const double NAME_X_OFFSET
;
272 static const double GRAB_HANDLE_LENGTH
;
273 /* these are not constant, but vary with the pixel size
274 of the font used to display the item name.
276 static double NAME_Y_OFFSET
;
277 static double NAME_HIGHLIGHT_SIZE
;
278 static double NAME_HIGHLIGHT_THRESH
;
281 * Handles the Removal of this time axis item
282 * This _needs_ to be called to alert others of the removal properly, ie where the source
283 * of the removal came from.
285 * XXX Although im not too happy about this method of doing things, I cant think of a cleaner method
286 * just now to capture the source of the removal
288 * @param src the identity of the object that initiated the change
290 virtual void remove_this_item(void* src
) ;
293 * Emitted when this Group has been removed
294 * This is different to the GoingAway signal in that this signal
295 * is emitted during the deletion of this Time Axis, and not during
296 * the destructor, this allows us to capture the source of the deletion
300 sigc::signal
<void,std::string
,void*> ItemRemoved
;
302 /** Emitted when the name/Id of this item is changed */
303 sigc::signal
<void,std::string
,std::string
,void*> NameChanged
;
305 /** Emiited when the position of this item changes */
306 sigc::signal
<void,nframes_t
,void*> PositionChanged
;
308 /** Emitted when the position lock of this item is changed */
309 sigc::signal
<void,bool,void*> PositionLockChanged
;
311 /** Emitted when the duration of this item changes */
312 sigc::signal
<void,nframes_t
,void*> DurationChanged
;
314 /** Emitted when the maximum item duration is changed */
315 sigc::signal
<void,nframes_t
,void*> MaxDurationChanged
;
317 /** Emitted when the mionimum item duration is changed */
318 sigc::signal
<void,nframes_t
,void*> MinDurationChanged
;
322 ShowNameHighlight
= 0x2,
325 HideFrameLeft
= 0x10,
326 HideFrameRight
= 0x20,
328 FullWidthNameHighlight
= 0x80
332 * Constructs a new TimeAxisViewItem.
334 * @param it_name the unique name/Id of this item
335 * @param parent the parent canvas group
336 * @param tv the TimeAxisView we are going to be added to
337 * @param spu samples per unit
339 * @param start the start point of this item
340 * @param duration the duration of this item
342 TimeAxisViewItem(const std::string
& it_name
, ArdourCanvas::Group
& parent
, TimeAxisView
& tv
, double spu
, Gdk::Color
& base_color
,
343 nframes_t start
, nframes_t duration
, bool recording
= false, Visibility v
= Visibility (0));
345 TimeAxisViewItem (const TimeAxisViewItem
& other
);
347 void init (const std::string
& it_name
, double spu
, Gdk::Color
& base_color
, nframes_t start
, nframes_t duration
, Visibility vis
);
350 * Calculates some contrasting color for displaying various parts of this item, based upon the base color
352 * @param color the base color of the item
354 virtual void compute_colors(Gdk::Color
& color
) ;
357 * convenience method to set the various canvas item colors
359 virtual void set_colors() ;
362 * Sets the frame color depending on whether this item is selected
364 virtual void set_frame_color() ;
367 * Sets the colors of the start and end trim handle depending on object state
370 void set_trim_handle_colors() ;
372 virtual void reset_width_dependent_items (double pixel_width
);
373 void reset_name_width (double pixel_width
);
376 * Callback used to remove this item during the gtk idle loop
377 * This is used to avoid deleting the obejct while inside the remove_this_group
380 * @param item the time axis item to remove
381 * @param src the identity of the object that initiated the change
383 static gint
idle_remove_this_item(TimeAxisViewItem
* item
, void* src
) ;
385 /** The time axis that this item is upon */
386 TimeAxisView
& trackview
;
388 /** indicates whether this item is locked to its current position */
389 bool position_locked
;
391 /** The posotion of this item on the timeline */
392 nframes_t frame_position
;
394 /** the duration of this item upon the timeline */
395 nframes_t item_duration
;
397 /** the maximum duration that we allow this item to take */
398 nframes_t max_item_duration
;
400 /** the minimu duration that we allow this item to take */
401 nframes_t min_item_duration
;
403 /** indicates whether this Max Duration constraint is active */
404 bool max_duration_active
;
406 /** indicates whether this Min Duration constraint is active */
407 bool min_duration_active
;
409 /** the curretn samples per canvas unit */
410 double samples_per_unit
;
412 /** indicates if this item is currently selected */
415 /** should the item show its selected status */
416 bool should_show_selection
;
418 /** should the item respond to events */
422 * The unique item name of this Item
423 * Each item upon a time axis must have a unique id
425 std::string item_name
;
428 * true if the name should respond to events
433 * true if a small vestigial rect should be shown when the item gets very narrow
437 uint32_t fill_opacity
;
438 uint32_t fill_color
;
439 uint32_t frame_color_r
;
440 uint32_t frame_color_g
;
441 uint32_t frame_color_b
;
442 uint32_t selected_frame_color_r
;
443 uint32_t selected_frame_color_g
;
444 uint32_t selected_frame_color_b
;
445 uint32_t label_color
;
447 uint32_t handle_color_r
;
448 uint32_t handle_color_g
;
449 uint32_t handle_color_b
;
450 uint32_t lock_handle_color_r
;
451 uint32_t lock_handle_color_g
;
452 uint32_t lock_handle_color_b
;
454 ArdourCanvas::Group
* group
;
455 ArdourCanvas::SimpleRect
* vestigial_frame
;
456 ArdourCanvas::SimpleRect
* frame
;
457 ArdourCanvas::Text
* name_text
;
458 ArdourCanvas::SimpleRect
* name_highlight
;
459 ArdourCanvas::SimpleRect
* frame_handle_start
;
460 ArdourCanvas::SimpleRect
* frame_handle_end
;
463 double last_name_text_width
;
465 std::map
<Glib::ustring::size_type
,int> name_text_size_cache
;
467 Visibility visibility
;
471 }; /* class TimeAxisViewItem */
473 #endif /* __gtk_ardour_time_axis_view_item_h__ */