List of all members | Public Slots | Protected Member Functions | Protected Slots
XAbstractConfigure Class Referenceabstract

#include <xabstractconfigure.h>

Public Slots

virtual bool sSave ()=0
 
- Public Slots inherited from XWidget
virtual enum SetResponse set (const ParameterList &)
 

Protected Member Functions

 XAbstractConfigure (QWidget *parent=0, Qt::WindowFlags f=0)
 Abstract interface definition for xTuple ERP Configure widgets. More...
 
virtual ~XAbstractConfigure ()
 
- Protected Member Functions inherited from XWidget
void closeEvent (QCloseEvent *event)
 
QScriptEngine * engine ()
 
void showEvent (QShowEvent *event)
 

Protected Slots

virtual void languageChange ()=0
 
- Protected Slots inherited from XWidget
virtual enum SetResponse postSet ()
 

Additional Inherited Members

- Public Member Functions inherited from XWidget
 XWidget (QWidget *parent=0, Qt::WindowFlags flags=0)
 
 XWidget (QWidget *parent, const char *name, Qt::WindowFlags flags=0)
 
 ~XWidget ()
 
virtual Q_INVOKABLE ParameterList get () const
 

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 ( )
protectedvirtual

Member Function Documentation

virtual void XAbstractConfigure::languageChange ( )
protectedpure virtualslot
virtual bool XAbstractConfigure::sSave ( )
pure virtualslot

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

Generated on Fri Oct 7 2016 14:23:35 xTuple ERP Programmer Reference, Version 4.2.0 doxygen 1.8.10