#include <DlgCheckableMessageBox.h>

Public Member Functions
virtual void	accept ()

QString	checkBoxText () const

QAbstractButton *	clickedButton () const

QDialogButtonBox::StandardButton	clickedStandardButton () const

QDialogButtonBox::StandardButton	defaultButton () const

	DlgCheckableMessageBox (QWidget *parent)

QPixmap	iconPixmap () const

bool	isChecked () const

virtual void	reject ()

void	setCheckBoxText (const QString &)

void	setChecked (bool s)

void	setDefaultButton (QDialogButtonBox::StandardButton s)

void	setIconPixmap (const QPixmap &p)

void	setPrefEntry (const QString &entry)

void	setPrefPath (const QString &path)

void	setStandardButtons (QDialogButtonBox::StandardButtons s)

void	setText (const QString &)

QDialogButtonBox::StandardButtons	standardButtons () const

QString	text () const

virtual	~DlgCheckableMessageBox ()

Static Public Member Functions
static QMessageBox::StandardButton	dialogButtonBoxToMessageBoxButton (QDialogButtonBox::StandardButton)

static QDialogButtonBox::StandardButton	question (QWidget parent, const QString &title, const QString &question, const QString &checkBoxText, bool checkBoxSetting, QDialogButtonBox::StandardButtons buttons=QDialogButtonBox::Yes\|QDialogButtonBox::No, QDialogButtonBox::StandardButton defaultButton=QDialogButtonBox::No)

static void	showMessage (const QString &header, const QString &message, bool check=false, const QString &checkText=QString::fromLatin1("Don't show me again"))
	convenient show method It shows a dialog with header and message provided and a checkbox in check state with the message provided. More...

static void	showMessage (const QString &header, const QString &message, const QString &prefPath, const QString &paramEntry, bool entryDefault=false, bool check=false, const QString &checkText=QString::fromLatin1("Don't show me again"))
	Same as showMessage above, but it checks the specific preference path and parameter provided, defaulting to entryDefault value if the parameter is not present. More...

Properties
QDialogButtonBox::StandardButtons	buttons

QString	checkBoxText

QDialogButtonBox::StandardButton	defaultButton

QPixmap	iconPixmap

bool	isChecked

QString	text

Constructor & Destructor Documentation

◆ DlgCheckableMessageBox()

Gui::Dialog::DlgCheckableMessageBox::DlgCheckableMessageBox ( QWidget * parent )

explicit

References accept(), Gui::Dialog::Ui_DlgCheckableMessageBox::buttonBox, draftgeoutils.intersections::connect(), Gui::Dialog::Ui_DlgCheckableMessageBox::pixmapLabel, reject(), Gui::Dialog::Ui_DlgCheckableMessageBox::setupUi(), and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by showMessage().

◆ ~DlgCheckableMessageBox()

Gui::Dialog::DlgCheckableMessageBox::~DlgCheckableMessageBox ( )

virtual

Member Function Documentation

◆ accept()

void Gui::Dialog::DlgCheckableMessageBox::accept ( )

virtual

References App::GetApplication(), App::Application::GetParameterGroupByPath(), isChecked, and ParameterGrp::SetBool().

Referenced by femexamples.examplesgui.FemExamples::clicked(), DlgCheckableMessageBox(), femexamples.examplesgui.FemExamples::double_clicked(), ArchComponent.ComponentTaskPanel::editObject(), and PathScripts.PathToolBitLibraryGui.ToolBitLibrary::toolEdit().

◆ checkBoxText()

QString Gui::Dialog::DlgCheckableMessageBox::checkBoxText ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::checkBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

◆ clickedButton()

QAbstractButton * Gui::Dialog::DlgCheckableMessageBox::clickedButton ( ) const

References Gui::Dialog::DlgCheckableMessageBoxPrivate::clickedButton.

◆ clickedStandardButton()

QDialogButtonBox::StandardButton Gui::Dialog::DlgCheckableMessageBox::clickedStandardButton ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::buttonBox, Gui::Dialog::DlgCheckableMessageBoxPrivate::clickedButton, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question().

◆ defaultButton()

QDialogButtonBox::StandardButton Gui::Dialog::DlgCheckableMessageBox::defaultButton ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::buttonBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

◆ dialogButtonBoxToMessageBoxButton()

