commonwidget.cpp

/*******************************************************************************

Copyright (C) The University of Auckland

OpenCOR is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

OpenCOR is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

*******************************************************************************/

//==============================================================================
// Common widget
//==============================================================================

#include "busywidget.h"
#include "centralwidget.h"
#include "commonwidget.h"
#include "corecliutils.h"
#include "coreguiutils.h"

//==============================================================================

#include <QApplication>
#include <QDesktopWidget>
#include <QDockWidget>
#include <QMainWindow>
#include <QPainter>
#include <QPen>
#include <QSettings>

//==============================================================================

namespace OpenCOR {
namespace Core {

//==============================================================================

CommonWidget::CommonWidget(QWidget *pParent) :
    mParent(pParent),
    mBusyWidget(0),
    mCounter(0)
{
}

//==============================================================================

QSize CommonWidget::defaultSize(const double &pRatio) const
{
    // The default size of a widget is a ratio of the available geometry

    QRect desktopGeometry = qApp->desktop()->availableGeometry();

    return QSize(pRatio*desktopGeometry.width(),
                 pRatio*desktopGeometry.height());
}

//==============================================================================

void CommonWidget::loadSettings(QSettings *pSettings)
{
    Q_UNUSED(pSettings);

    // Nothing to do by default...
}

//==============================================================================

void CommonWidget::saveSettings(QSettings *pSettings) const
{
    Q_UNUSED(pSettings);

    // Nothing to do by default...
}

//==============================================================================

void CommonWidget::retranslateUi()
{
    // Nothing to do by default...
}

//==============================================================================

bool CommonWidget::isBusyWidgetVisible() const
{
    // Return whether our busy widget is visible, i.e. whether it exists

    return mBusyWidget;
}

//==============================================================================

void CommonWidget::doShowBusyWidget(const double &pProgress)
{
    // Create and show our new busy widget resized, and then disable our parent

    if (++mCounter == 1) {
        mBusyWidget = new BusyWidget(mParent, pProgress);

        resizeBusyWidget();

        if (mParent == centralWidget())
            mainWindow()->setEnabled(false);
        else
            mParent->setEnabled(false);

        // Make sure that our busy widget is shown straightaway
        // Note: indeed, depending on the operating system (e.g. macOS) and on
        //       what we do next (e.g. retrieving a remote file), our busy
        //       widget may or not show straightaway...

        QCoreApplication::sendPostedEvents();
        QCoreApplication::processEvents();
    }
}

//==============================================================================

void CommonWidget::showBusyWidget()
{
    // Show a 'normal' busy widget

    doShowBusyWidget();
}

//==============================================================================

void CommonWidget::showProgressBusyWidget()
{
    // Show a progress busy widget

    doShowBusyWidget(0.0);
}

//==============================================================================

void CommonWidget::hideBusyWidget(const bool &pForceHiding)
{
    // Make sure that we have a busy widget

    if (!mBusyWidget)
        return;

    // Check whether we want to force hiding our busy widget

    if (pForceHiding)
        mCounter = 1;

    // Enable ourselves (or OpenCOR itself in case we are the central widget)
    // and hide our busy widget by deleting it

    if (--mCounter == 0) {
        if (mParent == centralWidget())
            mainWindow()->setEnabled(true);
        else
            mParent->setEnabled(true);

        delete mBusyWidget;

        mBusyWidget = 0;
    }
}

//==============================================================================

void CommonWidget::resizeBusyWidget()
{
    // Make sure that we have a busy widget

    if (!mBusyWidget)
        return;

    // Resize our busy widget

    mBusyWidget->resize();
}

//==============================================================================

void CommonWidget::setBusyWidgetProgress(const double &pProgress)
{
    // Make sure that we have a busy widget

    if (!mBusyWidget)
        return;

    // Set the progress of our busy widget

    mBusyWidget->setProgress(pProgress);
}

//==============================================================================

void CommonWidget::processEvents()
{
    // Process events, but only if we or our central widget is not showing our
    // or its busy widget

    if (!mBusyWidget && !centralWidget()->isBusyWidgetVisible())
        QCoreApplication::processEvents();
}

//==============================================================================

}   // namespace Core
}   // namespace OpenCOR

//==============================================================================
// End of file
//==============================================================================