gtk2_ardour/marker_view.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_marker_view_h__
  21 #define __gtk_ardour_marker_view_h__
  22
  23 #include <string>
  24 #include "time_axis_view_item.h"
  25
  26 #include "canvas.h"
  27
  28 namespace Gdk {
  29         class Color;
  30 }
  31
  32 class MarkerTimeAxisView ;
  33 class ImageFrameView ;
  34
  35 /**
  36  * MarkerView defines a marker item that may be placed upon a MarkerTimeAxis.
  37  *
  38  * The aim of the MarkerView is to provide additional timing details for visual based time axis.
  39  * The MarkerView item is associated with one other TimeAxisViewItem and has a start and a duration.
  40  */
  41 class MarkerView : public TimeAxisViewItem
  42 {
  43         public:
  44                 //---------------------------------------------------------------------------------------//
  45                 // Constructor / Desctructor
  46
  47                 /**
  48                  * Constructs a new MarkerView
  49                  *
  50                  * @param parent the parent canvas item
  51                  * @param tv the parent TimeAxisView of this item
  52                  * @param marked the Item that this item is to be assciated (marking) with
  53                  * @param spu the current samples per unit
  54                  * @param base_color
  55                  * @param mark_type the marker type/name text, eg fade out, pan up etc.
  56                  * @param mark_id unique name/id of this item
  57                  * @param start the start time of this item
  58                  * @param duration the duration of this item
  59                  */
  60                  MarkerView(ArdourCanvas::Group *parent,
  61                         TimeAxisView *tv,
  62                         ImageFrameView* marked,
  63                         double spu,
  64                         Gdk::Color& base_color,
  65                         std::string mark_type,
  66                         std::string mark_id,
  67                         nframes_t start,
  68                         nframes_t duration) ;
  69
  70                 /**
  71                  * Destructor
  72                  * Destroys this Marker Item and removes the association between itself and the item it is marking.
  73                  */
  74                 ~MarkerView() ;
  75
  76                 static PBD::Signal1<void,MarkerView*> CatchDeletion;
  77
  78                 //---------------------------------------------------------------------------------------//
  79                 // Marker Type Methods
  80
  81                 /**
  82                  * Sets the marker Type text of this this MarkerItem, eg fade_out, pan up etc.
  83                  *
  84                  * @param type_text the marker type text of this item
  85                  */
  86                 void set_mark_type_text(std::string type_text) ;
  87
  88                 /**
  89                  * Returns the marker Type of this this MarkerItem, eg fade_out, pan up etc.
  90                  *
  91                  * @return the marker type text of this item
  92                  */
  93                 std::string get_mark_type_text() const ;
  94
  95
  96                 //---------------------------------------------------------------------------------------//
  97                 // Marked Item Methods
  98
  99                 /**
 100                  * Returns the time axis item being marked by this item
 101                  *
 102                  * @return the time axis item being marked by this item
 103                  */
 104                 ImageFrameView* get_marked_item() ;
 105
 106                 /**
 107                  * Sets the time axis item being marker by this item
 108                  *
 109                  * @param item the time axis item to be marked by this item
 110                  * @return the previously marked item, or 0 if no previous marked item exists
 111                  */
 112                 ImageFrameView* set_marked_item(ImageFrameView* item) ;
 113
 114                 //---------------------------------------------------------------------------------//
 115                 // Emitted Signals
 116
 117                 /** Emitted when the mark type text is changed */
 118                 sigc::signal<void,std::string,void*> MarkTypeChanged ;
 119
 120                 /** Emitted when the Marked Item is changed */
 121                 sigc::signal<void,ImageFrameView*,void*> MarkedItemChanged ;
 122
 123
 124         protected:
 125
 126         private:
 127                 /** the unique name/id of this item */
 128                 std::string mark_type_text ;
 129
 130                 /* a pointer to the time axis item this marker is assoiated(marking up) with */
 131                 ImageFrameView* marked_item ;
 132
 133 } ; /* class MarkerView */
 134
 135
 136 #endif /* __gtk_ardour_imageframe_view_h__ */