CautionSign Class Reference

Description

The CautionSign controls appearance of CautionSignWidget on top of parent widget.

Definition at line 25 of file CautionSign.h.

Inheritance diagram for CautionSign:

Collaboration diagram for CautionSign:

Public Member Functions
	CautionSign (QWidget *parent)
void	clear ()
	Clears caution message;. More...
bool	isShown () const
void	setArea (QWidget *area)
void	setCautionHeader (const QString &cautionHeader)
void	setCautionMessage (const QString &cautionMessage)
	Shows caution sign on the screen. If clear of previous caution sign had happened just few msec ago, make a small delay, to stress its reapearance. More...

Protected Member Functions
bool	eventFilter (QObject *obj, QEvent *event) override

Private Member Functions
QPoint	positionForCautionSign () const
void	updateLabelGeometry ()

Private Attributes
QWidget *	m_area
QString	m_caution_header
QString	m_caution_message
CautionSignWidget *	m_cautionWidget
bool	m_clear_just_had_happened

Constructor & Destructor Documentation

CautionSign()

CautionSign::CautionSign

(

QWidget *

parent

)

Definition at line 30 of file CautionSign.cpp.

    : QObject(parent)
    , m_caution_header("Houston, we have a problem.")
    , m_cautionWidget(nullptr)
    , m_area(nullptr)
    , m_clear_just_had_happened(false)
{
    setArea(parent);
}

References setArea().

Here is the call graph for this function:

Member Function Documentation

clear()

void CautionSign::clear

(

)

Clears caution message;.

Definition at line 42 of file CautionSign.cpp.

{
    delete m_cautionWidget;
    m_cautionWidget = nullptr;
    m_caution_message.clear();
 
    m_clear_just_had_happened = true;
    QTimer::singleShot(10, this, [=]() { m_clear_just_had_happened = false; });
}

References m_caution_message, m_cautionWidget, and m_clear_just_had_happened.

Referenced by ScriptPanel::generateCodeSnippet(), PythonScriptWidget::generatePythonScript(), DistributionPlot::init_plot(), RunFitControlWidget::onFittingError(), RunFitControlWidget::updateControlElements(), ParameterTuningWidget::updateJobStatus(), and RealSpaceCanvas::updateScene().

eventFilter()

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

overrideprotected

Definition at line 90 of file CautionSign.cpp.

{
    if (event->type() == QEvent::Resize)
        updateLabelGeometry();
 
    return QObject::eventFilter(obj, event);
}

References updateLabelGeometry().

Here is the call graph for this function:

isShown()

bool CautionSign::isShown

(

)

const

Definition at line 85 of file CautionSign.cpp.

{
    return m_cautionWidget != nullptr;
}

References m_cautionWidget.

positionForCautionSign()

QPoint CautionSign::positionForCautionSign ( ) const

private

Definition at line 107 of file CautionSign.cpp.

{
    ASSERT(m_area);
 
    int x = m_area->width() - xpos_offset;
    int y = m_area->height() - ypos_offset;
 
    if (auto* scrollArea = dynamic_cast<QAbstractScrollArea*>(m_area)) {
        if (QScrollBar* horizontal = scrollArea->horizontalScrollBar()) {
            if (horizontal->isVisible())
                y -= horizontal->height();
        }
 
        if (QScrollBar* vertical = scrollArea->verticalScrollBar()) {
            if (vertical->isVisible())
                x -= vertical->width();
        }
    }
 
    return QPoint(x, y);
}

References m_area.

Referenced by updateLabelGeometry().

setArea()

void CautionSign::setArea

(

QWidget *

area

)

Definition at line 79 of file CautionSign.cpp.

{
    m_area = area;
    m_area->installEventFilter(this);
}

References m_area.

Referenced by CautionSign().

setCautionHeader()

void CautionSign::setCautionHeader

(

const QString &

cautionHeader

)

Definition at line 52 of file CautionSign.cpp.

{
    m_caution_header = cautionHeader;
}

References m_caution_header.

setCautionMessage()

void CautionSign::setCautionMessage

(

const QString &

cautionMessage

)

Shows caution sign on the screen. If clear of previous caution sign had happened just few msec ago, make a small delay, to stress its reapearance.

Definition at line 60 of file CautionSign.cpp.

{
    ASSERT(m_area);
 
    if (m_clear_just_had_happened) {
        m_clear_just_had_happened = false;
        QTimer::singleShot(50, this, [=]() { setCautionMessage(cautionMessage); });
    } else {
        m_caution_message = cautionMessage;
 
        if (!m_cautionWidget)
            m_cautionWidget = new CautionSignWidget(m_area);
 
        m_cautionWidget->setCautionMessage(m_caution_message);
        updateLabelGeometry();
        m_cautionWidget->show();
    }
}

References m_area, m_caution_message, m_cautionWidget, m_clear_just_had_happened, CautionSignWidget::setCautionMessage(), and updateLabelGeometry().

Referenced by ScriptPanel::generateCodeSnippet(), PythonScriptWidget::generatePythonScript(), RunFitControlWidget::onFittingError(), DistributionPlot::plotItem(), ParameterTuningWidget::updateJobStatus(), and RealSpaceCanvas::updateScene().

Here is the call graph for this function:

updateLabelGeometry()

void CautionSign::updateLabelGeometry ( )

private

Definition at line 98 of file CautionSign.cpp.

{
    if (!m_cautionWidget || !m_area)
        return;
 
    QPoint pos = positionForCautionSign();
    m_cautionWidget->setPosition(pos.x(), pos.y());
}

References m_area, m_cautionWidget, positionForCautionSign(), and CautionSignWidget::setPosition().

Referenced by eventFilter(), and setCautionMessage().

Here is the call graph for this function:

Member Data Documentation

m_area

QWidget* CautionSign::m_area

private

Definition at line 49 of file CautionSign.h.

Referenced by positionForCautionSign(), setArea(), setCautionMessage(), and updateLabelGeometry().

m_caution_header

QString CautionSign::m_caution_header

private

Definition at line 46 of file CautionSign.h.

Referenced by setCautionHeader().

m_caution_message

QString CautionSign::m_caution_message

private

Definition at line 47 of file CautionSign.h.

Referenced by clear(), and setCautionMessage().

m_cautionWidget

CautionSignWidget* CautionSign::m_cautionWidget

private

Definition at line 48 of file CautionSign.h.

Referenced by clear(), isShown(), setCautionMessage(), and updateLabelGeometry().

m_clear_just_had_happened

bool CautionSign::m_clear_just_had_happened

private

Definition at line 50 of file CautionSign.h.

Referenced by clear(), and setCautionMessage().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Info/CautionSign.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Info/CautionSign.cpp