gtk2_ardour/time_axis_view_item.h

   1 /*
   2     Copyright (C) 2003 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __gtk_ardour_time_axis_view_item_h__
  21 #define __gtk_ardour_time_axis_view_item_h__
  22
  23 #include <jack/jack.h>
  24 #include <string>
  25
  26 #include <libgnomecanvasmm/text.h>
  27
  28 #include "selectable.h"
  29 #include "simplerect.h"
  30 #include "canvas.h"
  31
  32 class TimeAxisView;
  33
  34 /**
  35  * A base class for 'items' that may appear upon a TimeAxisView
  36  *
  37  */
  38 class TimeAxisViewItem : public Selectable
  39 {
  40    public:
  41        virtual ~TimeAxisViewItem() ;
  42
  43     /**
  44      * Set the position of this item upon the timeline to the specified value
  45      *
  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
  49      */
  50     virtual bool set_position(nframes_t pos, void* src, double* delta = 0) ;
  51
  52     /**
  53      * Return the position of this item upon the timeline
  54      *
  55      * @return the position of this item
  56      */
  57     nframes_t get_position() const ;
  58
  59     /**
  60      * Sets the duration of this item
  61      *
  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
  65      */
  66     virtual bool set_duration(nframes_t dur, void* src) ;
  67
  68     /**
  69      * Returns the duration of this item
  70      *
  71      */
  72     nframes_t get_duration() const ;
  73
  74     /**
  75      * Sets the maximum duration that this item make have.
  76      *
  77      * @param dur the new maximum duration
  78      * @param src the identity of the object that initiated the change
  79      */
  80     virtual void set_max_duration(nframes_t dur, void* src) ;
  81
  82     /**
  83      * Returns the maxmimum duration that this item may be set to
  84      *
  85      * @return the maximum duration that this item may be set to
  86      */
  87     nframes_t get_max_duration() const ;
  88
  89     /**
  90      * Sets the minimu duration that this item may be set to
  91      *
  92      * @param the minimum duration that this item may be set to
  93      * @param src the identity of the object that initiated the change
  94      */
  95     virtual void set_min_duration(nframes_t dur, void* src) ;
  96
  97     /**
  98      * Returns the minimum duration that this item mey be set to
  99      *
 100      * @return the nimum duration that this item mey be set to
 101      */
 102     nframes_t get_min_duration() const ;
 103
 104     /**
 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.
 107      *
 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
 110      */
 111     virtual void set_position_locked(bool yn, void* src) ;
 112
 113     /**
 114      * Returns whether this item is locked to its current position
 115      *
 116      * @return true if this item is locked to its current posotion
 117      *         false otherwise
 118      */
 119     bool get_position_locked() const ;
 120
 121     /**
 122      * Sets whether the Maximum Duration constraint is active and should be enforced
 123      *
 124      * @param active set true to enforce the max duration constraint
 125      * @param src the identity of the object that initiated the change
 126      */
 127     void set_max_duration_active(bool active, void* src) ;
 128
 129     /**
 130      * Returns whether the Maximum Duration constraint is active and should be enforced
 131      *
 132      * @return true if the maximum duration constraint is active, false otherwise
 133      */
 134     bool get_max_duration_active() const ;
 135
 136     /**
 137      * Sets whether the Minimum Duration constraint is active and should be enforced
 138      *
 139      * @param active set true to enforce the min duration constraint
 140      * @param src the identity of the object that initiated the change
 141      */
 142     void set_min_duration_active(bool active, void* src) ;
 143
 144     /**
 145      * Returns whether the Maximum Duration constraint is active and should be enforced
 146      *
 147      * @return true if the maximum duration constraint is active, false otherwise
 148      */
 149     bool get_min_duration_active() const ;
 150
 151     /**
 152      * Set the name/Id of this item.
 153      *
 154      * @param new_name the new name of this item
 155      * @param src the identity of the object that initiated the change
 156      */
 157     void set_item_name(std::string new_name, void* src) ;
 158
 159     /**
 160      * Returns the name/id of this item
 161      *
 162      * @return the name/id of this item
 163      */
 164     virtual std::string get_item_name() const ;
 165
 166     /**
 167      * Set to true to indicate that this item is currently selected
 168      *
 169      * @param yn true if this item is currently selected
 170      */
 171     virtual void set_selected(bool yn) ;
 172
 173     /**
 174      * Set to true to indicate that this item should show its selection status
 175      *
 176      * @param yn true if this item should show its selected status
 177      */
 178     virtual void set_should_show_selection (bool yn) ;
 179
 180     void set_sensitive (bool yn) { _sensitive = yn; }
 181     bool sensitive () const { return _sensitive; }
 182
 183     //---------------------------------------------------------------------------------------//
 184     // Parent Component Methods
 185
 186     /**
 187      * Returns the TimeAxisView that this item is upon
 188      *
 189      * @return the timeAxisView that this item is placed upon
 190      */
 191     TimeAxisView& get_time_axis_view() ;
 192
 193     //---------------------------------------------------------------------------------------//
 194     // ui methods & data
 195
 196     /**
 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
 199      *
 200      * @param new_name the new name text to display
 201      */
 202     void set_name_text(const Glib::ustring& new_name) ;
 203
 204     /**
 205      * Set the height of this item
 206      *
 207      * @param h the new height
 208      */
 209     virtual void set_height(double h) ;
 210
 211     /**
 212      *
 213      */
 214     void set_color(Gdk::Color& color) ;
 215
 216     /**
 217      *
 218      */
 219     ArdourCanvas::Item* get_canvas_frame() ;
 220
 221     /**
 222      *
 223      */
 224     ArdourCanvas::Item* get_canvas_group();
 225
 226     /**
 227      *
 228      */
 229     ArdourCanvas::Item* get_name_highlight();
 230
 231     /**
 232      *
 233      */
 234     ArdourCanvas::Text* get_name_text();
 235
 236
 237     /**
 238      * Returns the time axis that this item is upon
 239      */
 240     TimeAxisView& get_trackview() const { return trackview; }
 241
 242     /**
 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.
 246      *
 247      * @param spu the new samples per unit value
 248      */
 249     virtual void set_samples_per_unit(double spu) ;
 250
 251     /**
 252      * Returns the current samples per unit of this item
 253      *
 254      * @return the samples per unit of this item
 255      */
 256     double get_samples_per_unit() ;
 257
 258     virtual void raise () { return; }
 259     virtual void raise_to_top () { return; }
 260     virtual void lower () { return; }
 261     virtual void lower_to_bottom () { return; }
 262
 263     /**
 264      * returns true if the name area should respond to events.
 265      */
 266     bool name_active() const { return name_connected; }
 267
 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.
 275     */
 276     static double NAME_Y_OFFSET ;
 277     static double NAME_HIGHLIGHT_SIZE ;
 278     static double NAME_HIGHLIGHT_THRESH ;
 279
 280     /**
 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.
 284      *
 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
 287      *
 288      * @param src the identity of the object that initiated the change
 289      */
 290     virtual void remove_this_item(void* src) ;
 291
 292     /**
 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
 297      * event
 298      */
 299     sigc::signal<void,std::string,void*> ItemRemoved ;
 300
 301     /** Emitted when the name/Id of this item is changed */
 302     sigc::signal<void,std::string,std::string,void*> NameChanged ;
 303
 304     /** Emiited when the position of this item changes */
 305     sigc::signal<void,nframes_t,void*> PositionChanged ;
 306
 307     /** Emitted when the position lock of this item is changed */
 308     sigc::signal<void,bool,void*> PositionLockChanged ;
 309
 310     /** Emitted when the duration of this item changes */
 311     sigc::signal<void,nframes_t,void*> DurationChanged ;
 312
 313     /** Emitted when the maximum item duration is changed */
 314     sigc::signal<void,nframes_t,void*> MaxDurationChanged ;
 315
 316     /** Emitted when the mionimum item duration is changed */
 317     sigc::signal<void,nframes_t,void*> MinDurationChanged ;
 318
 319   protected:
 320
 321     enum Visibility {
 322             ShowFrame = 0x1,
 323             ShowNameHighlight = 0x2,
 324             ShowNameText = 0x4,
 325             ShowHandles = 0x8,
 326             HideFrameLeft = 0x10,
 327             HideFrameRight = 0x20,
 328             HideFrameTB = 0x40,
 329             FullWidthNameHighlight = 0x80
 330     };
 331
 332     /**
 333      * Constructs a new TimeAxisViewItem.
 334      *
 335      * @param it_name the unique name/Id of this item
 336      * @param parent the parent canvas group
 337      * @param tv the TimeAxisView we are going to be added to
 338      * @param spu samples per unit
 339      * @param base_color
 340      * @param start the start point of this item
 341      * @param duration the duration of this item
 342      */
 343     TimeAxisViewItem(const std::string & it_name, ArdourCanvas::Group& parent, TimeAxisView& tv, double spu, Gdk::Color& base_color,
 344                      nframes_t start, nframes_t duration, Visibility v = Visibility (0));
 345
 346     TimeAxisViewItem (const TimeAxisViewItem& other);
 347
 348     void init (const std::string& it_name, double spu, Gdk::Color& base_color, nframes_t start, nframes_t duration, Visibility vis);
 349
 350     /**
 351      * Calculates some contrasting color for displaying various parts of this item, based upon the base color
 352      *
 353      * @param color the base color of the item
 354      */
 355     virtual void compute_colors(Gdk::Color& color) ;
 356
 357     /**
 358      * convenience method to set the various canvas item colors
 359      */
 360     virtual void set_colors() ;
 361
 362     /**
 363      * Sets the frame color depending on whether this item is selected
 364      */
 365     void set_frame_color() ;
 366
 367     /**
 368      * Sets the colors of the start and end trim handle depending on object state
 369      *
 370      */
 371     void set_trim_handle_colors() ;
 372
 373     virtual void reset_width_dependent_items (double pixel_width);
 374     void reset_name_width (double pixel_width);
 375
 376     /**
 377      * Callback used to remove this item during the gtk idle loop
 378      * This is used to avoid deleting the obejct while inside the remove_this_group
 379      * method
 380      *
 381      * @param item the time axis item to remove
 382      * @param src the identity of the object that initiated the change
 383      */
 384     static gint idle_remove_this_item(TimeAxisViewItem* item, void* src) ;
 385
 386     /** The time axis that this item is upon */
 387     TimeAxisView& trackview ;
 388
 389     /** indicates whether this item is locked to its current position */
 390     bool position_locked ;
 391
 392     /** The posotion of this item on the timeline */
 393     nframes_t frame_position ;
 394
 395     /** the duration of this item upon the timeline */
 396     nframes_t item_duration ;
 397
 398     /** the maximum duration that we allow this item to take */
 399     nframes_t max_item_duration ;
 400
 401     /** the minimu duration that we allow this item to take */
 402     nframes_t min_item_duration ;
 403
 404     /** indicates whether this Max Duration constraint is active */
 405     bool max_duration_active ;
 406
 407     /** indicates whether this Min Duration constraint is active */
 408     bool min_duration_active ;
 409
 410     /** the curretn samples per canvas unit */
 411     double samples_per_unit ;
 412
 413     /** indicates if this item is currently selected */
 414     bool selected ;
 415
 416     /** should the item show its selected status */
 417     bool should_show_selection;
 418
 419     /** should the item respond to events */
 420     bool _sensitive;
 421
 422     /**
 423      * The unique item name of this Item
 424      * Each item upon a time axis must have a unique id
 425      */
 426     std::string item_name ;
 427
 428     /**
 429      * true if the name should respond to events
 430      */
 431     bool name_connected;
 432
 433     /**
 434      * true if a small vestigial rect should be shown when the item gets very narrow
 435      */
 436
 437     bool show_vestigial;
 438
 439     uint32_t fill_opacity;
 440     uint32_t fill_color ;
 441     uint32_t frame_color_r ;
 442     uint32_t frame_color_g ;
 443     uint32_t frame_color_b ;
 444     uint32_t selected_frame_color_r ;
 445     uint32_t selected_frame_color_g ;
 446     uint32_t selected_frame_color_b ;
 447     uint32_t label_color ;
 448
 449     uint32_t handle_color_r ;
 450     uint32_t handle_color_g ;
 451     uint32_t handle_color_b ;
 452     uint32_t lock_handle_color_r ;
 453     uint32_t lock_handle_color_g ;
 454     uint32_t lock_handle_color_b ;
 455
 456     ArdourCanvas::Group*      group;
 457     ArdourCanvas::SimpleRect* vestigial_frame;
 458     ArdourCanvas::SimpleRect* frame;
 459     ArdourCanvas::Text*       name_text;
 460     ArdourCanvas::SimpleRect* name_highlight;
 461     ArdourCanvas::SimpleRect* frame_handle_start;
 462     ArdourCanvas::SimpleRect* frame_handle_end;
 463
 464     int name_text_width;
 465     double last_name_text_width;
 466
 467     std::map<Glib::ustring::size_type,int> name_text_size_cache;
 468
 469     Visibility visibility;
 470
 471 }; /* class TimeAxisViewItem */
 472
 473 #endif /* __gtk_ardour_time_axis_view_item_h__ */