Assorted doxygen fixes; no functional changes.
[ardour.git] / libs / gtkmm2ext / gtkmm2ext / dndvbox.h
index 486f31f0842af57ac68c497821d13ba06c9ef062..e0b1c6ea1338adcf0447c6dc6ba066a5d232bcec 100644 (file)
@@ -35,6 +35,9 @@ public:
 
        /** @return Text to use in the icon that is dragged */
        virtual std::string drag_text () const = 0;
+
+       /** Set the child's visual state */
+       virtual void set_visual_state (Gtk::StateType) = 0;
 };
 
 /** A VBox whose contents can be dragged and dropped */
@@ -42,15 +45,23 @@ template <class T>
 class DnDVBox : public Gtk::EventBox
 {
 public:
-       DnDVBox () : _drag_icon (0), _expecting_unwanted_button_event (false)
+       DnDVBox () : _active (0), _drag_icon (0), _expecting_unwanted_button_event (false), _drag_placeholder (0)
        {
                _targets.push_back (Gtk::TargetEntry ("processor"));
 
                add (_internal_vbox);
-               add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK | Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK | Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
+               add_events (
+                       Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK |
+                       Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK |
+                       Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK
+                       );
 
                signal_button_press_event().connect (bind (mem_fun (*this, &DnDVBox::button_press), (T *) 0));
                signal_button_release_event().connect (bind (mem_fun (*this, &DnDVBox::button_release), (T *) 0));
+               signal_drag_motion().connect (mem_fun (*this, &DnDVBox::drag_motion));
+               signal_drag_leave().connect (mem_fun (*this, &DnDVBox::drag_leave));
+
+               _internal_vbox.show ();
                
                drag_dest_set (_targets);
                signal_drag_data_received().connect (mem_fun (*this, &DnDVBox::drag_data_received));
@@ -76,7 +87,7 @@ public:
                _internal_vbox.pack_start (child->widget(), false, false);
                
                _children.push_back (child);
-               child->widget().show_all ();
+               child->widget().show ();
        }
 
        /** @return Children, sorted into the order that they are currently being displayed in the widget */
@@ -101,8 +112,24 @@ public:
                return _selection;
        }
 
-       /** @param Child
-        *  @return true if the child is selected, otherwise false */
+       /** Set the `active' child; this is simply a child which is set to have the Gtk
+        *  STATE_ACTIVE for whatever purposes the client may have.
+        *  @param c Child, or 0 for none.
+        */
+       void set_active (T* c) {
+               T* old_active = _active;
+               _active = c;
+               if (old_active) {
+                       setup_child_state (old_active);
+               }
+               if (_active) {
+                       setup_child_state (_active);
+               }
+       }
+
+       /** @param child Child
+        *  @return true if the child is selected, otherwise false.
+        */
        bool selected (T* child) const {
                return (find (_selection.begin(), _selection.end(), child) != _selection.end());
        }
@@ -118,9 +145,9 @@ public:
                }
 
                _children.clear ();
+               _active = 0;
        }
 
-
        void select_all ()
        {
                clear_selection ();
@@ -138,32 +165,77 @@ public:
                SelectionChanged (); /* EMIT SIGNAL */
        }
 
-       /** @param x x coordinate.
-        *  @param y y coordinate.
-        *  @return Pair consisting of the child under (x, y) (or 0) and the index of the child under (x, y) (or -1)
+       /** 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.
+        *  @param at Filled in with the child under y, or 0.
+        *  @param after Filled in with the child after, or 0.
+        *  @return Fractional position in terms of child height, or -1 if not over a child.
         */
