time_axis_view_item.h

Go to the documentation of this file.

/*
    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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __gtk_ardour_time_axis_view_item_h__
#define __gtk_ardour_time_axis_view_item_h__

#include <string>
#include <gdk/gdk.h>
#include <gdkmm/color.h>
#include <pangomm/fontdescription.h>
#include "pbd/signals.h"
#include "selectable.h"

class TimeAxisView;

namespace ArdourCanvas {
        class Pixbuf;
        class Rectangle;
        class Item;
        class Container;
        class Text;
}

using ARDOUR::framepos_t;
using ARDOUR::framecnt_t;

class TimeAxisViewItem : public Selectable, public PBD::ScopedConnectionList
{
   public:
        virtual ~TimeAxisViewItem();

        virtual bool set_position(framepos_t, void*, double* delta = 0);
        framepos_t get_position() const;
        virtual bool set_duration(framecnt_t, void*);
        framecnt_t get_duration() const;
        virtual void set_max_duration(framecnt_t, void*);
        framecnt_t get_max_duration() const;
        virtual void set_min_duration(framecnt_t, void*);
        framecnt_t get_min_duration() const;
        virtual void set_position_locked(bool, void*);
        bool get_position_locked() const;
        void set_max_duration_active(bool, void*);
        bool get_max_duration_active() const;
        void set_min_duration_active(bool, void*);
        bool get_min_duration_active() const;
        void set_item_name(std::string, void*);
        virtual std::string get_item_name() const;
        virtual void set_selected(bool yn);
        void set_sensitive (bool yn) { _sensitive = yn; }
        bool sensitive () const { return _sensitive; }
        TimeAxisView& get_time_axis_view () const;
        void set_name_text(const std::string&);
        virtual void set_height(double h);
        virtual double height() const { return _height; }
        void set_y (double);
        void set_color (uint32_t);
        void set_name_text_color ();

        virtual uint32_t get_fill_color () const;

        ArdourCanvas::Item* get_canvas_frame();
        ArdourCanvas::Item* get_canvas_group();
        ArdourCanvas::Item* get_name_highlight();

        virtual void set_samples_per_pixel (double);

        double get_samples_per_pixel () const;

        virtual void drag_start();
        virtual void drag_end();
        bool dragging() const { return _dragging; }

        virtual void raise () { return; }
        virtual void raise_to_top () { return; }
        virtual void lower () { return; }
        virtual void lower_to_bottom () { return; }

        bool name_active() const { return name_connected; }

        // Default sizes, font and spacing
        static Pango::FontDescription NAME_FONT;
        static void set_constant_heights ();
        static const double NAME_X_OFFSET;
        static const double GRAB_HANDLE_TOP;
        static const double GRAB_HANDLE_WIDTH;

        /* these are not constant, but vary with the pixel size
           of the font used to display the item name.
        */
        static int    NAME_HEIGHT;
        static double NAME_Y_OFFSET;
        static double NAME_HIGHLIGHT_SIZE;
        static double NAME_HIGHLIGHT_THRESH;

        sigc::signal<void,std::string,void*> ItemRemoved;

        sigc::signal<void,std::string,std::string,void*> NameChanged;

        sigc::signal<void,framepos_t,void*> PositionChanged;

        sigc::signal<void,bool,void*> PositionLockChanged;

        sigc::signal<void,framecnt_t,void*> DurationChanged;

        sigc::signal<void,framecnt_t,void*> MaxDurationChanged;

        sigc::signal<void,framecnt_t,void*> MinDurationChanged;

        enum Visibility {
                ShowFrame = 0x1,
                ShowNameHighlight = 0x2,
                ShowNameText = 0x4,
                ShowHandles = 0x8,
                HideFrameLeft = 0x10,
                HideFrameRight = 0x20,
                HideFrameTB = 0x40,
                FullWidthNameHighlight = 0x80
        };

  protected:
        TimeAxisViewItem (const std::string &, ArdourCanvas::Item&, TimeAxisView&, double, uint32_t fill_color,
                          framepos_t, framecnt_t, bool recording = false, bool automation = false, Visibility v = Visibility (0));

        TimeAxisViewItem (const TimeAxisViewItem&);

        void init (ArdourCanvas::Item*, double, uint32_t, framepos_t, framepos_t, Visibility, bool, bool);

        virtual bool canvas_group_event (GdkEvent*);

        virtual void set_colors();
        virtual void set_frame_color();
        virtual void set_frame_gradient ();
        void set_trim_handle_colors();

        virtual void reset_width_dependent_items (double);

        static gint idle_remove_this_item(TimeAxisViewItem*, void*);

        TimeAxisView& trackview;

        bool position_locked;

        framepos_t frame_position;

        framecnt_t item_duration;

        framecnt_t max_item_duration;

        framecnt_t min_item_duration;

        bool max_duration_active;

        bool min_duration_active;

        double samples_per_pixel;

        bool _sensitive;

        std::string item_name;

        bool name_connected;

        bool show_vestigial;

        uint32_t fill_color;

        uint32_t last_item_width;
        int name_text_width;
        bool wide_enough_for_name;
        bool high_enough_for_name;

        ArdourCanvas::Container*      group;
        ArdourCanvas::Rectangle* vestigial_frame;
        ArdourCanvas::Rectangle* frame;
        ArdourCanvas::Rectangle* selection_frame;
        ArdourCanvas::Text*      name_text;
        ArdourCanvas::Rectangle* name_highlight;

        /* with these two values, if frame_handle_start == 0 then frame_handle_end will also be 0 */
        ArdourCanvas::Rectangle* frame_handle_start; 
        ArdourCanvas::Rectangle* frame_handle_end; 

        bool frame_handle_crossing (GdkEvent*, ArdourCanvas::Rectangle*);

        double _height;
        Visibility visibility;
        std::string fill_color_name;
        bool _recregion;
        bool _automation; 
        bool _dragging;

private:
        double _width;

        void parameter_changed (std::string);
        void manage_name_highlight ();
        void manage_name_text ();

}; /* class TimeAxisViewItem */

#endif /* __gtk_ardour_time_axis_view_item_h__ */