Kwave::MessageBox Class Reference

#include <MessageBox.h>

Inheritance diagram for Kwave::MessageBox:

Collaboration diagram for Kwave::MessageBox:

Classes
class	Trigger

Static Public Member Functions
static int	questionYesNo (QWidget *widget, QString message, QString caption=QString(), const QString buttonYes=QString(), const QString buttonNo=QString(), const QString &dontAskAgainName=QString())
static int	questionYesNoCancel (QWidget *widget, QString message, QString caption=QString(), const QString buttonYes=QString(), const QString buttonNo=QString(), const QString &dontAskAgainName=QString())
static int	sorry (QWidget *widget, QString message, QString caption=QString())
static int	warningYesNo (QWidget *widget, QString message, QString caption=QString(), const QString buttonYes=QString(), const QString buttonNo=QString(), const QString &dontAskAgainName=QString())
static int	warningYesNoCancel (QWidget *widget, QString message, QString caption=QString(), const QString buttonYes=QString(), const QString buttonNo=QString(), const QString &dontAskAgainName=QString())
static int	warningContinueCancel (QWidget *widget, QString message, QString caption=QString(), const QString buttonContinue=QString(), const QString buttonCancel=QString(), const QString &dontAskAgainName=QString())
static int	error (QWidget *widget, QString message, QString caption=QString())

Protected Member Functions
void	show ()

Private Member Functions
	MessageBox ()
	MessageBox (KMessageBox::DialogType mode, QWidget *parent, QString message, QString caption, const QString &button1=QString(), const QString &button2=QString(), const QString &dontAskAgainName=QString())
virtual	~MessageBox ()
virtual int	retval () const

Static Private Member Functions
static int	exec (KMessageBox::DialogType mode, QWidget *parent, QString message, QString caption=QString(), const QString &button1=QString(), const QString &button2=QString(), const QString &dontAskAgainName=QString())

Private Attributes
QSemaphore	m_semaphore
int	m_retval
KMessageBox::DialogType	m_mode
QWidget *	m_parent
QString	m_message
QString	m_caption
const QString	m_button1
const QString	m_button2
const QString	m_dont_ask_again_name

Detailed Description

Definition at line 35 of file MessageBox.h.

Constructor & Destructor Documentation

MessageBox() [1/2]

Kwave::MessageBox::MessageBox ( )

private

Default constructor (not implemented)

MessageBox() [2/2]

Kwave::MessageBox::MessageBox ( KMessageBox::DialogType  mode, QWidget *  parent, QString  message, QString  caption, const QString &  button1 = QString(), const QString &  button2 = QString(), const QString &  dontAskAgainName = QString()  )

private

Constructor

Parameters

mode	the mode of the message box, error/warning/etc...
parent	parent widget
message	the message text of the box
caption	title of the window
button1	a KGuiItem for the first button (optional)
button2	a KGuiItem for the second button (optional)
dontAskAgainName	tag name for "do not ask again"

Definition at line 29 of file MessageBox.cpp.

References m_semaphore, and show().

    :QObject(Q_NULLPTR), m_semaphore(0), m_retval(-1),
     m_mode(mode), m_parent(parent), m_message(message), m_caption(caption),
     m_button1(button1), m_button2(button2),
     m_dont_ask_again_name(dontAskAgainName)
{
    if (QThread::currentThread() == QApplication::instance()->thread()) {
        // we are already in the GUI thread -> direct call
        show();
    } else {
        // schedule execution in the GUI thread ...
        Trigger *trigger = new Trigger(*this);
        trigger->deleteLater();

        // ... and wait
        m_semaphore.acquire();
    }
}

Here is the call graph for this function:

~MessageBox()

Kwave::MessageBox::~MessageBox ( )

privatevirtual

Destructor

Definition at line 58 of file MessageBox.cpp.

{
}

Member Function Documentation

error()

int Kwave::MessageBox::error ( QWidget *  widget, QString  message, QString  caption = QString()  )

static

See also

KMessageBox::error

Definition at line 126 of file MessageBox.cpp.

References exec().

