DocksController Class Reference

Description

Handles creation and appearance of docked widgets in the context of QMainWindow. It is used for SampleView and JobView which are based on QMainWindow.

Definition at line 30 of file DocksController.h.

Inheritance diagram for DocksController:

Collaboration diagram for DocksController:

Classes
struct	DockSizeInfo

Public Slots
void	dockToMinMaxSizes ()
void	setDockHeightForWidget (int height)
	A hack to request update of QDockWidget size if its child (e.g. InfoWidget) wants it. The problem bypassed here is that there is no direct method to QMainWindow to recalculate position of splitters surrounding given QDockWidget. So our child QWidget requests here the change of Min/Max size of QDockWidget, this will trigger recalculation of QDockWidget layout and will force QDockWidget to respect sizeHints provided by ChildWidget. Later (in one single timer shot) we return min/max sizes of QDockWidget back to re-enable splitters functionality. More...

Public Member Functions
	DocksController (QMainWindow *mainWindow)
void	addDockActionsToMenu (QMenu *menu)
void	addWidget (int id, QWidget *widget, Qt::DockWidgetArea area)
QList< QDockWidget * >	dockWidgets () const
QDockWidget *	findDock (int id)
QDockWidget *	findDock (QWidget *widget)
void	resetLayout ()
void	restoreSettings (const QHash< QString, QVariant > &settings)
void	restoreSettings (const QSettings *settings)
QHash< QString, QVariant >	saveSettings () const
void	saveSettings (QSettings *settings) const
void	setDockVisible (int id, bool visible=true)
void	setVisibleDocks (const std::vector< int > &visibleDocks)
	Show docks with id's from the list. Other docks will be hidden. More...
void	toggleDock (int id)

Private Member Functions
QDockWidget *	addDockForWidget (QWidget *widget)
bool	eventFilter (QObject *, QEvent *event) override
void	handleWindowVisibilityChanged (bool visible)
void	setTrackingEnabled (bool enabled)

Private Attributes
DockSizeInfo	m_dock_info
std::map< int, DockWidgetInfo >	m_docks
bool	m_handleDockVisibilityChanges = true
QMainWindow *	m_mainWindow

Constructor & Destructor Documentation

DocksController()

DocksController::DocksController

(

QMainWindow *

mainWindow

)

Definition at line 43 of file DocksController.cpp.

    : QObject(mainWindow)
    , m_mainWindow(mainWindow)
{
    m_mainWindow->setDocumentMode(true);
    m_mainWindow->setTabPosition(Qt::AllDockWidgetAreas, QTabWidget::South);
    m_mainWindow->setCorner(Qt::BottomLeftCorner, Qt::LeftDockWidgetArea);
    m_mainWindow->setCorner(Qt::BottomRightCorner, Qt::RightDockWidgetArea);
    m_mainWindow->installEventFilter(this);
}

References m_mainWindow.

Member Function Documentation

addDockActionsToMenu()

void DocksController::addDockActionsToMenu

(

QMenu *

menu

)

Definition at line 234 of file DocksController.cpp.

{
    QList<QAction*> actions;
    for (auto* dockWidget : dockWidgets()) {
        if (dockWidget->parentWidget() == m_mainWindow) {
            QAction* action = dockWidget->toggleViewAction();
            action->setText(action->property("original_title").toString());
            actions.append(action);
        }
    }
    std::sort(actions.begin(), actions.end(), [](const QAction* action1, const QAction* action2) {
        return stripAccelerator(action1->text()).toLower()
               < stripAccelerator(action2->text()).toLower();
    });
 
    foreach (QAction* action, actions)
        menu->addAction(action);
}

References dockWidgets(), and m_mainWindow.

Referenced by JobView::fillViewMenu(), and SampleView::fillViewMenu().

Here is the call graph for this function:

addDockForWidget()

QDockWidget * DocksController::addDockForWidget ( QWidget *  widget )

private

Definition at line 54 of file DocksController.cpp.

