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         virtual void set_should_show_selection (bool yn);
  65         void set_sensitive (bool yn) { _sensitive = yn; }
  66         bool sensitive () const { return _sensitive; }
  67         TimeAxisView& get_time_axis_view () const;
  68         void set_name_text(const std::string&);
  69         virtual void set_height(double h);
  70         void set_y (double);
  71         void set_color (Gdk::Color const &);
  72
  73         ArdourCanvas::Item* get_canvas_frame();
  74         ArdourCanvas::Group* get_canvas_group();
  75         ArdourCanvas::Item* get_name_highlight();
  76         ArdourCanvas::Pixbuf* get_name_pixbuf();
  77
  78         virtual void set_samples_per_unit(double spu);
  79
  80         double get_samples_per_unit();
  81
  82         virtual void raise () { return; }
  83         virtual void raise_to_top () { return; }
  84         virtual void lower () { return; }
  85         virtual void lower_to_bottom () { return; }
  86
  87         /** @return true if the name area should respond to events */
  88         bool name_active() const { return name_connected; }
  89
  90         // Default sizes, font and spacing
  91         static Pango::FontDescription* NAME_FONT;
  92         static void set_constant_heights ();
  93         static const double NAME_X_OFFSET;
  94         static const double GRAB_HANDLE_LENGTH;
  95
  96         /* these are not constant, but vary with the pixel size
  97            of the font used to display the item name.
  98         */
  99         static int    NAME_HEIGHT;
 100         static double NAME_Y_OFFSET;
 101         static double NAME_HIGHLIGHT_SIZE;
 102         static double NAME_HIGHLIGHT_THRESH;
 103
 104         /**
 105          * Emitted when this Group has been removed.
 106          * This is different to the CatchDeletion signal in that this signal
 107          * is emitted during the deletion of this Time Axis, and not during
 108          * the destructor, this allows us to capture the source of the deletion
 109          * event
 110          */
 111
 112         sigc::signal<void,std::string,void*> ItemRemoved;
 113
 114         /** Emitted when the name of this item is changed */
 115         sigc::signal<void,std::string,std::string,void*> NameChanged;
 116
 117         /** Emiited when the position of this item changes */
 118         sigc::signal<void,framepos_t,void*> PositionChanged;
 119
 120         /** Emitted when the position lock of this item is changed */
 121         sigc::signal<void,bool,void*> PositionLockChanged;
 122
 123         /** Emitted when the duration of this item changes */
 124         sigc::signal<void,framecnt_t,void*> DurationChanged;
 125
 126         /** Emitted when the maximum item duration is changed */
 127         sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
 128
 129         /** Emitted when the mionimum item duration is changed */
 130         sigc::signal<void,framecnt_t,void*> MinDurationChanged;
 131
 132         enum Visibility {
 133                 ShowFrame = 0x1,
 134                 ShowNameHighlight = 0x2,
 135                 ShowNameText = 0x4,
 136                 ShowHandles = 0x8,
 137                 HideFrameLeft = 0x10,
 138                 HideFrameRight = 0x20,
 139                 HideFrameTB = 0x40,
 140                 FullWidthNameHighlight = 0x80
 141         };
 142
 143   protected:
 144         TimeAxisViewItem(const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, Gdk::Color const &,
 145                          framepos_t, framepos_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
 146
 147         TimeAxisViewItem (const TimeAxisViewItem&);
 148
 149         void init (const std::string&, double, Gdk::Color const &, framepos_t, framepos_t, Visibility, bool, bool);
 150
 151         virtual void compute_colors (Gdk::Color const &);
 152         virtual void set_colors();
 153         virtual void set_frame_color();
 154         void set_trim_handle_colors();
 155
 156         virtual void reset_width_dependent_items (double);
 157         void reset_name_width (double);
 158         void update_name_pixbuf_visibility ();
 159
 160         static gint idle_remove_this_item(TimeAxisViewItem*, void*);
 161
 162         /** time axis that this item is on */
 163         TimeAxisView& trackview;
 164
 165         /** indicates whether this item is locked to its current position */
 166         bool position_locked;
 167
 168         /** position of this item on the timeline */
 169         framepos_t frame_position;
 170
 171         /** duration of this item upon the timeline */
 172         framecnt_t item_duration;
 173
 174         /** maximum duration that this item can have */
 175         framecnt_t max_item_duration;
 176
 177         /** minimum duration that this item can have */
 178         framecnt_t min_item_duration;
 179
 180         /** indicates whether the max duration constraint is active */
 181         bool max_duration_active;
 182
 183         /** indicates whether the min duration constraint is active */
 184         bool min_duration_active;
 185
 186         /** samples per canvas unit */
 187         double samples_per_unit;
 188
 189         /** should the item show its selected status */
 190         bool should_show_selection;
 191
 192         /** should the item respond to events */
 193         bool _sensitive;
 194
 195         /**
 196          * The unique item name of this Item.
 197          * Each item upon a time axis must have a unique id.
 198          */
 199         std::string item_name;
 200
 201         /** true if the name should respond to events */
 202         bool name_connected;
 203
 204         /** true if a small vestigial rect should be shown when the item gets very narrow */
 205         bool show_vestigial;
 206
 207         uint32_t fill_opacity;
 208         uint32_t fill_color;
 209         uint32_t frame_color_r;
 210         uint32_t frame_color_g;
 211         uint32_t frame_color_b;
 212         uint32_t selected_frame_color_r;
 213         uint32_t selected_frame_color_g;
 214         uint32_t selected_frame_color_b;
 215         uint32_t label_color;
 216
 217         uint32_t handle_color_r;
 218         uint32_t handle_color_g;
 219         uint32_t handle_color_b;
 220         uint32_t lock_handle_color_r;
 221         uint32_t lock_handle_color_g;
 222         uint32_t lock_handle_color_b;
 223         uint32_t last_item_width;
 224         int name_pixbuf_width;
 225         bool wide_enough_for_name;
 226         bool high_enough_for_name;
 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 }; /* class TimeAxisViewItem */
 244
 245 #endif /* __gtk_ardour_time_axis_view_item_h__ */