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