<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/gui/qxtconfirmationmessage.cpp -->
<head>
<title>QxtConfirmationMessage Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtConfirmationMessage Class Reference<br /><span class="small-subtitle">[<a href="qxtgui.html">QxtGui</a> module]</span>
</h1>
<p>The QxtConfirmationMessage class provides a confirmation message. <a href="#details">More...</a></p>
<pre> #include <QxtConfirmationMessage></pre><p>Inherits <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html">QMessageBox</a>.</p>
<ul>
<li><a href="qxtconfirmationmessage-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtconfirmationmessage.html#QxtConfirmationMessage">QxtConfirmationMessage</a></b> ( QWidget * <i>parent</i> = 0 )</li>
<li><div class="fn"></div><b><a href="qxtconfirmationmessage.html#QxtConfirmationMessage-2">QxtConfirmationMessage</a></b> ( QMessageBox::Icon <i>icon</i>, const QString & <i>title</i>, const QString & <i>text</i>, const QString & <i>confirmation</i> = QString(), QMessageBox::StandardButtons <i>buttons</i> = QMessageBox::NoButton, QWidget * <i>parent</i> = 0, Qt::WindowFlags <i>flags</i> = Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint )</li>
<li><div class="fn"></div>virtual <b><a href="qxtconfirmationmessage.html#dtor.QxtConfirmationMessage">~QxtConfirmationMessage</a></b> ()</li>
<li><div class="fn"></div>QString <b><a href="qxtconfirmationmessage.html#confirmationText">confirmationText</a></b> () const</li>
<li><div class="fn"></div>QString <b><a href="qxtconfirmationmessage.html#overrideSettingsApplication">overrideSettingsApplication</a></b> () const</li>
<li><div class="fn"></div>QString <b><a href="qxtconfirmationmessage.html#overrideSettingsKey">overrideSettingsKey</a></b> () const</li>
<li><div class="fn"></div>QString <b><a href="qxtconfirmationmessage.html#overrideSettingsOrganization">overrideSettingsOrganization</a></b> () const</li>
<li><div class="fn"></div>bool <b><a href="qxtconfirmationmessage.html#rememberOnReject">rememberOnReject</a></b> () const</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setConfirmationText">setConfirmationText</a></b> ( const QString & <i>confirmation</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setOverrideSettingsApplication">setOverrideSettingsApplication</a></b> ( const QString & <i>application</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setOverrideSettingsKey">setOverrideSettingsKey</a></b> ( const QString & <i>key</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setOverrideSettingsOrganization">setOverrideSettingsOrganization</a></b> ( const QString & <i>organization</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setRememberOnReject">setRememberOnReject</a></b> ( bool <i>remember</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>32 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#public-functions">QMessageBox</a></li>
<li><div class="fn"></div>5 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qdialog.html#public-functions">QDialog</a></li>
<li><div class="fn"></div>207 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#public-functions">QWidget</a></li>
<li><div class="fn"></div>12 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#public-functions">QPaintDevice</a></li>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h3>Public Slots</h3>
<ul>
<li><div class="fn"></div>int <b><a href="qxtconfirmationmessage.html#exec">exec</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#reset">reset</a></b> ()</li>
</ul>
<ul>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#public-slots">QMessageBox</a></li>
<li><div class="fn"></div>5 public slots inherited from <a href="http://doc.qtsoftware.com/4.5/qdialog.html#public-slots">QDialog</a></li>
<li><div class="fn"></div>19 public slots inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#public-slots">QWidget</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h3>Static Public Members</h3>
<ul>
<li><div class="fn"></div>QMessageBox::StandardButton <b><a href="qxtconfirmationmessage.html#confirm">confirm</a></b> ( QWidget * <i>parent</i>, const QString & <i>title</i>, const QString & <i>text</i>, const QString & <i>confirmation</i> = QString(), QMessageBox::StandardButtons <i>buttons</i> = QMessageBox::Yes | QMessageBox::No, QMessageBox::StandardButton <i>defaultButton</i> = QMessageBox::NoButton )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setSettingsFormat">setSettingsFormat</a></b> ( QSettings::Format <i>format</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setSettingsPath">setSettingsPath</a></b> ( const QString & <i>path</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtconfirmationmessage.html#setSettingsScope">setSettingsScope</a></b> ( QSettings::Scope <i>scope</i> )</li>
<li><div class="fn"></div>QSettings::Format <b><a href="qxtconfirmationmessage.html#settingsFormat">settingsFormat</a></b> ()</li>
<li><div class="fn"></div>QString <b><a href="qxtconfirmationmessage.html#settingsPath">settingsPath</a></b> ()</li>
<li><div class="fn"></div>QSettings::Scope <b><a href="qxtconfirmationmessage.html#settingsScope">settingsScope</a></b> ()</li>
</ul>
<ul>
<li><div class="fn"></div>6 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#static-public-members">QMessageBox</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#static-public-members">QWidget</a></li>
<li><div class="fn"></div>1 static public member inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#static-public-members">QPaintDevice</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>7 properties inherited from <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#properties">QMessageBox</a></li>
<li><div class="fn"></div>2 properties inherited from <a href="http://doc.qtsoftware.com/4.5/qdialog.html#properties">QDialog</a></li>
<li><div class="fn"></div>57 properties inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#properties">QWidget</a></li>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#signals">QMessageBox</a></li>
<li><div class="fn"></div>3 signals inherited from <a href="http://doc.qtsoftware.com/4.5/qdialog.html#signals">QDialog</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#signals">QWidget</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>37 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#protected-functions">QWidget</a></li>
<li><div class="fn"></div>1 protected function inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#protected-functions">QPaintDevice</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>1 protected slot inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#protected-slots">QWidget</a></li>
<li><div class="fn"></div>1 protected type inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#protected-variables">QPaintDevice</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtConfirmationMessage class provides a confirmation message.</p>
<p>QxtConfirmationMessage is a confirmation message with checkable <b>"Do not show again."</b> option. A checked and accepted confirmation message is no more shown until reseted.</p>
<p>Example usage:</p>
<pre> void MainWindow::closeEvent(QCloseEvent* event)
{
static const QString text(tr("Are you sure you want to quit?"));
if (QxtConfirmationMessage::confirm(this, tr("Confirm"), text) == QMessageBox::No)
event->ignore();
}</pre>
<p align="center"><img src="images/qxtconfirmationmessage.png" alt=""QxtConfirmationMessage in action."" /></p><p><b>Note:</b> <a href="http://doc.qtsoftware.com/4.5/qcoreapplication.html#organizationName-prop">QCoreApplication::organizationName</a> and <a href="http://doc.qtsoftware.com/4.5/qcoreapplication.html#applicationName-prop">QCoreApplication::applicationName</a> are used for storing settings. In case these properties are empty, <b>"QxtGui"</b> and <b>"QxtConfirmationMessage"</b> are used, respectively.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtConfirmationMessage"></a>QxtConfirmationMessage::QxtConfirmationMessage ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a new <a href="qxtconfirmationmessage.html">QxtConfirmationMessage</a> with <i>parent</i>.</p>
<h3 class="fn"><a name="QxtConfirmationMessage-2"></a>QxtConfirmationMessage::QxtConfirmationMessage ( <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#Icon-enum">QMessageBox::Icon</a> <i>icon</i>, const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>title</i>, const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>text</i>, const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>confirmation</i> = QString(), <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#StandardButtons-typedef">QMessageBox::StandardButtons</a> <i>buttons</i> = QMessageBox::NoButton, <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> = 0, <a href="http://doc.qtsoftware.com/4.5/qt.html#WindowFlags-typedef">Qt::WindowFlags</a> <i>flags</i> = Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint )</h3>
<p>Constructs a new <a href="qxtconfirmationmessage.html">QxtConfirmationMessage</a> with <i>icon</i>, <i>title</i>, <i>text</i>, <i>confirmation</i>, <i>buttons</i>, <i>parent</i> and <i>flags</i>.</p>
<h3 class="fn"><a name="dtor.QxtConfirmationMessage"></a>QxtConfirmationMessage::~QxtConfirmationMessage () <tt> [virtual]</tt></h3>
<p>Destructs the confirmation message.</p>
<h3 class="fn"><a name="confirm"></a><a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#StandardButton-enum">QMessageBox::StandardButton</a> QxtConfirmationMessage::confirm ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i>, const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>title</i>, const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>text</i>, const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>confirmation</i> = QString(), <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#StandardButtons-typedef">QMessageBox::StandardButtons</a> <i>buttons</i> = QMessageBox::Yes | QMessageBox::No, <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#StandardButton-enum">QMessageBox::StandardButton</a> <i>defaultButton</i> = QMessageBox::NoButton ) <tt> [static]</tt></h3>
<p>Opens an confirmation message box with the specified <i>title</i>, <i>text</i> and <i>confirmation</i>. The standard <i>buttons</i> are added to the message box. <i>defaultButton</i> specifies the button used when Enter is pressed. <i>defaultButton</i> must refer to a button that was given in <i>buttons</i>. If <i>defaultButton</i> is <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#StandardButton-enum">QMessageBox::NoButton</a>, <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html">QMessageBox</a> chooses a suitable default automatically.</p>
<p>Returns the identity of the standard button that was clicked. If Esc was pressed instead, the escape button is returned.</p>
<p>If <i>parent</i> is <tt>0</tt>, the message box is an application modal dialog box. If <i>parent</i> is a widget, the message box is window modal relative to <i>parent</i>.</p>
<h3 class="fn"><a name="confirmationText"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtConfirmationMessage::confirmationText () const</h3>
<p>See also <a href="qxtconfirmationmessage.html#setConfirmationText">setConfirmationText</a>().</p>
<h3 class="fn"><a name="exec"></a>int QxtConfirmationMessage::exec () <tt> [slot]</tt></h3>
<p>Shows the confirmation message if necessary. The confirmation message is not shown in case <b>"Do not show again."</b> has been checked while the same confirmation message was earlierly accepted.</p>
<p>A confirmation message is identified by the combination of title, <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#text-prop">QMessageBox::text</a> and optional <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#informativeText-prop">QMessageBox::informativeText</a>.</p>
<p>A clicked button with role <a href="http://doc.qtsoftware.com/4.5/qdialogbuttonbox.html#ButtonRole-enum">QDialogButtonBox::AcceptRole</a> or <a href="http://doc.qtsoftware.com/4.5/qdialogbuttonbox.html#ButtonRole-enum">QDialogButtonBox::YesRole</a> is considered as "accepted".</p>
<p><b>Warning:</b> This function does not reimplement but shadows <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#exec">QMessageBox::exec</a>().</p>
<p>See also <a href="http://doc.qtsoftware.com/4.5/qwidget.html#windowTitle-prop">QWidget::windowTitle</a>, <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#text-prop">QMessageBox::text</a>, and <a href="http://doc.qtsoftware.com/4.5/qmessagebox.html#informativeText-prop">QMessageBox::informativeText</a>.</p>
<h3 class="fn"><a name="overrideSettingsApplication"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtConfirmationMessage::overrideSettingsApplication () const</h3>
<p>See also <a href="qxtconfirmationmessage.html#setOverrideSettingsApplication">setOverrideSettingsApplication</a>().</p>
<h3 class="fn"><a name="overrideSettingsKey"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtConfirmationMessage::overrideSettingsKey () const</h3>
<p>See also <a href="qxtconfirmationmessage.html#setOverrideSettingsKey">setOverrideSettingsKey</a>().</p>
<h3 class="fn"><a name="overrideSettingsOrganization"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtConfirmationMessage::overrideSettingsOrganization () const</h3>
<p>See also <a href="qxtconfirmationmessage.html#setOverrideSettingsOrganization">setOverrideSettingsOrganization</a>().</p>
<h3 class="fn"><a name="rememberOnReject"></a>bool QxtConfirmationMessage::rememberOnReject () const</h3>
<p>See also <a href="qxtconfirmationmessage.html#setRememberOnReject">setRememberOnReject</a>().</p>
<h3 class="fn"><a name="reset"></a>void QxtConfirmationMessage::reset () <tt> [slot]</tt></h3>
<p>Resets this instance of <a href="qxtconfirmationmessage.html">QxtConfirmationMessage</a>. A reseted confirmation message is shown again until user checks <b>"Do not show again."</b> and accepts the confirmation message.</p>
<h3 class="fn"><a name="setConfirmationText"></a>void QxtConfirmationMessage::setConfirmationText ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>confirmation</i> )</h3>
<p>See also <a href="qxtconfirmationmessage.html#confirmationText">confirmationText</a>().</p>
<h3 class="fn"><a name="setOverrideSettingsApplication"></a>void QxtConfirmationMessage::setOverrideSettingsApplication ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>application</i> )</h3>
<p>See also <a href="qxtconfirmationmessage.html#overrideSettingsApplication">overrideSettingsApplication</a>().</p>
<h3 class="fn"><a name="setOverrideSettingsKey"></a>void QxtConfirmationMessage::setOverrideSettingsKey ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>key</i> )</h3>
<p>See also <a href="qxtconfirmationmessage.html#overrideSettingsKey">overrideSettingsKey</a>().</p>
<h3 class="fn"><a name="setOverrideSettingsOrganization"></a>void QxtConfirmationMessage::setOverrideSettingsOrganization ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>organization</i> )</h3>
<p>See also <a href="qxtconfirmationmessage.html#overrideSettingsOrganization">overrideSettingsOrganization</a>().</p>
<h3 class="fn"><a name="setRememberOnReject"></a>void QxtConfirmationMessage::setRememberOnReject ( bool <i>remember</i> )</h3>
<p>See also <a href="qxtconfirmationmessage.html#rememberOnReject">rememberOnReject</a>().</p>
<h3 class="fn"><a name="setSettingsFormat"></a>void QxtConfirmationMessage::setSettingsFormat ( <a href="http://doc.qtsoftware.com/4.5/qsettings.html#Format-enum">QSettings::Format</a> <i>format</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>format</i> used for storing settings.</p>
<p>See also <a href="qxtconfirmationmessage.html#settingsFormat">settingsFormat</a>().</p>
<h3 class="fn"><a name="setSettingsPath"></a>void QxtConfirmationMessage::setSettingsPath ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>path</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>path</i> used for storing settings.</p>
<p>See also <a href="qxtconfirmationmessage.html#settingsPath">settingsPath</a>().</p>
<h3 class="fn"><a name="setSettingsScope"></a>void QxtConfirmationMessage::setSettingsScope ( <a href="http://doc.qtsoftware.com/4.5/qsettings.html#Scope-enum">QSettings::Scope</a> <i>scope</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>scope</i> used for storing settings.</p>
<p>See also <a href="qxtconfirmationmessage.html#settingsScope">settingsScope</a>().</p>
<h3 class="fn"><a name="settingsFormat"></a><a href="http://doc.qtsoftware.com/4.5/qsettings.html#Format-enum">QSettings::Format</a> QxtConfirmationMessage::settingsFormat () <tt> [static]</tt></h3>
<p>Returns The format used for storing settings.</p>
<p>The default value is <a href="http://doc.qtsoftware.com/4.5/qsettings.html#Format-enum">QSettings::NativeFormat</a>.</p>
<h3 class="fn"><a name="settingsPath"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtConfirmationMessage::settingsPath () <tt> [static]</tt></h3>
<p>Returns the path used for storing settings.</p>
<p>The default value is an empty string.</p>
<h3 class="fn"><a name="settingsScope"></a><a href="http://doc.qtsoftware.com/4.5/qsettings.html#Scope-enum">QSettings::Scope</a> QxtConfirmationMessage::settingsScope () <tt> [static]</tt></h3>
<p>Returns The scope used for storing settings.</p>
<p>The default value is <a href="http://doc.qtsoftware.com/4.5/qsettings.html#Scope-enum">QSettings::UserScope</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
