and now without debug printf()
[ardour.git] / libs / gtkmm2ext / gtkmm2ext / dndvbox.h
index 157cd59bef68575f3716626fe021b5a4dc21fec3..3d78a4262753c4c70beaa111c30a047de5292a9d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2009 Paul Davis 
+    Copyright (C) 2009 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
 
 namespace Gtkmm2ext {
 
-/** Parent class for children of a DnDVBox */  
+/** Parent class for children of a DnDVBox */
 class /*LIBGTKMM2EXT_API*/ DnDVBoxChild
 {
 public:
        virtual ~DnDVBoxChild () {}
-       
+
        /** @return The widget that is to be put into the DnDVBox */
        virtual Gtk::Widget& widget () = 0;
-       
+
        /** @return An EventBox containing the widget that should be used for selection, dragging etc. */
        virtual Gtk::EventBox& action_widget () = 0;
 
@@ -41,6 +41,13 @@ public:
 
        /** Set the child's visual state */
        virtual void set_visual_state (VisualState, bool onoff) = 0;
+
+       /** @return True if the child can be selected in the list ( if you don't want it to copy/paste/drag then turn this off ) */
+       virtual bool is_selectable () const = 0;
+
+       virtual bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &) { return false; }
+
+       virtual bool can_copy_state (DnDVBoxChild*) const = 0;
 };
 
 /** A VBox whose contents can be dragged and dropped */
@@ -48,9 +55,14 @@ template <class T>
 class /*LIBGTKMM2EXT_API*/ DnDVBox : public Gtk::EventBox
 {
 public:
-       DnDVBox () : _active (0), _drag_icon (0), _expecting_unwanted_button_event (false), _placeholder (0)
+       DnDVBox (std::list<Gtk::TargetEntry> targets)
+               : _targets (targets)
+               , _active (0)
+               , _drag_icon (0)
+               , _expecting_unwanted_button_event (false)
+               , _placeholder (0)
+               , _drag_child (0)
        {
-               _targets.push_back (Gtk::TargetEntry ("processor"));
 
                add (_internal_vbox);
                add_events (
@@ -65,30 +77,34 @@ public:
                signal_drag_leave().connect (mem_fun (*this, &DnDVBox::drag_leave));
 
                _internal_vbox.show ();
-               
-               drag_dest_set (_targets);
+
+               drag_dest_set (_targets, Gtk::DEST_DEFAULT_ALL, Gdk::DragAction (Gdk::ACTION_COPY | Gdk::ACTION_MOVE | Gdk::ACTION_LINK));
                signal_drag_data_received().connect (mem_fun (*this, &DnDVBox::drag_data_received));
        }
-       
+
        virtual ~DnDVBox ()
        {
                clear ();
-               
+
                delete _drag_icon;
        }
 
        /** Add a child at the end of the widget.  The DnDVBox will take responsibility for deleting the child */
-       void add_child (T* child)
+       void add_child (T* child, std::list<Gtk::TargetEntry> targets = std::list<Gtk::TargetEntry>())
        {
-               child->action_widget().drag_source_set (_targets);
+               if (targets.empty ()) {
+                       child->action_widget().drag_source_set (_targets);
+               } else {
+                       child->action_widget().drag_source_set (targets);
+               }
                child->action_widget().signal_drag_begin().connect (sigc::bind (mem_fun (*this, &DnDVBox::drag_begin), child));
                child->action_widget().signal_drag_data_get().connect (sigc::bind (mem_fun (*this, &DnDVBox::drag_data_get), child));
                child->action_widget().signal_drag_end().connect (sigc::bind (mem_fun (*this, &DnDVBox::drag_end), child));
                child->action_widget().signal_button_press_event().connect (sigc::bind (mem_fun (*this, &DnDVBox::button_press), child));
                child->action_widget().signal_button_release_event().connect (sigc::bind (mem_fun (*this, &DnDVBox::button_release), child));
-               
+
                _internal_vbox.pack_start (child->widget(), false, false);
-               
+
                _children.push_back (child);
                child->widget().show ();
        }
@@ -115,7 +131,7 @@ public:
                return _selection;
        }
 
-       /** Set the `active' child; this is simply a child which is set to have the 
+       /** Set the `active' child; this is simply a child which is set to have the
         *  visual state "active" for whatever purposes the client may have.
         *  @param c Child, or 0 for none.
         */
@@ -177,7 +193,7 @@ public:
                T* after;
 
                std::pair<T*, double> r;
-               
+
                r.second = get_children_around_position (y, &before, &r.first, &after);
 
                return r;
@@ -203,7 +219,7 @@ public:
        {
                return create_or_update_placeholder (get_child_at_position (y).second);
        }
-       
+
        /** Children have been reordered by a drag */
        sigc::signal<void> Reordered;
 
@@ -217,6 +233,7 @@ public:
         *  Parameters are the source DnDVBox, our child which the other one was dropped on (or 0) and the DragContext.
         */
        sigc::signal<void, DnDVBox*, T*, Glib::RefPtr<Gdk::DragContext> const & > DropFromAnotherBox;
+       sigc::signal<void, Gtk::SelectionData const &, T*, Glib::RefPtr<Gdk::DragContext> const & > DropFromExternal;
        sigc::signal<void> SelectionChanged;
 
 private:
@@ -238,7 +255,7 @@ private:
 
                return bottom;
        }
