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