XAbstractConfigure Class Reference

#include <xabstractconfigure.h>

List of all members.

Public Slots
virtual bool	sSave ()=0
Protected Member Functions
	XAbstractConfigure (QWidget *parent=0, Qt::WindowFlags f=0)
	Abstract interface definition for xTuple ERP Configure widgets.
virtual	~XAbstractConfigure ()
Protected Slots
virtual void	languageChange ()=0

---

Constructor & Destructor Documentation

XAbstractConfigure::XAbstractConfigure	(	QWidget *	parent = 0,
		Qt::WindowFlags	f = 0
	)		[protected]

Abstract interface definition for xTuple ERP Configure widgets.

XAbstractConfigure is an abstract class defining a simple programming interface that all configuration windows must implement. This is used by the Setup window to ensure that all data get saved properly.

Every configuration UI intended to be included in the Setup window should inherit from XAbstractConfigure. It must implement a languageChange() method and an sSave() method. The languageChange() method is usually empty; it is required to ensure that the configuration window can be translated. The sSave method returns a boolean. It should return true if the save attempt was successful and false if the save attempt failed. If the save attempt failed, sSave() should set the focus on the failed widget and give the user a QMessageBox explaining the failure. It is the Setup window's responsibility to handle the failure and focus widget gracefully.

Child classes of XAbstractConfigure should define a saving() signal and emit it at the beginning of sSave(). This will allow scripts on these child classes to save their own data.

Todo:

Find a way for scripts to return failures so they also can handle errors during saving.

See also:

setup

XAbstractConfigure::~XAbstractConfigure

(

)

[protected, virtual]

---

Member Function Documentation

virtual void XAbstractConfigure::languageChange

(

)

[protected, pure virtual, slot]

Reimplemented from QWidget.

Implemented in configureIE, configureSO, configureCC, configureEncryption, configureMS, configurePO, configureCRM, configureGL, configurePD, configureWO, registrationKey, configureIM, and databaseInformation.

virtual bool XAbstractConfigure::sSave

(

)

[pure virtual, slot]

Implemented in configureIE, configureCC, databaseInformation, configureEncryption, configureMS, configurePO, configureSO, configureCRM, configureGL, configurePD, configureWO, configureIM, and registrationKey.

---

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

• xabstractconfigure.h
• xabstractconfigure.cpp