The PrefCheckBox class. More...

#include <PrefWidgets.h>

Public Member Functions
	PrefCheckBox (QWidget *parent=nullptr)

virtual	~PrefCheckBox ()

Public Member Functions inherited from Gui::PrefWidget
QByteArray	entryName () const
	Returns the widget's preference name. More...

virtual void	OnChange (Base::Subject< const char * > &rCaller, const char *sReason)
	This method is called if one or more values in the parameter settings are changed where getParamGrp() points to. More...

void	onRestore ()
	Restores the preferences of the widget. More...

void	onSave ()
	Saves the current preferences of the widget. More...

QByteArray	paramGrpPath () const
	Returns the widget's preferences path. More...

void	setEntryName (const QByteArray &name)
	Sets the preference name to name. More...

void	setParamGrpPath (const QByteArray &path)
	Sets the preference path to path. More...

void	setPrefEntry (const QByteArray &name)
	Does the same as setEntryName(). More...

void	setPrefPath (const QByteArray &name)
	Does the same as setParamGrpPath(). More...

Public Member Functions inherited from Gui::WindowParameter
ParameterGrp::handle	getWindowParameter (void)
	return the parameter group of this window More...

void	OnChange (Base::Subject< const char * > &rCaller, const char *sReason)

bool	setGroupName (const char *name)
	Sets the group of the window to name. More...

	WindowParameter (const char *name)

virtual	~WindowParameter ()

Protected Member Functions
void	restorePreferences ()
	Restores the preferences Must be reimplemented in any subclasses. More...

void	savePreferences ()
	Save the preferences Must be reimplemented in any subclasses. More...

Protected Member Functions inherited from Gui::PrefWidget
void	failedToRestore (const QString &) const
	Print warning that restoring failed. More...

void	failedToSave (const QString &) const
	Print warning that saving failed. More...

	PrefWidget ()
	Constructs a preference widget. More...

virtual void	restorePreferences ()=0
	Restores the preferences Must be reimplemented in any subclasses. More...

virtual void	savePreferences ()=0
	Save the preferences Must be reimplemented in any subclasses. More...

virtual	~PrefWidget ()
	Destroys the widget and detaches it from its parameter group. More...

Properties
QByteArray	prefEntry

QByteArray	prefPath

Additional Inherited Members
Static Public Member Functions inherited from Gui::WindowParameter
static ParameterGrp::handle	getDefaultParameter (void)
	get the parameters More...

Detailed Description

The PrefCheckBox class.

Author: Werner Mayer

Constructor & Destructor Documentation

◆ PrefCheckBox()

PrefCheckBox::PrefCheckBox ( QWidget * parent = nullptr )

◆ ~PrefCheckBox()

PrefCheckBox::~PrefCheckBox ( )

virtual

Member Function Documentation

◆ restorePreferences()

void PrefCheckBox::restorePreferences ( )

protectedvirtual

Restores the preferences Must be reimplemented in any subclasses.

Implements Gui::PrefWidget.

References Gui::PrefWidget::entryName(), Gui::PrefWidget::failedToRestore(), ParameterGrp::GetBool(), Gui::WindowParameter::getWindowParameter(), and draftgeoutils.general::isNull().

◆ savePreferences()

void PrefCheckBox::savePreferences ( )

protectedvirtual

Save the preferences Must be reimplemented in any subclasses.

Implements Gui::PrefWidget.

References Gui::PrefWidget::entryName(), Gui::PrefWidget::failedToSave(), Gui::WindowParameter::getWindowParameter(), draftgeoutils.general::isNull(), and ParameterGrp::SetBool().

Property Documentation

◆ prefEntry

QByteArray Gui::PrefCheckBox::prefEntry

readwrite

◆ prefPath

QByteArray Gui::PrefCheckBox::prefPath

readwrite

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

FreeCAD/src/Gui/PrefWidgets.h
FreeCAD/src/Gui/PrefWidgets.cpp

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members