QMessageBox::StandardButton Gui::Dialog::DlgCheckableMessageBox::dialogButtonBoxToMessageBoxButton ( QDialogButtonBox::StandardButton db )

static

◆ iconPixmap()

QPixmap Gui::Dialog::DlgCheckableMessageBox::iconPixmap ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::pixmapLabel, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

◆ isChecked()

bool Gui::Dialog::DlgCheckableMessageBox::isChecked ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::checkBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

◆ question()

QDialogButtonBox::StandardButton Gui::Dialog::DlgCheckableMessageBox::question	(	QWidget *	parent,
		const QString &	title,
		const QString &	question,
		const QString &	checkBoxText,
		bool *	checkBoxSetting,
		QDialogButtonBox::StandardButtons	buttons = `QDialogButtonBox::Yes\|QDialogButtonBox::No`,
		QDialogButtonBox::StandardButton	defaultButton = `QDialogButtonBox::No`
	)

static

References buttons, checkBoxText, clickedStandardButton(), defaultButton, isChecked, question(), setCheckBoxText(), setChecked(), setDefaultButton(), setIconPixmap(), setStandardButtons(), and setText().

Referenced by question().

◆ reject()

void Gui::Dialog::DlgCheckableMessageBox::reject ( )

virtual

References App::GetApplication(), App::Application::GetParameterGroupByPath(), isChecked, and ParameterGrp::SetBool().

Referenced by draftguitools.gui_hatch.Draft_Hatch_TaskPanel::accept(), draftguitools.gui_setstyle.Draft_SetStyle_TaskPanel::accept(), drafttaskpanels.task_shapestring.ShapeStringTaskPanelCmd::accept(), drafttaskpanels.task_shapestring.ShapeStringTaskPanelEdit::accept(), drafttaskpanels.task_shapestring.ShapeStringTaskPanel::action(), femexamples.examplesgui.FemExamples::clicked(), DlgCheckableMessageBox(), and PathScripts.PathToolBitLibraryGui.ToolBitLibrary::toolEdit().

◆ setCheckBoxText()

void Gui::Dialog::DlgCheckableMessageBox::setCheckBoxText ( const QString & t )

References Gui::Dialog::Ui_DlgCheckableMessageBox::checkBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question(), and showMessage().

◆ setChecked()

void Gui::Dialog::DlgCheckableMessageBox::setChecked ( bool s )

References Gui::Dialog::Ui_DlgCheckableMessageBox::checkBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question(), setPrefEntry(), and showMessage().

◆ setDefaultButton()

void Gui::Dialog::DlgCheckableMessageBox::setDefaultButton ( QDialogButtonBox::StandardButton s )

References Gui::Dialog::Ui_DlgCheckableMessageBox::buttonBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question(), and showMessage().

◆ setIconPixmap()

void Gui::Dialog::DlgCheckableMessageBox::setIconPixmap ( const QPixmap & p )

References Gui::Dialog::Ui_DlgCheckableMessageBox::pixmapLabel, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question(), and showMessage().

◆ setPrefEntry()

void Gui::Dialog::DlgCheckableMessageBox::setPrefEntry ( const QString & entry )

References App::GetApplication(), ParameterGrp::GetBool(), App::Application::GetParameterGroupByPath(), setChecked(), and Gui::Dialog::toParamEntry().

Referenced by showMessage().

◆ setPrefPath()

void Gui::Dialog::DlgCheckableMessageBox::setPrefPath ( const QString & path )

◆ setStandardButtons()

void Gui::Dialog::DlgCheckableMessageBox::setStandardButtons ( QDialogButtonBox::StandardButtons s )

References Gui::Dialog::Ui_DlgCheckableMessageBox::buttonBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question(), and showMessage().

◆ setText()

void Gui::Dialog::DlgCheckableMessageBox::setText ( const QString & t )

References Gui::Dialog::Ui_DlgCheckableMessageBox::messageLabel, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by question(), and showMessage().

◆ showMessage() [1/2]

void Gui::Dialog::DlgCheckableMessageBox::showMessage	(	const QString &	header,
		const QString &	message,
		bool	check = `false`,
		const QString &	checkText = `QString::fromLatin1("Don't show me again")`
	)

static

convenient show method It shows a dialog with header and message provided and a checkbox in check state with the message provided.

It uses a parameter in path "User parameter:BaseApp/CheckMessages" derived from the header test, defaulting to false, to store the status of the checkbox, when the user exits the modal dialog.

