Show parent layer names in "Move Object to Layer" menu (mapeditor#3811)

Also reversed the order of the layers, to match the order in the Layers
and Objects views.

Move-to-layer menu implementation is now shared between object tools and
objects dock.

Added object group icon to the menu items.

Closes mapeditor#3454

NEWS.md

@@ -1,6 +1,7 @@
 ### Unreleased
 
 * Added --project command-line parameter for use when exporting (#3797)
+* Added group layer names in "Move Object to Layer" menu (#3454)
 * Made adding "Copy" when duplicating optional and disabled by default (#3917)
 * Layer names are now trimmed when edited in the UI, to avoid accidental whitespace
 * Scripting: Added API for working with worlds (#3539)

src/tiled/abstractobjecttool.cpp

@@ -27,6 +27,7 @@
 #include "changetileobjectgroup.h"
 #include "documentmanager.h"
 #include "mapdocument.h"
+#include "mapdocumentactionhandler.h"
 #include "map.h"
 #include "mapobject.h"
 #include "mapobjectitem.h"
@@ -708,18 +709,13 @@ void AbstractObjectTool::showContextMenu(MapObject *clickedObject,
         menu.addAction(tr("Lower Object to Bottom"), this, &AbstractObjectTool::lowerToBottom, Qt::Key_End);
     }
 
-    auto objectGroups = mapDocument()->map()->objectGroups();
-    auto objectGroupsIterator = objectGroups.begin();
-    if (objectGroupsIterator != objectGroups.end() && objectGroupsIterator.next()) {
+    if (LayerIterator(mapDocument()->map(), Layer::ObjectGroupType).next()) {
         menu.addSeparator();
         QMenu *moveToLayerMenu = menu.addMenu(tr("Move %n Object(s) to Layer",
                                                  "", selectedObjects.size()));
-        for (Layer *layer : objectGroups) {
-            ObjectGroup *objectGroup = static_cast<ObjectGroup*>(layer);
-            QAction *action = moveToLayerMenu->addAction(objectGroup->name());
-            action->setData(QVariant::fromValue(objectGroup));
-            action->setEnabled(objectGroup != sameObjectGroup);
-        }
+
+        auto actionHandler = MapDocumentActionHandler::instance();
+        actionHandler->populateMoveToLayerMenu(moveToLayerMenu, sameObjectGroup);
     }
 
     menu.addSeparator();

src/tiled/mapdocumentactionhandler.cpp

@@ -32,6 +32,7 @@
 #include "map.h"
 #include "mapdocument.h"
 #include "mapobject.h"
+#include "mapobjectmodel.h"
 #include "maprenderer.h"
 #include "mapview.h"
 #include "movelayer.h"
@@ -332,6 +333,43 @@ QMenu *MapDocumentActionHandler::createGroupLayerMenu(QWidget *parent) const
     return groupLayerMenu;
 }
 
+void MapDocumentActionHandler::populateMoveToLayerMenu(QMenu *menu, const ObjectGroup *current)
+{
+    if (!mMapDocument)
+        return;
+
+    const GroupLayer *parentLayer = nullptr;
+
+    LayerIterator objectGroupsIterator(mMapDocument->map(), Layer::ObjectGroupType);
+    objectGroupsIterator.toBack();
+
+    const auto objectGroupIcon = mMapDocument->mapObjectModel()->objectGroupIcon();
+
+    while (auto objectGroup = static_cast<ObjectGroup*>(objectGroupsIterator.previous())) {
+        // Create a separator to indicate the parent layer(s), using "(Parent1/Parent2)".
+        if (parentLayer != objectGroup->parentLayer()) {
+            auto separator = menu->addSeparator();
+            separator->setEnabled(false);
+
+            parentLayer = objectGroup->parentLayer();
+            if (parentLayer) {
+                QStringList parentLayerNames;
+                auto currentParentLayer = parentLayer;
+                while (currentParentLayer) {
+                    parentLayerNames.prepend(currentParentLayer->name());
+                    currentParentLayer = currentParentLayer->parentLayer();
+                }
+
+                separator->setText(parentLayerNames.join(QLatin1String("/")));
+            }
+        }
+
+        QAction *action = menu->addAction(objectGroupIcon, objectGroup->name());
+        action->setData(QVariant::fromValue(objectGroup));
+        action->setEnabled(objectGroup != current);
+    }
+}
+
 /**
  * Used to check whether we can cut or delete the current tile selection.
  */

src/tiled/mapdocumentactionhandler.h

@@ -93,6 +93,8 @@ class MapDocumentActionHandler : public QObject
     QMenu *createNewLayerMenu(QWidget *parent) const;
     QMenu *createGroupLayerMenu(QWidget *parent) const;
 
+    void populateMoveToLayerMenu(QMenu *menu, const ObjectGroup *current);
+
 public slots:
     void cut();
     bool copy();

src/tiled/mapobjectmodel.h

@@ -108,6 +108,8 @@ class MapObjectModel : public QAbstractItemModel
 
     void moveObjects(ObjectGroup *og, int from, int to, int count);
 
+    QIcon objectGroupIcon() const;
+
 private:
     void layerAdded(Layer *layer);
     void layerAboutToBeRemoved(GroupLayer *groupLayer, int index);
@@ -128,4 +130,9 @@ class MapObjectModel : public QAbstractItemModel
     QIcon mObjectGroupIcon;
 };
 
+inline QIcon MapObjectModel::objectGroupIcon() const
+{
+    return mObjectGroupIcon;
+}
+
 } // namespace Tiled

src/tiled/objectsdock.cpp

@@ -23,13 +23,13 @@
 #include "actionmanager.h"
 #include "documentmanager.h"
 #include "filteredit.h"
-#include "grouplayer.h"
 #include "map.h"
 #include "mapdocument.h"
 #include "mapdocumentactionhandler.h"
 #include "mapobject.h"
 #include "objectgroup.h"
 #include "objectsview.h"
+#include "raiselowerhelper.h"
 #include "utils.h"
 
 #include <QBoxLayout>
@@ -74,8 +74,11 @@ ObjectsDock::ObjectsDock(QWidget *parent)
     connect(mActionNewLayer, &QAction::triggered,
             handler->actionAddObjectGroup(), &QAction::trigger);
 
+    QIcon objectsGroupIcon(QLatin1String("://images/16/layer-object.png"));
+    objectsGroupIcon.addFile(QLatin1String("://images/32/layer-object.png"));
+
     mActionMoveToGroup = new QAction(this);
-    mActionMoveToGroup->setIcon(QIcon(QLatin1String(":/images/16/layer-object.png")));
+    mActionMoveToGroup->setIcon(objectsGroupIcon);
 
     mActionMoveUp = new QAction(this);
     mActionMoveUp->setIcon(QIcon(QLatin1String(":/images/16/go-up.png")));
@@ -86,7 +89,7 @@ ObjectsDock::ObjectsDock(QWidget *parent)
     Utils::setThemeIcon(mActionMoveUp, "go-up");
     Utils::setThemeIcon(mActionMoveDown, "go-down");
 
-    QToolBar *toolBar = new QToolBar;
+    auto *toolBar = new QToolBar;
     toolBar->setFloatable(false);
     toolBar->setMovable(false);
     toolBar->setIconSize(Utils::smallIconSize());
@@ -195,17 +198,18 @@ void ObjectsDock::aboutToShowMoveToMenu()
 {
     mMoveToMenu->clear();
 
-    for (Layer *layer : mMapDocument->map()->objectGroups()) {
-        QAction *action = mMoveToMenu->addAction(layer->name());
-        action->setData(QVariant::fromValue(static_cast<ObjectGroup*>(layer)));
-    }
+    auto &selectedObjects = mMapDocument->selectedObjects();
+    auto sameObjectGroup = RaiseLowerHelper::sameObjectGroup(selectedObjects);
+
+    auto handler = MapDocumentActionHandler::instance();
+    handler->populateMoveToLayerMenu(mMoveToMenu, sameObjectGroup);
 }
 
 void ObjectsDock::triggeredMoveToMenu(QAction *action)
 {
     MapDocumentActionHandler *handler = MapDocumentActionHandler::instance();
 
-    ObjectGroup *objectGroup = action->data().value<ObjectGroup*>();
+    auto *objectGroup = action->data().value<ObjectGroup*>();
     handler->moveObjectsToGroup(objectGroup);
 }