-       
+
        /** Look at a y coordinate and find the children below y, and the ones either side.
         *  @param y y position.
         *  @param before Filled in with the child before, or 0.
@@ -267,7 +284,7 @@ private:
                while (y >= bottom && j != _children.end()) {
 
                        top = bottom;
-                       
+
                        *before = *j;
                        ++i;
                        ++j;
@@ -294,13 +311,13 @@ private:
        void drag_begin (Glib::RefPtr<Gdk::DragContext> const & context, T* child)
        {
                _drag_child = child;
-               
+
                /* make up an icon for the drag */
                _drag_icon = new Gtk::Window (Gtk::WINDOW_POPUP);
-               
+
                Gtk::Allocation a = child->action_widget().get_allocation ();
                _drag_icon->set_size_request (a.get_width(), a.get_height());
-               
+
                _drag_icon->signal_expose_event().connect (sigc::mem_fun (*this, &DnDVBox::icon_expose));
                _drag_icon->set_name (get_name ());
 
@@ -314,7 +331,7 @@ private:
                int w, h;
                _drag_icon->get_size (w, h);
                _drag_icon->drag_set_as_icon (context, w / 2, h / 2);
-               
+
                _drag_source = this;
        }
 
@@ -333,22 +350,30 @@ private:
                cairo_rectangle (cr, 0, 0, w, h);
                cairo_fill (cr);
                cairo_destroy (cr);
-               
+
                return false;
        }
-       
-       void drag_data_get (Glib::RefPtr<Gdk::DragContext> const &, Gtk::SelectionData & selection_data, guint, guint, T* child)
+
+       void drag_data_get (Glib::RefPtr<Gdk::DragContext> const &context, Gtk::SelectionData & selection_data, guint, guint, T* child)
        {
-               selection_data.set (selection_data.get_target(), 8, (const guchar *) &child, sizeof (&child));
+               if (!child->drag_data_get(context, selection_data)) {
+                       selection_data.set (selection_data.get_target(), 8, (const guchar *) &child, sizeof (&child));
+               }
        }
-       
+
        void drag_data_received (
                Glib::RefPtr<Gdk::DragContext> const & context, int /*x*/, int y, Gtk::SelectionData const & selection_data, guint /*info*/, guint time
                )
        {
                /* work out where it was dropped */
                std::pair<T*, double> const drop = get_child_at_position (y);
-               
+
+               if (selection_data.get_target () != _targets.front ().get_target ()) {
+                       DropFromExternal (selection_data, drop.first, context);
+                       context->drag_finish (false, false, time);
+                       return;
+               }
+
                if (_drag_source == this) {
 
                        /* dropped from ourselves onto ourselves */
@@ -361,7 +386,7 @@ private:
 
                                /* where in the list this child should be dropped */
                                int target = drop.second + 0.5;
-                               
+
                                /* find out whether the child was `picked up' from before the drop position */
                                int n = 0;
                                typename std::list<T*>::const_iterator i = _children.begin ();
@@ -369,31 +394,31 @@ private:
                                        ++i;
                                        ++n;
                                }
-                               
+
                                /* if so, adjust the drop position to account for this */
                                if (n < target) {
                                        --target;
                                }
-                               
+
                                _internal_vbox.reorder_child (child->widget(), target);
                        }
-                       
+
                } else {
-                       
+
                        /* drag started in another DnDVBox; raise a signal to say what happened */
-                       
+
                        std::list<T*> dropped = _drag_source->selection ();
                        DropFromAnotherBox (_drag_source, drop.first, context);
                }
-               
+
                context->drag_finish (false, false, time);
        }
-       
+
        void drag_end (Glib::RefPtr<Gdk::DragContext> const &, T *)
        {
                delete _drag_icon;
                _drag_icon = 0;
-               
+
                _drag_child = 0;
                remove_placeholder ();
 
@@ -418,21 +443,33 @@ private:
                return n;
        }
 