{
    auto* dockWidget = new QDockWidget(m_mainWindow);
    dockWidget->setWidget(widget);
    dockWidget->setFeatures(QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetClosable
                            | QDockWidget::DockWidgetFloatable);
    dockWidget->setObjectName(widget->objectName() + QLatin1String("DockWidget"));
 
    QString title = widget->windowTitle();
    dockWidget->toggleViewAction()->setProperty("original_title", title);
    title = stripAccelerator(title);
    dockWidget->setWindowTitle(title);
 
    connect(dockWidget->toggleViewAction(), &QAction::triggered, [=]() {
        if (dockWidget->isVisible())
            dockWidget->raise();
    });
 
    connect(dockWidget, &QDockWidget::visibilityChanged, [this, dockWidget](bool visible) {
        if (m_handleDockVisibilityChanges)
            dockWidget->setProperty(dockWidgetActiveState, visible);
    });
 
    dockWidget->setProperty(dockWidgetActiveState, true);
 
    return dockWidget;
}

References m_handleDockVisibilityChanges, and m_mainWindow.

Referenced by addWidget().

addWidget()

void DocksController::addWidget	(	int	id,
		QWidget *	widget,
		Qt::DockWidgetArea	area
	)

Definition at line 82 of file DocksController.cpp.

{
    if (m_docks.find(id) != m_docks.end())
        throw Error("DocksController::addWidget() -> Error. "
                    "Attempt to add widget id twice");
 
    auto* dock = addDockForWidget(widget);
    m_docks[id] = DockWidgetInfo(dock, widget, area);
 
    QList<QAbstractItemView*> frames = widget->findChildren<QAbstractItemView*>();
    for (int i = 0; i < frames.count(); ++i)
        frames[i]->setFrameStyle(QFrame::NoFrame);
}

References addDockForWidget(), Error, and m_docks.

Referenced by SampleView::SampleView(), and JobView::createSubWindows().

Here is the call graph for this function:

dockToMinMaxSizes

void DocksController::dockToMinMaxSizes ( )

slot

Definition at line 194 of file DocksController.cpp.

{
    ASSERT(m_dock_info.m_dock);
    m_dock_info.m_dock->setMinimumSize(m_dock_info.m_min_size);
    m_dock_info.m_dock->setMaximumSize(m_dock_info.m_max_size);
    m_dock_info.m_dock = nullptr;
}

References DocksController::DockSizeInfo::m_dock, m_dock_info, DocksController::DockSizeInfo::m_max_size, and DocksController::DockSizeInfo::m_min_size.

Referenced by setDockHeightForWidget().

dockWidgets()

QList< QDockWidget * > DocksController::dockWidgets

(

)

const

Definition at line 148 of file DocksController.cpp.

{
    return m_mainWindow->findChildren<QDockWidget*>();
}

References m_mainWindow.

Referenced by addDockActionsToMenu(), handleWindowVisibilityChanged(), resetLayout(), restoreSettings(), saveSettings(), and setTrackingEnabled().

eventFilter()

bool DocksController::eventFilter ( QObject *  obj, QEvent *  event  )

overrideprivate

Definition at line 224 of file DocksController.cpp.

{
    if (event->type() == QEvent::Show)
        handleWindowVisibilityChanged(true);
    else if (event->type() == QEvent::Hide)
        handleWindowVisibilityChanged(false);
 
    return QObject::eventFilter(obj, event);
}

References handleWindowVisibilityChanged().

Here is the call graph for this function:

findDock() [1/2]

QDockWidget * DocksController::findDock

(

int

id

)

Definition at line 131 of file DocksController.cpp.

{
    if (m_docks.find(id) == m_docks.end())
        return nullptr;
 
    return m_docks[id].dock();
}

References m_docks.

Referenced by SampleView::resetLayout(), setDockHeightForWidget(), setDockVisible(), and toggleDock().

findDock() [2/2]

QDockWidget * DocksController::findDock

(

QWidget *

widget

)

Definition at line 139 of file DocksController.cpp.

