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 (uint32_t);
  76         void set_name_text_color ();
  77
  78         uint32_t get_fill_color () const;
  79
  80         ArdourCanvas::Item* get_canvas_frame();
  81         ArdourCanvas::Group* get_canvas_group();
  82         ArdourCanvas::Item* get_name_highlight();
  83
  84         virtual void set_samples_per_pixel (double);
  85
  86         double get_samples_per_pixel () const;
  87
  88         virtual void drag_start();
  89         virtual void drag_end();
  90         bool dragging() const { return _dragging; }
  91
  92         virtual void raise () { return; }
  93         virtual void raise_to_top () { return; }
  94         virtual void lower () { return; }
  95         virtual void lower_to_bottom () { return; }
  96
  97         virtual void hide_rect ();
  98         virtual void show_rect ();
  99
 100         /** @return true if the name area should respond to events */
 101         bool name_active() const { return name_connected; }
 102
 103         // Default sizes, font and spacing
 104         static Pango::FontDescription NAME_FONT;
 105         static void set_constant_heights ();
 106         static const double NAME_X_OFFSET;
 107         static const double GRAB_HANDLE_TOP;
 108         static const double GRAB_HANDLE_WIDTH;
 109
 110         /* these are not constant, but vary with the pixel size
 111            of the font used to display the item name.
 112         */
 113         static int    NAME_HEIGHT;
 114         static double NAME_Y_OFFSET;
 115         static double NAME_HIGHLIGHT_SIZE;
 116         static double NAME_HIGHLIGHT_THRESH;
 117
 118         /* if this is 1.0, we move the right boundary
 119            of the item frame so that it is 1 pixel
 120            after the end of the item. This gives nice
 121            effects when splitting items.
 122
 123            if this is zero, the right edge coincides
 124            with the end of the item, and things don't
 125            look so nice.
 126
 127            this exists to allow easy debugging of the
 128            two scenarios.
 129         */
 130         static const double RIGHT_EDGE_SHIFT;
 131
 132         /**
 133          * Emitted when this Group has been removed.
 134          * This is different to the CatchDeletion signal in that this signal
 135          * is emitted during the deletion of this Time Axis, and not during
 136          * the destructor, this allows us to capture the source of the deletion
 137          * event
 138          */
 139
 140         sigc::signal<void,std::string,void*> ItemRemoved;
 141
 142         /** Emitted when the name of this item is changed */
 143         sigc::signal<void,std::string,std::string,void*> NameChanged;
 144
 145         /** Emiited when the position of this item changes */
 146         sigc::signal<void,framepos_t,void*> PositionChanged;
 147
 148         /** Emitted when the position lock of this item is changed */
 149         sigc::signal<void,bool,void*> PositionLockChanged;
 150
 151         /** Emitted when the duration of this item changes */
 152         sigc::signal<void,framecnt_t,void*> DurationChanged;
 153
 154         /** Emitted when the maximum item duration is changed */
 155         sigc::signal<void,framecnt_t,void*> MaxDurationChanged;
 156
 157         /** Emitted when the mionimum item duration is changed */
 158         sigc::signal<void,framecnt_t,void*> MinDurationChanged;
 159
 160         enum Visibility {
 161                 ShowFrame = 0x1,
 162                 ShowNameHighlight = 0x2,
 163                 ShowNameText = 0x4,
 164                 ShowHandles = 0x8,
 165                 HideFrameLeft = 0x10,
 166                 HideFrameRight = 0x20,
 167                 HideFrameTB = 0x40,
 168                 FullWidthNameHighlight = 0x80
 169         };
 170
 171   protected:
 172         TimeAxisViewItem (const std::string &, ArdourCanvas::Group&, TimeAxisView&, double, uint32_t fill_color,
 173                           framepos_t, framecnt_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));
 174
 175         TimeAxisViewItem (const TimeAxisViewItem&);
 176
 177         void init (ArdourCanvas::Group*, double, uint32_t, framepos_t, framepos_t, Visibility, bool, bool);
 178
 179         virtual bool canvas_group_event (GdkEvent*);
 180
 181         virtual void set_colors();
 182         virtual void set_frame_color();
 183         virtual void set_frame_gradient ();
 184         void set_trim_handle_colors();
 185
 186         virtual void reset_width_dependent_items (double);
 187
 188         static gint idle_remove_this_item(TimeAxisViewItem*, void*);
 189
 190         /** time axis that this item is on */
 191         TimeAxisView& trackview;
 192
 193         /** indicates whether this item is locked to its current position */
 194         bool position_locked;
 195
 196         /** position of this item on the timeline */
 197         framepos_t frame_position;
 198
 199         /** duration of this item upon the timeline */
 200         framecnt_t item_duration;
 201
 202         /** maximum duration that this item can have */
 203         framecnt_t max_item_duration;
 204
 205         /** minimum duration that this item can have */
 206         framecnt_t min_item_duration;
 207
 208         /** indicates whether the max duration constraint is active */
 209         bool max_duration_active;
 210
 211         /** indicates whether the min duration constraint is active */
 212         bool min_duration_active;
 213
 214         /** frames per canvas pixel */
 215         double samples_per_pixel;
 216
 217         /** should the item respond to events */
 218         bool _sensitive;
 219
 220         /**
 221          * The unique item name of this Item.
 222          * Each item upon a time axis must have a unique id.
 223          */
 224         std::string item_name;
 225
 226         /** true if the name should respond to events */
 227         bool name_connected;
 228
 229         /** true if a small vestigial rect should be shown when the item gets very narrow */
 230         bool show_vestigial;
 231
 232         uint32_t fill_color;
 233
 234         virtual uint32_t fill_opacity() const;
 235
 236         uint32_t last_item_width;
 237         int name_text_width;
 238         bool wide_enough_for_name;
 239         bool high_enough_for_name;
 240         bool rect_visible;
 241
 242         ArdourCanvas::Group*      group;
 243         ArdourCanvas::Rectangle* vestigial_frame;
 244         ArdourCanvas::Rectangle* frame;
 245         ArdourCanvas::Text*      name_text;
 246         ArdourCanvas::Rectangle* name_highlight;
 247
 248         /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
 249         ArdourCanvas::Rectangle* frame_handle_start; ///< `frame' (fade) handle for the start of the item, or 0
 250         ArdourCanvas::Rectangle* frame_handle_end; ///< `frame' (fade) handle for the end of the item, or 0
 251
 252         bool frame_handle_crossing (GdkEvent*, ArdourCanvas::Rectangle*);
 253
 254         double _height;
 255         Visibility visibility;
 256         bool _recregion;
 257         bool _automation; ///< true if this is an automation region view
 258         bool _dragging;
 259
 260 private:
 261         double _width;
 262
 263         void parameter_changed (std::string);
 264         void manage_name_highlight ();
 265         void manage_name_text ();
 266
 267 }; /* class TimeAxisViewItem */
 268
 269 #endif /* __gtk_ardour_time_axis_view_item_h__ */