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 <string>
  24
  25 #include <libgnomecanvasmm/pixbuf.h>
  26
  27 #include "pbd/signals.h"
  28
  29 #include "selectable.h"
  30 #include "simplerect.h"
  31 #include "canvas.h"
  32
  33 class TimeAxisView;
  34
  35 using ARDOUR::framepos_t;
  36 using ARDOUR::framecnt_t;
  37
  38 /**
  39  * Base class for items that may appear upon a TimeAxisView.
  40  */
  41
  42 class TimeAxisViewItem : public Selectable, public PBD::ScopedConnectionList
  43 {
  44    public:
  45         virtual ~TimeAxisViewItem();
  46
  47         virtual bool set_position(framepos_t, void*, double* delta = 0);
  48         framepos_t get_position() const;
  49         virtual bool set_duration(framecnt_t, void*);
  50         framecnt_t get_duration() const;
  51         virtual void set_max_duration(framecnt_t, void*);
  52         framecnt_t get_max_duration() const;
  53         virtual void set_min_duration(framecnt_t, void*);
  54         framecnt_t get_min_duration() const;
  55         virtual void set_position_locked(bool, void*);
  56         bool get_position_locked() const;
  57         void set_max_duration_active(bool, void*);
  58         bool get_max_duration_active() const;
  59         void set_min_duration_active(bool, void*);
  60         bool get_min_duration_active() const;
  61         void set_item_name(std::string, void*);
  62         virtual std::string get_item_name() const;
  63         virtual void set_selected(bool yn);
  64         void set_sensitive (bool yn) { _sensitive = yn; }
  65         bool sensitive () const { return _sensitive; }
  66         TimeAxisView& get_time_axis_view () const;
  67         void set_name_text(const std::string&);
  68         virtual void set_height(double h);
  69         void set_y (double);
  70         void set_color (Gdk::Color const &);
  71
  72         ArdourCanvas::Item* get_canvas_frame();
  73         ArdourCanvas::Group* get_canvas_group();
  74         ArdourCanvas::Item* get_name_highlight();
  75         ArdourCanvas::Pixbuf* get_name_pixbuf();
  76
  77         virtual void set_samples_per_unit(double spu);
  78
  79         double get_samples_per_unit();
  80
  81         virtual void raise () { return; }
  82         virtual void raise_to_top () { return; }
  83         virtual void lower () { return; }
  84         virtual void lower_to_bottom () { return; }
  85
  86         virtual void hide_rect ();
  87         virtual void show_rect ();
  88
  89         /** @return true if the name area should respond to events */
  90         bool name_active() const { return name_connected; }
  91
  92         // Default sizes, font and spacing
  93         static Pango::FontDescription* NAME_FONT;
  94         static void set_constant_heights ();
  95         static const double NAME_X_OFFSET;
  96         static const double GRAB_HANDLE_LENGTH;
  97
  98         /* these are not constant, but vary with the pixel size
  99            of the font used to display the item name.
 100         */
 101         static int    NAME_HEIGHT;
 102         static double NAME_Y_OFFSET;
 103         static double NAME_HIGHLIGHT_SIZE;
 104         static double NAME_HIGHLIGHT_THRESH;
 105
 106         /**
 107          * Emitted when this Group has been removed.
 108          * This is different to the CatchDeletion signal in that this signal
 109          * is emitted during the deletion of this Time Axis, and not during
 110          * the destructor, this allows us to capture the source of the deletion
 111          * event
 112          */
 113
 114         sigc::signal<void,std::string,void*> ItemRemoved;
 115
 116         /** Emitted when the name of this item is changed */
 117         sigc::signal<void,std::string,std::string,void*> NameChanged;
 118
 119         /** Emiited when the position of this item changes */
 120         sigc::signal<void,framepos_t,void*> PositionChanged;
 121
 122         /** Emitted when the position lock of this item is changed */
 123         sigc::signal<void,bool,void*> PositionLockChanged;
 124
 125         /** Emitted when the duration of this item changes */
 126         sigc::signal<void,framecnt_t,void*> DurationChanged;
 127
 128         /** Emitted when the maximum item duration is changed */
 129         sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
 130
 131         /** Emitted when the mionimum item duration is changed */
 132         sigc::signal<void,framecnt_t,void*> MinDurationChanged;
 133
 134         enum Visibility {
 135                 ShowFrame = 0x1,
 136                 ShowNameHighlight = 0x2,
 137                 ShowNameText = 0x4,
 138                 ShowHandles = 0x8,
 139                 HideFrameLeft = 0x10,
 140                 HideFrameRight = 0x20,
 141                 HideFrameTB = 0x40,
 142                 FullWidthNameHighlight = 0x80
 143         };
 144
 145   protected:
 146         TimeAxisViewItem(const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, Gdk::Color const &,
 147                          framepos_t, framepos_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
 148
 149         TimeAxisViewItem (const TimeAxisViewItem&);
 150
 151         void init (const std::string&, double, Gdk::Color const &, framepos_t, framepos_t, Visibility, bool, bool);
 152
 153         virtual void compute_colors (Gdk::Color const &);
 154         virtual void set_colors();
 155         virtual void set_frame_color();
 156         void set_trim_handle_colors();
 157
 158         virtual void reset_width_dependent_items (double);
 159         void reset_name_width (double);
 160         void update_name_pixbuf_visibility ();
 161
 162         static gint idle_remove_this_item(TimeAxisViewItem*, void*);
 163
 164         /** time axis that this item is on */
 165         TimeAxisView& trackview;
 166
 167         /** indicates whether this item is locked to its current position */
 168         bool position_locked;
 169
 170         /** position of this item on the timeline */
 171         framepos_t frame_position;
 172
 173         /** duration of this item upon the timeline */
 174         framecnt_t item_duration;
 175
 176         /** maximum duration that this item can have */
 177         framecnt_t max_item_duration;
 178
 179         /** minimum duration that this item can have */
 180         framecnt_t min_item_duration;
 181
 182         /** indicates whether the max duration constraint is active */
 183         bool max_duration_active;
 184
 185         /** indicates whether the min duration constraint is active */
 186         bool min_duration_active;
 187
 188         /** samples per canvas unit */
 189         double samples_per_unit;
 190
 191         /** should the item respond to events */
 192         bool _sensitive;
 193
 194         /**
 195          * The unique item name of this Item.
 196          * Each item upon a time axis must have a unique id.
 197          */
 198         std::string item_name;
 199
 200         /** true if the name should respond to events */
 201         bool name_connected;
 202
 203         /** true if a small vestigial rect should be shown when the item gets very narrow */
 204         bool show_vestigial;
 205
 206         uint32_t fill_opacity;
 207         uint32_t fill_color;
 208         uint32_t frame_color_r;
 209         uint32_t frame_color_g;
 210         uint32_t frame_color_b;
 211         uint32_t selected_frame_color_r;
 212         uint32_t selected_frame_color_g;
 213         uint32_t selected_frame_color_b;
 214         uint32_t label_color;
 215
 216         uint32_t handle_color_r;
 217         uint32_t handle_color_g;
 218         uint32_t handle_color_b;
 219         uint32_t lock_handle_color_r;
 220         uint32_t lock_handle_color_g;
 221         uint32_t lock_handle_color_b;
 222         uint32_t last_item_width;
 223         int name_pixbuf_width;
 224         bool wide_enough_for_name;
 225         bool high_enough_for_name;
 226         bool rect_visible;
 227
 228         ArdourCanvas::Group*      group;
 229         ArdourCanvas::SimpleRect* vestigial_frame;
 230         ArdourCanvas::SimpleRect* frame;
 231         ArdourCanvas::Pixbuf*     name_pixbuf;
 232         ArdourCanvas::SimpleRect* name_highlight;
 233
 234         /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
 235         ArdourCanvas::SimpleRect* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
 236         ArdourCanvas::SimpleRect* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
 237
 238         double _height;
 239         Visibility visibility;
 240         bool _recregion;
 241         bool _automation; ///< true if this is an automation region view
 242
 243 private:
 244
 245         void parameter_changed (std::string);
 246
 247 }; /* class TimeAxisViewItem */
 248
 249 #endif /* __gtk_ardour_time_axis_view_item_h__ */