Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-74606

floating QDockWidget with native child widget fails to show() after closing it

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Reported
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: 5.11, 5.12.2
    • Fix Version/s: None
    • Component/s: Widgets: Main Window
    • Labels:
      None
    • Platform/s:
      Windows

      Description

      In Qt 5.11 and 5.12 native widgets inside a QDockWidget cause strange behavior. If the dock widget is closed via the Close button in docked state, via hide(), or by using toggleViewAction(), things are ok. Only if the Close button in floating state is used, the dock widget won't show() again. The apparent problem is that the latter will destroy the underlying QWidgetWindow resources in a way that show() won't recreate them.

       

      Steps to reproduce:

      1. open the original Dock Widgets Example in Qt Creator
      2. in MainWindow::createDockWindows(), add the line "customerList->winId();" after the line "viewMenu->addAction(dock->toggleViewAction());"
      3. run the example
      4. close the docked "Customers" dock widget by using the menu "View->Customers"
      5. show the "Customers" dock widget again by using the menu "View->Customers"
      6. close the docked "Customers" dock widget by pressing its close button
      7. show the "Customers" dock widget again by using the menu "View->Customers"
      8. undock the "Customers" dock widget
      9. close the floating "Customers" dock widget by using the menu "View->Customers"
      10. show the "Customers" dock widget again by using the menu "View->Customers"
      11. close the floating "Customers" dock widget by pressing its close button
      12. show the "Customers" dock widget again by using the menu "View->Customers"

      Expected result: showing the dock widget (steps 5, 7, 10, 12) makes it visible in its previous location

      Actual result: step 12 fails to make the dock widget visible

      Notes:

      • steps 4-7 and 9-10 are not needed to reproduce the issue. They only demonstrate things are working properly.
      • The issue can be reproduced in earlier versions. In our application it showed first time when upgrading from 5.11.1 to 5.12.0, but the example reproduces the issue in 5.11.0.
      • Our application uses Direct3D rendering in a widget inside the dock widget, hence the winId() call.
      • I did some more investigation and found the difference to be a close event being first delivered to the internal QWidgetWindow in step 11, which destroys its resources in a way that the next QDockWidget::show() won't recreate them.
      • In our application, the change that made the issue surface in 5.12 is this: https://code.qt.io/cgit/qt/qtbase.git/commit/src/widgets/kernel/qwidgetwindow.cpp?id=e0b5ff4ad583befbecbcbe462998e3ed80899531, but as mentioned, the actual problem exists in 5.11 (and probably earlier) already.
      • I only use Windows, I don't know if the same issue exists on other platforms

       

      Based on my investigation I found a workaround: Implement an event filter like this (for the dock widget example)

       

      bool MainWindow::eventFilter(QObject *obj, QEvent *event)
      {
          if (event->type()==QEvent::Close) {
              if (nativeDock && obj==nativeDock->windowHandle()) {
                  nativeDock->hide();
                  return true;
              }
          }
      
          return false;
      }

      and add it to qApp (nativeDock is a pointer to the QDockWidget containing a native child). This filter intercepts the offending close event to the QWidgetWindow and turns it into a working hide() call on the dock widget. While this workaround stops the issue, I don't know if it causes resource leaks.

       

      I attached the modified dock widget example including the disabled workaround. I marked my changes with "// NEW". Uncommenting line mainwindow.cpp:339 will enable the workaround.

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            • Assignee:
              qt.team.quick.subscriptions Qt Quick and Widgets Team
              Reporter:
              haik Haik Lorenz
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Gerrit Reviews

                There are no open Gerrit changes