/*
- Copyright (C) 2003 Paul Davis
+ Copyright (C) 2003 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
/**
* A view helper for handling MarkerView objects.
* This object is responsible for the time axis canvas view, and
- * maintains the list of items that have been added to it
+ * maintains the list of items that have been added to it
*/
class MarkerTimeAxisView : public sigc::trackable
{
public:
//---------------------------------------------------------------------------------------//
// Constructor / Desctructor
-
+
/**
* Construct a new MarkerTimeAxisView helper time axis helper
*
* @param mta the TimeAxsiView that this objbect is the helper for
*/
MarkerTimeAxisView(MarkerTimeAxis& mta) ;
-
+
/**
* Destructor
* Reposinsibly for destroying all marker items that may have been added to this time axis view
*
*/
~MarkerTimeAxisView () ;
-
+
//---------------------------------------------------------------------------------------//
// Parent/Child helper object accessors
-
+
/**
* Returns the TimeAxisView thatt his object is acting as a helper for
*
* @return the TimeAxisView that this object is acting as a view helper for
*/
MarkerTimeAxis& trackview() { return _trackview; }
-
+
/**
*
*/
ArdourCanvas::Item *canvas_item() { return canvas_group; }
-
-
+
+
//---------------------------------------------------------------------------------------//
// ui methods & data
* @param height the new height
*/
int set_height(gdouble height) ;
-
+
/**
* Sets the position of this view helper on the canvas
*
* @param y the y position upon the canvas
*/
int set_position(gdouble x, gdouble y) ;
-
+
/**
* Sets the current samples per unit.
* this method tells each item upon the time axis of the change
- *
+ *
* @param spu the new samples per canvas unit value
*/
int set_samples_per_unit(gdouble spu) ;
-
+
/**
* Returns the current samples per unit of this time axis view helper
*
* @return the current samples per unit of this time axis view helper
*/
gdouble get_samples_per_unit() { return _samples_per_unit; }
-
+
/**
* Sets the color of the items contained upon this view helper
*
//---------------------------------------------------------------------------------------//
// Child MarkerView Accessors/Mutators
-
+
/**
* Adds a marker view to the list of items upon this time axis view helper
* the new MarkerView is returned
* @param src the identity of the object that initiated the change
*/
MarkerView* add_marker_view(ImageFrameView* ifv, std::string mark_type, std::string mark_id, nframes_t start, nframes_t dur, void* src) ;
-
+
/**
* Returns the named MarkerView or 0 if the named marker does not exist
*
* @return the named MarkerView, or 0 if it is not held upon this view
*/
MarkerView* get_named_marker_view(std::string item_id) ;
-
+
/**
* Removes the currently selected MarverView
* Note that this method actually destroys the MarkerView too.
* @see add_marker_view
*/
void remove_selected_marker_view(void* src) ;
-
+
/**
* Removes and returns the named MarkerView from the list of MarkerView held by this view helper
*
* @see add_marker_view
*/
MarkerView* remove_named_marker_view(std::string item_id, void* src) ;
-
+
/**
* Removes mv from the list of MarkerView upon this TimeAxis
*
* @param src the identity of the object that initiated the change
*/
void remove_marker_view(MarkerView* item, void* src) ;
-
+
//---------------------------------------------------------------------------------------//
// Selected item methods
* @param mv the item to set selected
*/
void set_selected_time_axis_item(MarkerView* mv) ;
-
+
/**
* Clears any selected item upon this time axis
*
*/
void clear_selected_time_axis_item() ;
-
+
/**
* Returnsthe currently selected item upon this time axis
*
* @return the currently selected item pon this time axis
*/
MarkerView* get_selected_time_axis_item() ;
-
-
+
+
/**
* Sets the duration of the selected MarkerView to the specified number of seconds
*
//---------------------------------------------------------------------------------//
// Emitted Signals
-
+
/** Emitted when a MarkerView is Added */
sigc::signal<void,MarkerView*,void*> MarkerViewAdded ;
-
+
/** Emitted when a MarkerView Item is removed */
sigc::signal<void,std::string,void*> MarkerViewRemoved ;
-
+
private:
/**
* convenience method to re-get the samples per unit and tell items upon this view
*
*/
void reset_samples_per_unit() ;
-
+
/** The list of items held by this time axis view helper */
typedef std::list<MarkerView *> MarkerViewList ;
MarkerViewList marker_view_list;
-
+
/** the currently selected time axis item upon this time axis */
MarkerView* selected_time_axis_item ;
-
+
/* the TimeAxisView that this object is acting as the view helper for */
MarkerTimeAxis& _trackview ;
-
+
ArdourCanvas::Group *canvas_group ;
ArdourCanvas::SimpleRect *canvas_rect ; /* frame around the whole thing */
/* XXX why are these different? */
Gdk::Color region_color;
uint32_t stream_base_color;
-
+
}; /* class MarkerTimeAxisView */
#endif /* __ardour_marker_time_axis_view_h__ */
projects / ardour.git / blobdiff