{
    for (auto& it : m_docks)
        if (it.second.widget() == widget)
            return it.second.dock();
 
    return nullptr;
}

References m_docks.

handleWindowVisibilityChanged()

void DocksController::handleWindowVisibilityChanged ( bool  visible )

private

Definition at line 213 of file DocksController.cpp.

{
    m_handleDockVisibilityChanges = false;
    for (auto* dockWidget : dockWidgets()) {
        if (dockWidget->isFloating())
            dockWidget->setVisible(visible && dockWidget->property(dockWidgetActiveState).toBool());
    }
    if (visible)
        m_handleDockVisibilityChanges = true;
}

References dockWidgets(), and m_handleDockVisibilityChanges.

Referenced by eventFilter().

Here is the call graph for this function:

resetLayout()

void DocksController::resetLayout

(

)

Definition at line 96 of file DocksController.cpp.

{
    setTrackingEnabled(false);
    for (auto* dockWidget : dockWidgets()) {
        dockWidget->setFloating(false);
        m_mainWindow->removeDockWidget(dockWidget);
    }
 
    for (auto& it : m_docks)
        m_mainWindow->addDockWidget(it.second.area(), it.second.dock());
 
        // Fixes issue: https://bugreports.qt.io/browse/QTBUG-65592
#if QT_VERSION >= 0x050600
    if (!dockWidgets().empty())
        m_mainWindow->resizeDocks({dockWidgets().first()}, {10}, Qt::Horizontal);
#endif
 
    for (auto* dockWidget : dockWidgets())
        dockWidget->show();
 
    setTrackingEnabled(true);
}

References dockWidgets(), m_docks, m_mainWindow, and setTrackingEnabled().

Referenced by JobView::resetLayout(), and SampleView::resetLayout().

Here is the call graph for this function:

restoreSettings() [1/2]

void DocksController::restoreSettings

(

const QHash< QString, QVariant > &

settings

)

Definition at line 281 of file DocksController.cpp.

{
    QByteArray ba = settings.value(QLatin1String(StateKey), QByteArray()).toByteArray();
    if (!ba.isEmpty())
        m_mainWindow->restoreState(ba, settingsVersion);
    for (auto* widget : dockWidgets())
        widget->setProperty(dockWidgetActiveState, settings.value(widget->objectName(), false));
}

References dockWidgets(), and m_mainWindow.

Referenced by restoreSettings().

Here is the call graph for this function:

restoreSettings() [2/2]

void DocksController::restoreSettings

(

const QSettings *

settings

)

Definition at line 263 of file DocksController.cpp.

{
    QHash<QString, QVariant> hash;
    foreach (const QString& key, settings->childKeys()) {
        hash.insert(key, settings->value(key));
    }
    restoreSettings(hash);
}

References restoreSettings().

Here is the call graph for this function:

saveSettings() [1/2]

QHash< QString, QVariant > DocksController::saveSettings

(

)

const

Definition at line 272 of file DocksController.cpp.

{
    QHash<QString, QVariant> settings;
    settings.insert(QLatin1String(StateKey), m_mainWindow->saveState(settingsVersion));
    for (auto* dockWidget : dockWidgets())
        settings.insert(dockWidget->objectName(), dockWidget->property(dockWidgetActiveState));
    return settings;
}

References dockWidgets(), and m_mainWindow.

Referenced by saveSettings().

Here is the call graph for this function:

saveSettings() [2/2]

void DocksController::saveSettings

(

QSettings *

settings

)

const

Definition at line 253 of file DocksController.cpp.

{
    QHash<QString, QVariant> hash = saveSettings();
    QHashIterator<QString, QVariant> it(hash);
    while (it.hasNext()) {
        it.next();
        settings->setValue(it.key(), it.value());
    }
}

References saveSettings().

Here is the call graph for this function:

setDockHeightForWidget

void DocksController::setDockHeightForWidget ( int  height )

slot