-       bool drag_motion (Glib::RefPtr<Gdk::DragContext> const &, int /*x*/, int y, guint)
+       bool drag_motion (Glib::RefPtr<Gdk::DragContext> const & ctx, int /*x*/, int y, guint tme)
        {
                if (_children.empty ()) {
                        return false;
                }
 
                T* before;
-               T* at;
+               T* at = NULL;
                T* after;
 
                /* decide where we currently are */
                double const c = get_children_around_position (y, &before, &at, &after);
 
                /* whether we're in the top or bottom half of the child that we're over */
-               bool top_half = (c - int (c)) < 0.5;
+               bool top_half = (c - int (c)) < .5;
+               bool bottom_half = !top_half;
+
+               if (_drag_source != this /* re-order */
+                               && _drag_source && at
+                               && _drag_source->_drag_child
+                               && _drag_source->selection ().size () == 1
+                               && at != _drag_source->_drag_child // can't happen or can it?
+                               && at->can_copy_state (_drag_source->_drag_child))
+               {
+                       top_half = (c - int (c)) < 0.33;
+                       bottom_half = (c - int (c)) > 0.8; // increase area >> 0.66; plugin below will move, or there's space
+               }
 
                /* Note that when checking on whether to remove a placeholder, we never do
                   so if _drag_child is 0 as this means that the child being dragged is
@@ -446,14 +483,24 @@ private:
                        return false;
                }
 
-               if (!top_half && _drag_child && (at == _drag_child || after == _drag_child)) {
+               if (bottom_half && _drag_child && (at == _drag_child || after == _drag_child)) {
                        /* dropping here would have no effect, so remove the visual cue */
                        remove_placeholder ();
                        return false;
                }
 
-               create_or_update_placeholder (c);
-               return false;
+               if (top_half || bottom_half) {
+                       create_or_update_placeholder (c);
+                       if (_drag_source == this /* re-order */) {
+                               ctx->drag_status (Gdk::ACTION_MOVE, tme);
+                       } else {
+                               ctx->drag_status (Gdk::ACTION_COPY, tme);
+                       }
+               } else {
+                       ctx->drag_status (Gdk::ACTION_LINK, tme);
+                       remove_placeholder ();
+               }
+               return true;
        }
 
        void drag_leave (Glib::RefPtr<Gdk::DragContext> const &, guint)
@@ -471,7 +518,7 @@ private:
                if (child) {
                        _expecting_unwanted_button_event = true;
                }
-                       
+
                if (ev->button == 1 || ev->button == 3) {
 
                        if (!selected (child)) {
@@ -489,7 +536,7 @@ private:
                                                if (selecting && !was_selected) {
                                                        add_to_selection (*i);
                                                }
-                                               
+
                                                if (!selecting && !done) {
                                                        if (selected (*i)) {
                                                                selecting = true;
@@ -506,19 +553,19 @@ private:
                                        }
 
                                } else {
-                                               
+
                                        if ((ev->state & Gdk::CONTROL_MASK) == 0) {
                                                clear_selection ();
                                        }
-                                       
+
                                        if (child) {
                                                add_to_selection (child);
                                        }
 
                                }
-                               
+
                                SelectionChanged (); /* EMIT SIGNAL */
-                               
+
                        } else {
                                /* XXX THIS NEEDS GENERALIZING FOR OS X */
                                if (ev->button == 1 && (ev->state & Gdk::CONTROL_MASK)) {
@@ -532,7 +579,7 @@ private:
 
                return ButtonPress (ev, child); /* EMIT SIGNAL */
        }
-       
+
        bool button_release (GdkEventButton* ev, T* child)
        {
                if (_expecting_unwanted_button_event == true && child == 0) {
@@ -562,9 +609,11 @@ private:
                        setup_child_state (*i);
                }
        }
-       
+
        void add_to_selection (T* child)
        {
+               if ( !child->is_selectable() )
+                       return;
                _selection.push_back (child);
                setup_child_state (child);
        }
@@ -578,21 +627,21 @@ private:
                        setup_child_state (c);
                }
        }
-               
+
        T* child_from_widget (Gtk::Widget const * w) const
        {
                typename std::list<T*>::const_iterator i = _children.begin();
                while (i != _children.end() && &(*i)->widget() != w) {
                        ++i;
                }
-               
+
                if (i == _children.end()) {
                        return 0;
                }
 
                return *i;
        }
-       
+
        Gtk::VBox _internal_vbox;
        std::list<Gtk::TargetEntry> _targets;
        std::list<T*> _children;
@@ -606,12 +655,12 @@ private:
        Gtk::Label* _placeholder;
        /** Our child being dragged, or 0 */
        T* _drag_child;
-       
+
        static DnDVBox* _drag_source;
-       
+
 };
 
 template <class T>
 DnDVBox<T>* DnDVBox<T>::_drag_source = 0;
-       
+
 }