References DlgCheckableMessageBox(), App::GetApplication(), ParameterGrp::GetBool(), Gui::getMainWindow(), App::Application::GetParameterGroupByPath(), setCheckBoxText(), setChecked(), setDefaultButton(), setIconPixmap(), setPrefEntry(), setStandardButtons(), setText(), and Gui::Dialog::toParamEntry().

Referenced by SketcherGui::notifyConstraintSubstitutions(), and Gui::Dialog::DocumentRecovery::on_buttonCleanup_clicked().

◆ showMessage() [2/2]

void Gui::Dialog::DlgCheckableMessageBox::showMessage	(	const QString &	header,
		const QString &	message,
		const QString &	prefPath,
		const QString &	paramEntry,
		bool	entryDefault = `false`,
		bool	check = `false`,
		const QString &	checkText = `QString::fromLatin1("Don't show me again")`
	)

static

Same as showMessage above, but it checks the specific preference path and parameter provided, defaulting to entryDefault value if the parameter is not present.

References App::GetApplication(), ParameterGrp::GetBool(), Gui::getMainWindow(), and App::Application::GetParameterGroupByPath().

◆ standardButtons()

QDialogButtonBox::StandardButtons Gui::Dialog::DlgCheckableMessageBox::standardButtons ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::buttonBox, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

◆ text()

QString Gui::Dialog::DlgCheckableMessageBox::text ( ) const

References Gui::Dialog::Ui_DlgCheckableMessageBox::messageLabel, and Gui::Dialog::DlgCheckableMessageBoxPrivate::ui.

Referenced by importSVG.svgHandler::characters(), draftguitools.gui_texts.Text::createObject(), draftviewproviders.view_text.ViewProviderText::createObject(), importSVG.svgHandler::endElement(), exportIFCHelper.SIUnitCreator::getSIPrefix(), exportIFCHelper.SIUnitCreator::getSIUnitName(), and Mod.Test.unittestgui.ProgressBar::paint().

Property Documentation

◆ buttons

QDialogButtonBox::StandardButtons Gui::Dialog::DlgCheckableMessageBox::buttons

readwrite

Referenced by question(), Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft::updateButton(), and Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft::updateButtons().

◆ checkBoxText

QString Gui::Dialog::DlgCheckableMessageBox::checkBoxText

readwrite

Referenced by question().

◆ defaultButton

QDialogButtonBox::StandardButton Gui::Dialog::DlgCheckableMessageBox::defaultButton

readwrite

Referenced by question().

◆ iconPixmap

QPixmap Gui::Dialog::DlgCheckableMessageBox::iconPixmap

readwrite

◆ isChecked

bool Gui::Dialog::DlgCheckableMessageBox::isChecked

readwrite

Referenced by accept(), question(), and reject().

◆ text

QString Gui::Dialog::DlgCheckableMessageBox::text

readwrite

Referenced by importSVG.svgHandler::characters(), draftguitools.gui_texts.Text::createObject(), draftviewproviders.view_text.ViewProviderText::createObject(), importSVG.svgHandler::endElement(), exportIFCHelper.SIUnitCreator::getSIPrefix(), exportIFCHelper.SIUnitCreator::getSIUnitName(), and Mod.Test.unittestgui.ProgressBar::paint().

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

FreeCAD/src/Gui/DlgCheckableMessageBox.h
FreeCAD/src/Gui/DlgCheckableMessageBox.cpp

Public Member Functions

Static Public Member Functions

Properties

Constructor & Destructor Documentation

◆ DlgCheckableMessageBox()

◆ ~DlgCheckableMessageBox()

Member Function Documentation

◆ accept()

◆ checkBoxText()

◆ clickedButton()

◆ clickedStandardButton()

◆ defaultButton()

◆ dialogButtonBoxToMessageBoxButton()

◆ iconPixmap()

◆ isChecked()

◆ question()

◆ reject()

◆ setCheckBoxText()

◆ setChecked()

◆ setDefaultButton()

◆ setIconPixmap()

◆ setPrefEntry()

◆ setPrefPath()

◆ setStandardButtons()

◆ setText()

◆ showMessage() [1/2]

◆ showMessage() [2/2]

◆ standardButtons()

◆ text()

Property Documentation

◆ buttons

◆ checkBoxText

◆ defaultButton

◆ iconPixmap

◆ isChecked

◆ text