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     //---------------------------------------------------------------------------------------//
 181     // Parent Component Methods
 182
 183     /**
 184      * Returns the TimeAxisView that this item is upon
 185      *
 186      * @return the timeAxisView that this item is placed upon
 187      */
 188     TimeAxisView& get_time_axis_view() ;
 189
 190     //---------------------------------------------------------------------------------------//
 191     // ui methods & data
 192
 193     /**
 194      * Sets the displayed item text
 195      * This item is the visual text name displayed on the canvas item, this can be different to the name of the item
 196      *
 197      * @param new_name the new name text to display
 198      */
 199     void set_name_text(std::string new_name) ;
 200
 201     /**
 202      * Set the height of this item
 203      *
 204      * @param h the new height
 205      */
 206     virtual void set_height(double h) ;
 207
 208     /**
 209      *
 210      */
 211     void set_color(Gdk::Color& color) ;
 212
 213     /**
 214      *
 215      */
 216     ArdourCanvas::Item* get_canvas_frame() ;
 217
 218     /**
 219      *
 220      */
 221     ArdourCanvas::Item* get_canvas_group();
 222
 223     /**
 224      *
 225      */
 226     ArdourCanvas::Item* get_name_highlight();
 227
 228     /**
 229      *
 230      */
 231     ArdourCanvas::Text* get_name_text();
 232
 233
 234     /**
 235      * Returns the time axis that this item is upon
 236      */
 237     TimeAxisView& get_trackview() const { return trackview; }
 238
 239     /**
 240      * Sets the samples per unit of this item.
 241      * this item is used to determine the relative visual size and position of this item
 242      * based upon its duration and start value.
 243      *
 244      * @param spu the new samples per unit value
 245      */
 246     virtual void set_samples_per_unit(double spu) ;
 247
 248     /**
 249      * Returns the current samples per unit of this item
 250      *
 251      * @return the samples per unit of this item
 252      */
 253     double get_samples_per_unit() ;
 254
 255     virtual void raise () { return; }
 256     virtual void raise_to_top () { return; }
 257     virtual void lower () { return; }
 258     virtual void lower_to_bottom () { return; }
 259
 260     /**
 261      * returns true if the name area should respond to events.
 262      */
 263     bool name_active() const { return name_connected; }
 264
 265     // Default sizes, font and spacing
 266     static Pango::FontDescription NAME_FONT ;
 267     static bool have_name_font;
 268     static const double NAME_X_OFFSET ;
 269     static const double GRAB_HANDLE_LENGTH ;
 270     /* these are not constant, but vary with the pixel size
 271        of the font used to display the item name.
 272     */
 273     static double NAME_Y_OFFSET ;
 274     static double NAME_HIGHLIGHT_SIZE ;
 275     static double NAME_HIGHLIGHT_THRESH ;
 276
 277     /**
 278      * Handles the Removal of this time axis item
 279      * This _needs_ to be called to alert others of the removal properly, ie where the source
 280      * of the removal came from.
 281      *
 282      * XXX Although im not too happy about this method of doing things, I cant think of a cleaner method
 283      *     just now to capture the source of the removal
 284      *
 285      * @param src the identity of the object that initiated the change
 286      */
 287     virtual void remove_this_item(void* src) ;
 288
 289     /**
 290      * Emitted when this Group has been removed
 291      * This is different to the GoingAway signal in that this signal
 292      * is emitted during the deletion of this Time Axis, and not during
 293      * the destructor, this allows us to capture the source of the deletion
 294      * event
 295      */
 296     sigc::signal<void,std::string,void*> ItemRemoved ;
 297
 298     /** Emitted when the name/Id of this item is changed */
 299     sigc::signal<void,std::string,std::string,void*> NameChanged ;
 300
 301     /** Emiited when the position of this item changes */
 302     sigc::signal<void,nframes_t,void*> PositionChanged ;
 303
 304     /** Emitted when the position lock of this item is changed */
 305     sigc::signal<void,bool,void*> PositionLockChanged ;
 306
 307     /** Emitted when the duration of this item changes */
 308     sigc::signal<void,nframes_t,void*> DurationChanged ;
 309
 310     /** Emitted when the maximum item duration is changed */
 311     sigc::signal<void,nframes_t,void*> MaxDurationChanged ;
 312
 313     /** Emitted when the mionimum item duration is changed */
 314     sigc::signal<void,nframes_t,void*> MinDurationChanged ;
 315
 316   protected:
 317
 318     enum Visibility {
 319             ShowFrame = 0x1,
 320             ShowNameHighlight = 0x2,
 321             ShowNameText = 0x4,
 322             ShowHandles = 0x8,
 323             HideFrameLeft = 0x10,
 324             HideFrameRight = 0x20,
 325             HideFrameTB = 0x40,
 326             FullWidthNameHighlight = 0x80
 327     };
 328
 329     /**
 330      * Constructs a new TimeAxisViewItem.
 331      *
 332      * @param it_name the unique name/Id of this item
 333      * @param parent the parent canvas group
 334      * @param tv the TimeAxisView we are going to be added to
 335      * @param spu samples per unit
 336      * @param base_color
 337      * @param start the start point of this item
 338      * @param duration the duration of this item
 339      */
 340     TimeAxisViewItem(const std::string & it_name, ArdourCanvas::Group& parent, TimeAxisView& tv, double spu, Gdk::Color& base_color,
 341                      nframes_t start, nframes_t duration, Visibility v = Visibility (0));
 342
 343     /**
 344      * Calculates some contrasting color for displaying various parts of this item, based upon the base color
 345      *
 346      * @param color the base color of the item
 347      */
 348     virtual void compute_colors(Gdk::Color& color) ;
 349
 350     /**
 351      * convenience method to set the various canvas item colors
 352      */
 353     virtual void set_colors() ;
 354
 355     /**
 356      * Sets the frame color depending on whether this item is selected
 357      */
 358     void set_frame_color() ;
 359
 360     /**
 361      * Sets the colors of the start and end trim handle depending on object state
 362      *
 363      */
 364     void set_trim_handle_colors() ;
 365
 366     virtual void reset_width_dependent_items (double pixel_width);
 367     void reset_name_width (double pixel_width);
 368
 369     /**
 370      * Callback used to remove this item during the gtk idle loop
 371      * This is used to avoid deleting the obejct while inside the remove_this_group
 372      * method
 373      *
 374      * @param item the time axis item to remove
 375      * @param src the identity of the object that initiated the change
 376      */
 377     static gint idle_remove_this_item(TimeAxisViewItem* item, void* src) ;
 378
 379     /** The time axis that this item is upon */
 380     TimeAxisView& trackview ;
 381
 382     /** indicates whether this item is locked to its current position */
 383     bool position_locked ;
 384
 385     /** The posotion of this item on the timeline */
 386     nframes_t frame_position ;
 387
 388     /** the duration of this item upon the timeline */
 389     nframes_t item_duration ;
 390
 391     /** the maximum duration that we allow this item to take */
 392     nframes_t max_item_duration ;
 393
 394     /** the minimu duration that we allow this item to take */
 395     nframes_t min_item_duration ;
 396
 397     /** indicates whether this Max Duration constraint is active */
 398     bool max_duration_active ;
 399
 400     /** indicates whether this Min Duration constraint is active */
 401     bool min_duration_active ;
 402
 403     /** the curretn samples per canvas unit */
 404     double samples_per_unit ;
 405
 406     /** indicates if this item is currently selected */
 407     bool selected ;
 408
 409     /** should the item show its selected status */
 410     bool should_show_selection;
 411
 412     /**
 413      * The unique item name of this Item
 414      * Each item upon a time axis must have a unique id
 415      */
 416     std::string item_name ;
 417
 418     /**
 419      * true if the name should respond to events
 420      */
 421     bool name_connected;
 422
 423     /**
 424      * true if a small vestigial rect should be shown when the item gets very narrow
 425      */
 426
 427     bool show_vestigial;
 428
 429     uint32_t fill_opacity;
 430     uint32_t fill_color ;
 431     uint32_t frame_color_r ;
 432     uint32_t frame_color_g ;
 433     uint32_t frame_color_b ;
 434     uint32_t selected_frame_color_r ;
 435     uint32_t selected_frame_color_g ;
 436     uint32_t selected_frame_color_b ;
 437     uint32_t label_color ;
 438
 439     uint32_t handle_color_r ;
 440     uint32_t handle_color_g ;
 441     uint32_t handle_color_b ;
 442     uint32_t lock_handle_color_r ;
 443     uint32_t lock_handle_color_g ;
 444     uint32_t lock_handle_color_b ;
 445
 446     ArdourCanvas::Group*      group;
 447     ArdourCanvas::SimpleRect* vestigial_frame;
 448     ArdourCanvas::SimpleRect* frame;
 449     ArdourCanvas::Text*       name_text;
 450     ArdourCanvas::SimpleRect* name_highlight;
 451     ArdourCanvas::SimpleRect* frame_handle_start;
 452     ArdourCanvas::SimpleRect* frame_handle_end;
 453
 454     Visibility visibility;
 455
 456 }; /* class TimeAxisViewItem */
 457
 458 #endif /* __gtk_ardour_time_axis_view_item_h__ */