A hack to request update of QDockWidget size if its child (e.g. InfoWidget) wants it. The problem bypassed here is that there is no direct method to QMainWindow to recalculate position of splitters surrounding given QDockWidget. So our child QWidget requests here the change of Min/Max size of QDockWidget, this will trigger recalculation of QDockWidget layout and will force QDockWidget to respect sizeHints provided by ChildWidget. Later (in one single timer shot) we return min/max sizes of QDockWidget back to re-enable splitters functionality.

Definition at line 173 of file DocksController.cpp.

{
    QWidget* widget = qobject_cast<QWidget*>(sender());
    ASSERT(widget);
    QDockWidget* dock = findDock(widget);
    ASSERT(dock);
 
    m_dock_info.m_dock = dock;
    m_dock_info.m_min_size = dock->minimumSize();
    m_dock_info.m_max_size = dock->maximumSize();
 
    if (height > 0) {
        if (dock->height() < height)
            dock->setMinimumHeight(height);
        else
            dock->setMaximumHeight(height);
    }
 
    QTimer::singleShot(1, this, &DocksController::dockToMinMaxSizes);
}

References dockToMinMaxSizes(), findDock(), DocksController::DockSizeInfo::m_dock, m_dock_info, DocksController::DockSizeInfo::m_max_size, and DocksController::DockSizeInfo::m_min_size.

Here is the call graph for this function:

setDockVisible()

void DocksController::setDockVisible	(	int	id,
		bool	visible = true
	)

Definition at line 125 of file DocksController.cpp.

{
    if (auto* dock = findDock(id))
        dock->setHidden(!visible);
}

References findDock().

Referenced by SampleView::onRequestViewInRealSpace(), and SampleView::updateSingleSampleMode().

Here is the call graph for this function:

setTrackingEnabled()

void DocksController::setTrackingEnabled ( bool  enabled )

private

Definition at line 202 of file DocksController.cpp.

{
    if (enabled) {
        m_handleDockVisibilityChanges = true;
        for (auto* dockWidget : dockWidgets())
            dockWidget->setProperty(dockWidgetActiveState, dockWidget->isVisible());
    } else {
        m_handleDockVisibilityChanges = false;
    }
}

References dockWidgets(), and m_handleDockVisibilityChanges.

Referenced by resetLayout().

Here is the call graph for this function:

setVisibleDocks()

void DocksController::setVisibleDocks

(

const std::vector< int > &

visibleDocks

)

Show docks with id's from the list. Other docks will be hidden.

Definition at line 155 of file DocksController.cpp.

{
    for (auto& it : m_docks) {
        if (std::find(visibleDocks.begin(), visibleDocks.end(), it.first) != visibleDocks.end())
            it.second.dock()->show();
        else
            it.second.dock()->hide();
    }
}

References m_docks.

Referenced by JobView::setActivity().

toggleDock()

void DocksController::toggleDock

(

int

id

)

Definition at line 119 of file DocksController.cpp.

{
    if (auto* dock = findDock(id))
        dock->setHidden(!dock->isHidden());
}

References findDock().

Referenced by SampleView::toggleRealSpaceView().

Here is the call graph for this function:

Member Data Documentation

m_dock_info

DockSizeInfo DocksController::m_dock_info

private

Definition at line 72 of file DocksController.h.

Referenced by dockToMinMaxSizes(), and setDockHeightForWidget().

m_docks

std::map<int, DockWidgetInfo> DocksController::m_docks

private

Definition at line 71 of file DocksController.h.

Referenced by addWidget(), findDock(), resetLayout(), and setVisibleDocks().

m_handleDockVisibilityChanges

bool DocksController::m_handleDockVisibilityChanges = true

private

Definition at line 73 of file DocksController.h.

Referenced by addDockForWidget(), handleWindowVisibilityChanged(), and setTrackingEnabled().

m_mainWindow

QMainWindow* DocksController::m_mainWindow

private

Definition at line 70 of file DocksController.h.

Referenced by DocksController(), addDockActionsToMenu(), addDockForWidget(), dockWidgets(), resetLayout(), restoreSettings(), and saveSettings().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/DocksController.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/DocksController.cpp