-       std::pair<T*, int> get_child_at_position (int /*x*/, int y) const
+       double get_children_around_position (int y, T** before, T** at, T** after) const
        {
-               std::list<Gtk::Widget const *> children = _internal_vbox.get_children ();
-               std::list<Gtk::Widget const *>::iterator i = children.begin();
-               
-               int n = 0;
-               while (i != children.end()) {
-                       Gdk::Rectangle const a = (*i)->get_allocation ();
-                       if (y >= a.get_y() && y <= (a.get_y() + a.get_height())) {
-                               break;
-                       }
+               if (_children.empty()) {
+                       *before = *at = *after = 0;
+                       return -1;
+               }
+
+               *before = 0;
+
+               typename std::list<T*>::const_iterator j = _children.begin ();
+
+               /* index of current child */
+               int i = 0;
+               /* top of current child */
+               double top = 0;
+               /* bottom of current child */
+               double bottom = (*j)->widget().get_allocation().get_height ();
+
+               while (y >= bottom && j != _children.end()) {
+
+                       top = bottom;
+                       
+                       *before = *j;
                        ++i;
-                       ++n;
+                       ++j;
+
+                       if (j != _children.end()) {
+                               bottom += (*j)->widget().get_allocation().get_height ();
+                       }
                }
-               
-               if (i == children.end()) {
-                       return std::make_pair ((T *) 0, -1);
+
+               if (j == _children.end()) {
+                       *at = 0;
+                       *after = 0;
+                       return -1;
                }
 
-               return std::make_pair (child_from_widget (*i), n);
-       }       
+               *at = *j;
+
+               ++j;
+               *after = j != _children.end() ? *j : 0;
+
+               return i + ((y - top) / (*at)->widget().get_allocation().get_height());
+       }
+
+       /** @param y y coordinate.
+        *  @return Pair consisting of the child under y (or 0) and the (fractional) index of the child under y (or -1)
+        */
+       std::pair<T*, double> get_child_at_position (int y) const
+       {
+               T* before;
+               T* after;
+
+               std::pair<T*, double> r;
+               
+               r.second = get_children_around_position (y, &before, &r.first, &after);
 
+               return r;
+       }
+
+       void set_spacing (int s) {
+               _internal_vbox.set_spacing (s);
+       }
        /** Children have been reordered by a drag */
        sigc::signal<void> Reordered;
 
@@ -182,19 +254,52 @@ public:
 private:
        void drag_begin (Glib::RefPtr<Gdk::DragContext> const & context, T* child)
        {
+               _drag_child = child;
+               
                /* make up an icon for the drag */
-               Gtk::Window* _drag_icon = new Gtk::Window (Gtk::WINDOW_POPUP);
+               _drag_icon = new Gtk::Window (Gtk::WINDOW_POPUP);
+               
+               Gtk::Allocation a = child->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 ());
-               Gtk::Label* l = new Gtk::Label (child->drag_text ());
-               l->set_padding (4, 4);
-               _drag_icon->add (*Gtk::manage (l));
-               _drag_icon->show_all_children ();
+
+               /* make the icon transparent if possible */
+               Glib::RefPtr<Gdk::Screen const> s = _drag_icon->get_screen ();
+               Glib::RefPtr<Gdk::Colormap const> c = s->get_rgba_colormap ();
+               if (c) {
+                       _drag_icon->set_colormap (c);
+                       _have_alpha = true;
+               } else {
+                       _have_alpha = false;
+               }
+
                int w, h;
                _drag_icon->get_size (w, h);
-               _drag_icon->drag_set_as_icon (context, w / 2, h);
+               _drag_icon->drag_set_as_icon (context, w / 2, h / 2);
                
                _drag_source = this;
        }