Referenced by Kwave::PluginManager::createPluginInstance(), Kwave::OggDecoder::decode(), Kwave::OggEncoder::encode(), Kwave::AsciiEncoder::encode(), Kwave::WavEncoder::encode(), Kwave::MP3Encoder::encode(), Kwave::FlacEncoder::encode(), Kwave::FileContext::init(), Kwave::TopWidget::loadFile(), Kwave::AudiofileDecoder::open(), Kwave::FlacDecoder::open(), Kwave::WavDecoder::open(), Kwave::VorbisDecoder::open(), Kwave::OpusEncoder::open(), Kwave::OpusDecoder::open(), Kwave::PlaybackController::openDevice(), Kwave::OggDecoder::parseHeader(), Kwave::OpusDecoder::parseOpusHead(), Kwave::OpusDecoder::parseOpusTags(), Kwave::RecordPlugin::recordStopped(), Kwave::SignalManager::save(), Kwave::OpusEncoder::setupBitrateMode(), Kwave::OpusEncoder::setupEncoder(), and Kwave::SonagramPlugin::start().

{
    return Kwave::MessageBox::exec(KMessageBox::Error,
        parent, message, caption);
}

Here is the call graph for this function:

Here is the caller graph for this function:

exec()

int Kwave::MessageBox::exec ( KMessageBox::DialogType  mode, QWidget *  parent, QString  message, QString  caption = QString(), const QString &  button1 = QString(), const QString &  button2 = QString(), const QString &  dontAskAgainName = QString()  )

staticprivate

Creates and executes a KMessageBox in the same thread or via a blocking signal, depending on whether the current context is the GUI thread or not.

Parameters

mode	type of the message box

See also

KMessageBox::DialogType

Parameters

parent	the parent widget
message	the text of the message box
caption	the window title (optional)
button1	a KGuiItem for the first button (optional)
button2	a KGuiItem for the second button (optional)
dontAskAgainName	tag name for "do not ask again"

Returns

the result of the call to KMessageBox::xxx or -1

Definition at line 134 of file MessageBox.cpp.

References retval().

Referenced by error(), questionYesNo(), questionYesNoCancel(), sorry(), warningContinueCancel(), warningYesNo(), and warningYesNoCancel().

{
    Kwave::MessageBox box(
        mode, parent, message, caption,
        button1, button2,
        dontAskAgainName
    );
    return box.retval();
}

Here is the call graph for this function:

Here is the caller graph for this function:

questionYesNo()

int Kwave::MessageBox::questionYesNo ( QWidget *  widget, QString  message, QString  caption = QString(), const QString  buttonYes = QString(), const QString  buttonNo = QString(), const QString &  dontAskAgainName = QString()  )

static

See also

KMessageBox::questionYesNo

Definition at line 63 of file MessageBox.cpp.

References exec().

Referenced by Kwave::ConfirmCancelProxy::cancel(), Kwave::TopWidget::executeCommand(), Kwave::FileContext::parseCommands(), and Kwave::K3BExportPlugin::start().

