Global Variables and Functions

The xTuple ERP desktop client has a main single main application window, an instance of the GUIClient class. This is exposed to the rest of the application in the global omfgThis variable. There is also a handful of global variables. More...

Macros
#define	ENTERED

Variables
QList< QString >	_hotkeyList
	A list of the hot keys currently mapped for use. More...
Metrics *	_metrics
	A cache of the metrics table. More...
Metricsenc *	_metricsenc
	A cache of the metricsenc table for encrypted metrics. More...
Preferences *	_preferences
	A cache of user preferences. More...
Privileges *	_privileges
	A cache of user privileges. More...
QSplashScreen *	_splash
	The splash screen shown at application startup. More...

Detailed Description

The xTuple ERP desktop client has a main single main application window, an instance of the GUIClient class. This is exposed to the rest of the application in the global omfgThis variable. There is also a handful of global variables.

Macro Definition Documentation

ENTERED

#define ENTERED

Place ENTERED after the opening bracket of methods in files that include guiclient.h or widgets.h and define the DEBUG macro. @ENTERED writes information about the method being called. If the method was invoked by a signal, information about the signal is included.

ENTERED generates a simple C++ statement and does not terminate that statement, so a trailing semicolon ( @; ) is required. It uses qDebug() to generate the output, so you can add to the output if you wish with the @ << operator.

void MyClass::method1()
{
  ENTERED;
  // do stuff
}
 
void MyClass::method2(Type1 arg1, Type2 arg2)
{
  ENTERED << "with" << arg1 << arg2;
  // do different stuff
}

Variable Documentation

_hotkeyList

QList<QString> _hotkeyList

A list of the hot keys currently mapped for use.

Values beginning with C are mapped to control keys while those that start with F are function keys.

Todo:

Make this static or a private member of GUIClient?

_metrics

Metrics* _metrics

A cache of the metrics table.

_metricsenc

Metricsenc* _metricsenc

A cache of the metricsenc table for encrypted metrics.

_preferences

Preferences* _preferences

A cache of user preferences.

_privileges

Privileges* _privileges

A cache of user privileges.

The cache is refreshed when the user starts the application or selects "Rescan Privileges" from the System menu.

_splash

QSplashScreen* _splash

The splash screen shown at application startup.

This shows the application edition and progress as the application reads basic information from the database.

Todo:

Make this static, hence internal to guiclient.cpp ?