+
+       /* Draw the drag icon */
+       bool icon_expose (GdkEventExpose* ev)
+       {
+               /* Just grab the child's widget and use that */
+
+               int w, h;
+               _drag_icon->get_size (w, h);
+
+               cairo_t* cr = gdk_cairo_create (_drag_icon->get_window()->gobj ());
+
+               Glib::RefPtr<Gdk::Pixmap> p = _drag_child->widget().get_snapshot();
+               gdk_cairo_set_source_pixmap (cr, p->gobj(), 0, 0);
+               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)
        {
@@ -206,19 +311,37 @@ private:
                )
        {
                /* work out where it was dropped */
-               std::pair<T*, int> const drop = get_child_at_position (x, y);
+               std::pair<T*, double> const drop = get_child_at_position (y);
+
+               
                
                if (_drag_source == this) {
 
                        /* dropped from ourselves onto ourselves */
-                       
+
                        T* child = *((T **) selection_data.get_data());
-                       
-                       /* reorder child widgets accordingly */
+
                        if (drop.first == 0) {
                                _internal_vbox.reorder_child (child->widget(), -1);
                        } else {
-                               _internal_vbox.reorder_child (child->widget(), drop.second);
+
+                               /* 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 ();
+                               while (i != _children.end() && *i != child && n < target) {
+                                       ++i;
+                                       ++n;
+                               }
+                               
+                               /* if so, adjust the drop position to account for this */
+                               if (n < target) {
+                                       --target;
+                               }
+                               
+                               _internal_vbox.reorder_child (child->widget(), target);
                        }
                        
                } else {
@@ -236,10 +359,72 @@ private:
        {
                delete _drag_icon;
                _drag_icon = 0;
+               
+               _drag_child = 0;
+               remove_drag_placeholder ();
 
                Reordered (); /* EMIT SIGNAL */
        }
-       
+
+       void remove_drag_placeholder ()
+       {
+               if (_drag_placeholder) {
+                       _internal_vbox.remove (*_drag_placeholder);
+                       _drag_placeholder = 0;
+               }
+       }
+
+       bool drag_motion (Glib::RefPtr<Gdk::DragContext> const &, int x, int y, guint)
+       {
+               if (_children.empty ()) {
+                       return false;
+               }
+
+               T* before;
+               T* at;
+               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;
+
+               if (top_half && (before == _drag_child || at == _drag_child)) {
+                       /* dropping here would have no effect, so remove the visual cue */
+                       remove_drag_placeholder ();
+                       return false;
+               }
+
+               if (!top_half && (at == _drag_child || after == _drag_child)) {
+                       /* dropping here would have no effect, so remove the visual cue */
+                       remove_drag_placeholder ();
+                       return false;
+               }
+
+               /* the index that the placeholder should be put at */
+               int const n = int (c + 0.5);
+               
+               if (_drag_placeholder == 0) {
+                       _drag_placeholder = manage (new Gtk::Label (""));
+                       _internal_vbox.pack_start (*_drag_placeholder, false, false);
+                       _drag_placeholder->show ();
+               }
+
+               if (c < 0) {
+                       _internal_vbox.reorder_child (*_drag_placeholder, -1);
+               } else {
+                       _internal_vbox.reorder_child (*_drag_placeholder, n);
+               }
+
+               return false;
+       }
+
+       void drag_leave (Glib::RefPtr<Gdk::DragContext> const &, guint)
+       {
+               remove_drag_placeholder ();
+       }
+
        bool button_press (GdkEventButton* ev, T* child)
        {
                if (_expecting_unwanted_button_event == true && child == 0) {
@@ -252,12 +437,52 @@ private:
                }
                        
                if (ev->button == 1 || ev->button == 3) {
+
                        if (!selected (child)) {
-                               clear_selection ();
-                               if (child) {
-                                       add_to_selection (child);
+
+                               if ((ev->state & Gdk::SHIFT_MASK) && !_selection.empty()) {
+
+                                       /* Shift-click; select all between the clicked child and any existing selections */
+
+                                       bool selecting = false;
+                                       bool done = false;
+                                       for (typename std::list<T*>::const_iterator i = _children.begin(); i != _children.end(); ++i) {
+
+                                               bool const was_selected = selected (*i);
+
+                                               if (selecting && !was_selected) {
+                                                       add_to_selection (*i);
+                                               }
+                                               
+                                               if (!selecting && !done) {
+                                                       if (selected (*i)) {
+                                                               selecting = true;
+                                                       } else if (*i == child) {
+                                                               selecting = true;
+                                                               add_to_selection (child);
+                                                       }
+                                               } else if (selecting) {
+                                                       if (was_selected || *i == child) {
+                                                               selecting = false;
+                                                               done = true;
+                                                       }
+                                               }
+                                       }
+
+                               } 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)) {
@@ -287,27 +512,41 @@ private:
                return ButtonRelease (ev, child); /* EMIT SIGNAL */
        }
 
-       void clear_selection ()
+       /** Setup a child's GTK state correctly */
+       void setup_child_state (T* c)
        {
-               for (typename std::list<T*>::iterator i = _selection.begin(); i != _selection.end(); ++i) {
-                       (*i)->action_widget().set_state (Gtk::STATE_NORMAL);
+               assert (c);
+               
+               if (c == _active) {
+                       c->set_visual_state (Gtk::STATE_ACTIVE);
+               } else if (selected (c)) {
+                       c->set_visual_state (Gtk::STATE_SELECTED);
+               } else {
+                       c->set_visual_state (Gtk::STATE_NORMAL);
                }
+       }
+
+       void clear_selection ()
+       {
+               std::list<T*> old_selection = _selection;
                _selection.clear ();
+               for (typename std::list<T*>::iterator i = old_selection.begin(); i != old_selection.end(); ++i) {
+                       setup_child_state (*i);
+               }
        }
        
        void add_to_selection (T* child)
        {
-               child->action_widget().set_state (Gtk::STATE_SELECTED);
                _selection.push_back (child);
+               setup_child_state (child);
        }
-               
-       
+
        void remove_from_selection (T* child)
        {
                typename std::list<T*>::iterator x = find (_selection.begin(), _selection.end(), child);
                if (x != _selection.end()) {
-                       child->action_widget().set_state (Gtk::STATE_NORMAL);
                        _selection.erase (x);
+                       setup_child_state (*x);
                }
        }
                
@@ -329,10 +568,20 @@ private:
        std::list<Gtk::TargetEntry> _targets;
        std::list<T*> _children;
        std::list<T*> _selection;
+       T* _active;
        Gtk::Window* _drag_icon;
        bool _expecting_unwanted_button_event;
-
+       /** A blank label used as a placeholder to indicate where a dragged item would
+        *  go if it were dropped now.
+        */
+       Gtk::Label* _drag_placeholder;
+       /** Our child being dragged, or 0 */
+       T* _drag_child;
+       /** true if we can have an alpha-blended drag icon */
+       bool _have_alpha;
+       
        static DnDVBox* _drag_source;
+       
 };
 
 template <class T>