{
    return Kwave::MessageBox::exec(KMessageBox::QuestionYesNo,
        parent, message, caption, buttonYes, buttonNo,
        dontAskAgainName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

questionYesNoCancel()

int Kwave::MessageBox::questionYesNoCancel ( QWidget *  widget, QString  message, QString  caption = QString(), const QString  buttonYes = QString(), const QString  buttonNo = QString(), const QString &  dontAskAgainName = QString()  )

static

See also

KMessageBox::questionYesNoCancel

Definition at line 74 of file MessageBox.cpp.

References exec().

Referenced by Kwave::FileInfoPlugin::apply().

{
    return Kwave::MessageBox::exec(KMessageBox::QuestionYesNoCancel,
        parent, message, caption, buttonYes, buttonNo,
        dontAskAgainName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

retval()

int Kwave::MessageBox::retval ( ) const

privatevirtual

returns the return value of the KMessageBox

Definition at line 52 of file MessageBox.cpp.

References m_retval.

Referenced by exec().

{
    return m_retval;
}

Here is the caller graph for this function:

show()

void Kwave::MessageBox::show ( )

protected

shows the KMessageBox, always called in the GUI thread context.

Definition at line 148 of file MessageBox.cpp.

References m_button1, m_button2, m_caption, m_dont_ask_again_name, m_message, m_mode, m_parent, m_retval, and m_semaphore.

Referenced by MessageBox(), and Kwave::MessageBox::Trigger::~Trigger().

{
    switch (m_mode) {
        // QuestionYesNo
        case KMessageBox::QuestionYesNo:
            m_retval = KMessageBox::questionYesNo(m_parent,
                m_message, m_caption,
                (!m_button1.isEmpty()) ? KGuiItem(m_button1) :
                                         KStandardGuiItem::yes(),
                (!m_button2.isEmpty()) ? KGuiItem(m_button2) :
                                         KStandardGuiItem::no(),
                m_dont_ask_again_name);
            break;
        // QuestionYesNoCancel
        case KMessageBox::QuestionYesNoCancel:
            m_retval = KMessageBox::questionYesNoCancel(m_parent,
                m_message, m_caption,
                (!m_button1.isEmpty()) ? KGuiItem(m_button1) :
                                         KStandardGuiItem::yes(),
                (!m_button2.isEmpty()) ? KGuiItem(m_button2) :
                                         KStandardGuiItem::no(),
                KStandardGuiItem::cancel(),
                m_dont_ask_again_name);
            break;
        // Sorry
        case KMessageBox::Sorry:
            KMessageBox::sorry(m_parent, m_message, m_caption);
            break;
        // WarningYesNoCancel
        case KMessageBox::WarningYesNoCancel:
            m_retval = KMessageBox::warningYesNoCancel(m_parent,
                m_message, m_caption,
                (!m_button1.isEmpty()) ? KGuiItem(m_button1) :
                                         KStandardGuiItem::yes(),
                (!m_button2.isEmpty()) ? KGuiItem(m_button2) :
                                         KStandardGuiItem::no(),
                KStandardGuiItem::cancel(),
                m_dont_ask_again_name);
            break;
        // WarningYesNo
        case KMessageBox::WarningYesNo:
            m_retval = KMessageBox::warningYesNo(m_parent,
                m_message, m_caption,
                (!m_button1.isEmpty()) ? KGuiItem(m_button1) :
                                         KStandardGuiItem::yes(),
                (!m_button2.isEmpty()) ? KGuiItem(m_button2) :
                                         KStandardGuiItem::no(),
                m_dont_ask_again_name);
            break;
        // WarningContinueCancel
        case KMessageBox::WarningContinueCancel:
            m_retval = KMessageBox::warningContinueCancel(m_parent,
                m_message, m_caption,
                (!m_button1.isEmpty()) ? KGuiItem(m_button1) :
                                         KStandardGuiItem::cont(),
                (!m_button2.isEmpty()) ? KGuiItem(m_button2) :
                                         KStandardGuiItem::cancel(),
                m_dont_ask_again_name);
            break;
        // Error
        case KMessageBox::Error:
            KMessageBox::error(m_parent, m_message, m_caption);
            break;
        case KMessageBox::Information:
            KMessageBox::information(m_parent, m_message, m_caption,
                                     m_dont_ask_again_name);
            break;
        default:
            qWarning("unsupported messagebox mode");
            Q_ASSERT(0);
    }

    m_semaphore.release();
}

Here is the caller graph for this function:

sorry()

int Kwave::MessageBox::sorry ( QWidget *  widget, QString  message, QString  caption = QString()  )

static

See also

KMessageBox::sorry

Definition at line 85 of file MessageBox.cpp.

References exec().

Referenced by Kwave::VorbisEncoder::open(), Kwave::MP3Decoder::open(), Kwave::WavDecoder::open(), Kwave::RecordPlugin::setDevice(), Kwave::OpusEncoder::setupCodingRate(), Kwave::RecordPlugin::setupRecordThread(), Kwave::K3BExportPlugin::start(), Kwave::RecordPlugin::startRecording(), and Kwave::PlayBackPlugin::testPlayBack().

{
    return Kwave::MessageBox::exec(KMessageBox::Sorry,
        parent, message, caption);
}

Here is the call graph for this function:

Here is the caller graph for this function:

warningContinueCancel()

int Kwave::MessageBox::warningContinueCancel ( QWidget *  widget, QString  message, QString  caption = QString(), const QString  buttonContinue = QString(), const QString  buttonCancel = QString(), const QString &  dontAskAgainName = QString()  )

static

See also

KMessageBox::warningContinueCancel

Definition at line 115 of file MessageBox.cpp.

References exec().

Referenced by Kwave::SignalManager::continueWithoutUndo(), Kwave::MP3Encoder::encode(), Kwave::MP3Decoder::handleError(), Kwave::VorbisEncoder::open(), Kwave::WavDecoder::open(), Kwave::Logger::open(), Kwave::MP3Decoder::parseMp3Header(), Kwave::FileContext::revert(), Kwave::SignalManager::save(), Kwave::OpusEncoder::setupBitrate(), Kwave::OpusEncoder::setupDownMix(), and Kwave::SaveBlocksPlugin::start().

{
    return Kwave::MessageBox::exec(KMessageBox::WarningContinueCancel,
        parent, message, caption, buttonContinue, buttonCancel,
        dontAskAgainName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

warningYesNo()

int Kwave::MessageBox::warningYesNo ( QWidget *  widget, QString  message, QString  caption = QString(), const QString  buttonYes = QString(), const QString  buttonNo = QString(), const QString &  dontAskAgainName = QString()  )

static

See also

KMessageBox::warningYesNo

Definition at line 93 of file MessageBox.cpp.

References exec().

Referenced by Kwave::FileProgress::closeEvent(), Kwave::MP3Decoder::handleError(), Kwave::FileContext::saveFileAs(), Kwave::MainWidget::saveLabels(), and Kwave::SaveBlocksPlugin::start().

{
    return Kwave::MessageBox::exec(KMessageBox::WarningYesNo,
        parent, message, caption, buttonYes, buttonNo,
        dontAskAgainName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

warningYesNoCancel()

int Kwave::MessageBox::warningYesNoCancel ( QWidget *  widget, QString  message, QString  caption = QString(), const QString  buttonYes = QString(), const QString  buttonNo = QString(), const QString &  dontAskAgainName = QString()  )

static

See also

KMessageBox::warningYesNoCancel

Definition at line 104 of file MessageBox.cpp.

References exec().

Referenced by Kwave::FileContext::closeFile(), Kwave::WavEncoder::encode(), and Kwave::MainWidget::labelProperties().

{
    return Kwave::MessageBox::exec(KMessageBox::WarningYesNoCancel,
        parent, message, caption, buttonYes, buttonNo,
        dontAskAgainName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_button1

const QString Kwave::MessageBox::m_button1

private

first button (optional)

Definition at line 185 of file MessageBox.h.

Referenced by show().

m_button2

const QString Kwave::MessageBox::m_button2

private

second button (optional)

Definition at line 188 of file MessageBox.h.

Referenced by show().

m_caption

QString Kwave::MessageBox::m_caption

private

the window title (optional)

Definition at line 182 of file MessageBox.h.

Referenced by show().

m_dont_ask_again_name

const QString Kwave::MessageBox::m_dont_ask_again_name

private

tag for "do not ask again" (optional)

Definition at line 191 of file MessageBox.h.

Referenced by show().

m_message

QString Kwave::MessageBox::m_message

private

the text of the message box

Definition at line 179 of file MessageBox.h.

Referenced by show().

m_mode

KMessageBox::DialogType Kwave::MessageBox::m_mode

private

See also

KMessageBox::DialogType

Definition at line 173 of file MessageBox.h.

Referenced by show().

m_parent

QWidget* Kwave::MessageBox::m_parent

private

the parent widget

Definition at line 176 of file MessageBox.h.

Referenced by show().

m_retval

int Kwave::MessageBox::m_retval

private

return value of the execution of the message box

Definition at line 170 of file MessageBox.h.

Referenced by retval(), and show().

m_semaphore

QSemaphore Kwave::MessageBox::m_semaphore

private

semaphore for waiting on the GUI thread

Definition at line 167 of file MessageBox.h.

Referenced by MessageBox(), and show().

---

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

• libkwave/MessageBox.h
• libkwave/MessageBox.cpp