ParameterWidget Class Reference

#include <parameterwidget.h>

List of all members.

Classes
struct	ParamProps
Public Types
enum	ParameterWidgetTypes {   Crmacct, User, Text, Date,   XComBox, Contact, Multiselect, GLAccount }
Public Member Functions
	ParameterWidget (QWidget *pParent, const char *=0)
void	appendValue (ParameterList &)
Q_INVOKABLE void	applyDefaultFilterSet ()
Q_INVOKABLE ParameterList	parameters ()
Q_INVOKABLE int	paramIndex (QString pName)
Public Slots
void	addParam ()
void	append (QString pName, QString pParam, enum ParameterWidgetTypes pType=Text, QVariant pDefault=0, bool pRequired=false, QString pExtraInfo=QString())
void	appendComboBox (QString pName, QString pParam, enum XComboBox::XComboBoxTypes pType, QVariant pDefault=0, bool pRequired=false)
void	appendComboBox (QString pName, QString pParam, QString pQuery, QVariant pDefault=0, bool pRequired=false)
void	applySaved (int pId=0, int filter_id=0)
void	changeFilterObject (int index)
void	clearFilters ()
void	removeParam (int)
void	save ()
void	setDefault (QString pName, QVariant pDefault, bool pAutoApply=false)
void	setFiltersDefault ()
void	setFiltersVisabiltyPreference ()
void	setSavedFilters (int defaultId=-1)
void	setSavedFiltersIndex (QString)
void	setType (QString, QString, enum ParameterWidgetTypes=Text, QVariant pDefault=0, QVariant extraInfo=QVariant())
void	setXComboBoxType (QString, QString, QString, QVariant pDefault=0)
void	setXComboBoxType (QString, QString, enum XComboBox::XComboBoxTypes, QVariant pDefault=0)
void	sManageFilters ()
void	storeFilterValue (int pId=-1, QObject *filter=0)
void	toggleSave ()
Signals
void	cleared ()
void	filterChanged ()
void	filterSetSaved ()
void	updated ()
Protected Member Functions
bool	containsUsedType (QString)
int	getFilterIndex (const QWidget *filterwidget)
QWidget *	getFilterWidget (const int index)
QString	getParameterTypeKey (QString)
void	setSelectedFilter (int filter_id)
virtual void	showEvent (QShowEvent *)
Protected Slots
void	resetMultiselect (QTableWidgetItem *item)

---

Member Enumeration Documentation

enum ParameterWidget::ParameterWidgetTypes

Enumerator:

Crmacct
User
Text
Date
XComBox
Contact
Multiselect
GLAccount

---

Constructor & Destructor Documentation

ParameterWidget::ParameterWidget	(	QWidget *	pParent,
		const char *	pName = 0
	)

---

Member Function Documentation

void ParameterWidget::addParam

(

)

[slot]

void ParameterWidget::append	(	QString	pName,
		QString	pParam,
		enum ParameterWidgetTypes	pType = Text,
		QVariant	pDefault = 0,
		bool	pRequired = false,
		QString	pExtraInfo = QString()
	)			[slot]

Appends a parameter selection pName using parameterWidgetTypes pType to the filter set list using output parameter name pParam. An optional default value can be set using pDefault. Use pRequired to flag whether the parameter is required or not. Use extraInfo to pass a query string for multi-select types.

void ParameterWidget::appendComboBox	(	QString	pName,
		QString	pParam,
		enum XComboBox::XComboBoxTypes	pType,
		QVariant	pDefault = 0,
		bool	pRequired = false
	)			[slot]

Appends a parameter selection pName using an xcombobox to the filter set list using output parameter name pParam. The xcombobox type is specified by pType with an optional default id that can be set using pDefault. Use pRequired to flag whether the parameter is required or not.

void ParameterWidget::appendComboBox	(	QString	pName,
		QString	pParam,
		QString	pQuery,
		QVariant	pDefault = 0,
		bool	pRequired = false
	)			[slot]

Appends a parameter selection pName using an xcombobox to the filter set list using output parameter name pParam. The xcombobox type is populated by query string pQry with an optional default id that can be set using pDefault. Use pRequired to flag whether the parameter is required or not.

void ParameterWidget::appendValue

(

ParameterList &

pParams

)

void ParameterWidget::applyDefaultFilterSet

(

)

void ParameterWidget::applySaved	(	int	pId = 0,
		int	filter_id = 0
	)			[slot]

void ParameterWidget::changeFilterObject

(

int

index

)

[slot]

void ParameterWidget::cleared

(

)

[signal]

void ParameterWidget::clearFilters

(

)

[slot]

bool ParameterWidget::containsUsedType

(

QString

value

)

[protected]

void ParameterWidget::filterChanged

(

)

[signal]

void ParameterWidget::filterSetSaved

(

)

[signal]

int ParameterWidget::getFilterIndex

(

const QWidget *

filterwidget

)

[protected]

QWidget * ParameterWidget::getFilterWidget

(

const int

index

)

[protected]

QString ParameterWidget::getParameterTypeKey

(

QString

pValue

)

[protected]

ParameterList ParameterWidget::parameters

(

)

int ParameterWidget::paramIndex

(

QString

pName

)

Returns the index of an appended parameter definition of pName.

void ParameterWidget::removeParam

(

int

pRow

)

[slot]

void ParameterWidget::resetMultiselect

(

QTableWidgetItem *

item

)

[protected, slot]

void ParameterWidget::save

(

)

[slot]

void ParameterWidget::setDefault	(	QString	pName,
		QVariant	pDefault,
		bool	pAutoApply = false
	)			[slot]

Set the default value on an existing parameter pName to pDefault. If pDefault is not passed or 0 then the previous default, if any, will be removed. if pAutoApply is true, then the default filter set will be automatically applied.

See also:

applyDefaultFilterSet();

void ParameterWidget::setFiltersDefault

(

)

[slot]

Sets the current filter as the default for the parent object it resides in.

void ParameterWidget::setFiltersVisabiltyPreference

(

)

[slot]

void ParameterWidget::setSavedFilters

(

int

defaultId = -1

)

[slot]

Sets a saved filter set with Id defaultId to the currently selected filter. If no pDefaultId is provided the default filter will be used.

See also:

setSavedFiltersIndex(QString);

void ParameterWidget::setSavedFiltersIndex

(

QString

filterSetName

)

[slot]

void ParameterWidget::setSelectedFilter

(

int

filter_id

)

[protected]

void ParameterWidget::setType	(	QString	,
		QString	,
		enum	ParameterWidgetTypes = Text,
		QVariant	pDefault = 0,
		QVariant	extraInfo = QVariant()
	)			[slot]

void ParameterWidget::setXComboBoxType	(	QString	pName,
		QString	pParam,
		QString	pQry,
		QVariant	pDefault = 0
	)			[slot]

void ParameterWidget::setXComboBoxType	(	QString	pName,
		QString	pParam,
		enum XComboBox::XComboBoxTypes	xType,
		QVariant	pDefault = 0
	)			[slot]

void ParameterWidget::showEvent

(

QShowEvent *

event

)

[protected, virtual]

Reimplemented from QWidget.

void ParameterWidget::sManageFilters

(

)

[slot]

void ParameterWidget::storeFilterValue	(	int	pId = -1,
		QObject *	filter = 0
	)			[slot]

void ParameterWidget::toggleSave

(

)

[slot]

void ParameterWidget::updated

(

)

[signal]

---

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

• parameterwidget.h
• parameterwidget.cpp