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