The ParameterWidget provides a consistent user and programming interface for managing query criteria. More...

#include <parameterwidget.h>

Inheritance diagram for ParameterWidget:

Public Types
enum	ParameterWidgetTypes { Crmacct, User, Text, Date, XComBox, Contact, Multiselect, GLAccount, Exists, CheckBox, Project, Customer, Site, Vendor, Item, Employee, Shipto, SalesOrder, WorkOrder, PurchaseOrder, TransferOrder }

Properties
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	objectName

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Public Slots
void	addParam ()

void	append (QString pName, QString pParam, enum ParameterWidgetTypes pType=Text, QVariant pDefault=QVariant(), bool pRequired=false, QString pExtraInfo=QString())
	Add a new filter to the set of available filters. More...

void	appendComboBox (QString pName, QString pParam, QString pQuery, QVariant pDefault=QVariant(), bool pRequired=false)
	Add a new XComboBox-based filter to the set of available filters. More...

void	appendComboBox (QString pName, QString pParam, int pType, QVariant pDefault=QVariant(), bool pRequired=false)
	Add a new XComboBox-based filter to the set of available filters. More...

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=QVariant(), bool pAutoApply=false)

void	setEnabled (QString pName, bool pEnabled)

void	setFiltersDefault ()

void	setFiltersVisabiltyPreference ()

void	setFiltersVisible (bool visible)

void	setSavedFilters (int defaultId=-1)

void	setSavedFiltersIndex (QString)

void	setType (QString, QString, ParameterWidgetTypes=Text, QVariant pDefault=QVariant(), QVariant extraInfo=QVariant())

void	setXComboBoxType (QString, QString, enum XComboBox::XComboBoxTypes, QVariant pDefault=QVariant())

void	setXComboBoxType (QString, QString, QString, QVariant pDefault=QVariant())

void	sManageFilters ()

void	storeFilterValue (int pId=-1, QObject *filter=0)

void	toggleSave ()

Signals
void	cleared ()

void	filterChanged ()

void	filterSetSaved ()

void	updated ()

Public Member Functions
	ParameterWidget (QWidget pParent, const char =0)
	Create a new Parameter Widget. More...

	~ParameterWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

void	appendValue (ParameterList &)
	Add name/value pairs to the input ParameterList to reflect the current user selections. More...

Q_INVOKABLE void	applyDefaultFilterSet ()
	Find the default filter set for the ParameterWidget with the current parent and apply it. More...

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

bool	blockSignals (bool block)

QString	caption () const

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

const QObjectList &	children () const

QRect	childrenRect () const

QRegion	childrenRegion () const

const char *	className () const

void	clearFocus ()

void	clearMask ()

bool	close ()

bool	close (bool alsoDelete)

int	colorCount () const

QColorGroup	colorGroup () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	deleteLater ()

int	depth () const

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (int x, int y, int w, int h)

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

virtual bool	eventFilter (QObject watched, QEvent event)

Q_INVOKABLE QString	filter ()

T	findChild (const QString &name) const

QList< T >	findChildren (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

int	heightMM () const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

bool	inherits (const char *className) const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWidgetType () const

bool	isWindow () const

bool	isWindowModified () const

void	killTimer (int id)

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

int	logicalDpiX () const

int	logicalDpiY () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

virtual const QMetaObject *	metaObject () const

int	minimumHeight () const

QSize	minimumSize () const

virtual QSize	minimumSizeHint () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

int	numColors () const

QString	objectName () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

bool	paintingActive () const

const QPalette &	palette () const

Q_INVOKABLE ParameterList	parameters ()

Q_INVOKABLE int	paramIndex (QString pName)

QObject *	parent () const

QWidget *	parentWidget () const

QWidget *	parentWidget (bool sameWindow) const

int	physicalDpiX () const

int	physicalDpiY () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

QVariant	property (const char *name) const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (const QRegion &rgn)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &rect)

void	repaint (bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

void	retranslateUi (QWidget *ParameterWidget)

void	retranslateUi (QWidget *ParameterWidget)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QObject *parent)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

bool	setProperty (const char *name, const QVariant &value)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (int w, int h)

void	setSizeIncrement (const QSize &)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

void	setupUi (QWidget *ParameterWidget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

bool	signalsBlocked () const

QSize	size () const

virtual QSize	sizeHint () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

int	startTimer (int interval)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QThread *	thread () const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update ()

void	update (int x, int y, int w, int h)

void	update (const QRegion &rgn)

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

int	widthMM () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	x11Screen () const

void *	x11Visual () const

int	y () const

Static Public Member Functions
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QWidgetMapper *	wmapper ()

int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes
QToolButton *	_addFilterRow

QPushButton *	_filterButton

QFrame *	_filterGroup

XComboBox *	_filterList

QLabel *	_filterListLit

QGridLayout *	_filtersLayout

QHBoxLayout *	_footerLayout

QSpacerItem *	_footerSpacer

QHBoxLayout *	_headerLayout

QSpacerItem *	_headerSpacer

QPushButton *	_manageButton

QPushButton *	_saveButton

QGridLayout *	gridLayout

QGridLayout *	gridLayout_2

typedef	RenderFlags

QVBoxLayout *	verticalLayout

QSpacerItem *	verticalSpacer

Protected Slots
void	resetMultiselect (QTableWidgetItem *item)

Protected Member Functions
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	connectNotify (const char *signal)

bool	containsUsedType (QString)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

virtual void	customEvent (QEvent *event)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	disconnectNotify (const char *signal)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual bool	event (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

int	getFilterIndex (const QWidget *filterwidget)

QWidget *	getFilterWidget (const int index)

QString	getParameterTypeKey (QString)

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

int	receivers (const char *signal) const

virtual void	resetEmptyParameter ()

void	resetInputContext ()

virtual void	resizeEvent (QResizeEvent *event)

QObject *	sender () const

int	senderSignalIndex () const

void	setSelectedFilter (int filter_id)

virtual void	showEvent (QShowEvent *)

virtual void	tabletEvent (QTabletEvent *event)

virtual void	timerEvent (QTimerEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Static Protected Member Functions
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

The ParameterWidget provides a consistent user and programming interface for managing query criteria.

The ParameterWidget can be used to set filtering criteria to apply to MetaSQL queries. The application developer defines what criteria can be used (e.g. filter by a date range), what the default values should be, if any, and which criteria are mandatory. The user then chooses which criteria to actually use at runtime and supplies values (e.g. 'January 1, 2010' through 'December 31, 2010').

It is the application developer's responsibility to ensure that the user's selections are honored by the query.

Specific sets of filtering criteria can be saved, reused, and shared between users. The details of the filter can be hidden from view or made visible, allowing for efficient use of screen real estate.

If application preferences are available, the most recently selected filter will saved when the parent window closes and will be reselected when the window is next opened.

Member Enumeration Documentation

enum ParameterWidget::ParameterWidgetTypes

Enumerator
Crmacct
User
Text
Date
XComBox
Contact
Multiselect
GLAccount
Exists
CheckBox
Project
Customer
Site
Vendor
Item
Employee
Shipto
SalesOrder
WorkOrder
PurchaseOrder
TransferOrder

Constructor & Destructor Documentation

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

Create a new Parameter Widget.

Parameters

pParent	The parent of this widget
pName	The object name to assign to this widget

ParameterWidget::~ParameterWidget ( )

Member Function Documentation

void ParameterWidget::addParam ( )

slot

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

slot

Add a new filter to the set of available filters.

Parameters

pName	The user-visible name for this filter to distinguish it from other filters in the same set
pParam	The name to use for the parameter in the ParameterList
pType	The type of widget for the user to enter a criterion in
pDefault	The default value to use for this parameter
pRequired	Required parameters cannot be removed from the filter set
pExtraInfo	A query string to use if pType indicates a combo box or multiselect

void ParameterWidget::appendComboBox	(	QString	pName,
		QString	pParam,
		QString	pQuery,
		QVariant	pDefault = `QVariant()`,
		bool	pRequired = `false`
	)

slot

Add a new XComboBox-based filter to the set of available filters.

Parameters

pName	The user-visible name for this filter to distinguish it from other filters in the same set
pParam	The name to use for the parameter in the ParameterList
pQuery	Set the XComboBox to populate itself with this query
pDefault	The default internal id to select for this XComboBox
pRequired	Required parameters cannot be removed from the filter set

void ParameterWidget::appendComboBox	(	QString	pName,
		QString	pParam,
		int	pType,
		QVariant	pDefault = `QVariant()`,
		bool	pRequired = `false`
	)

slot

Add a new XComboBox-based filter to the set of available filters.

Parameters

pName	The user-visible name for this filter to distinguish it from other filters in the same set
pParam	The name to use for the parameter in the ParameterList
pType	Set the XComboBox to use the corresponding XComboBox::XComboBoxTypes value
pDefault	The default internal id to select for this XComboBox
pRequired	Required parameters cannot be removed from the filter set

void ParameterWidget::appendValue ( ParameterList & pParams )

Add name/value pairs to the input ParameterList to reflect the current user selections.

The ParameterList passed in to this method is modified to reflect the current selections. Parameters already in the list have their associated values changed and parameters not in the list are added. No name/value pairs are removed from the list.

This should be used carefully, as cached ParameterLists may have name/value pairs that the caller does not expect.

Parameters

[in,out] pParams The ParameterList to modify

void ParameterWidget::applyDefaultFilterSet ( )

Find the default filter set for the ParameterWidget with the current parent and apply it.

This method searches for the default filter set based on the QObject::objectName of the parent and the QObject::objectName of this ParameterWidget instance. If it is found, then this filter set is applied.

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

QString ParameterWidget::filter ( )

Returns a text based list separated by line feeds of parameter names and selected values. Can be useful when passed to printed reports as a header description of what filter has been applied to the presented data.

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::resetEmptyParameter ( )

protectedvirtual

If the last parameter that has been added has not been selected, then reset it.

void ParameterWidget::resetMultiselect ( QTableWidgetItem * item )

protectedslot

void Ui_ParameterWidget::retranslateUi ( QWidget * ParameterWidget )

inlineinherited

void Ui_ParameterWidget::retranslateUi ( QWidget * ParameterWidget )

inlineinherited

void ParameterWidget::save ( )

slot

void ParameterWidget::setDefault	(	QString	pName,
		QVariant	pDefault = `QVariant()`,
		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::setEnabled	(	QString	pName,
		bool	pEnabled
	)

slot

Enable or disable an existing parameter pName to pEnabled. Useful if you want a specific value to be forced based on privilege control or some other specific criteria that would limit the user's selection ability. Is effective the next time a user instantiates the parameter.

void ParameterWidget::setFiltersDefault ( )

slot

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

void ParameterWidget::setFiltersVisabiltyPreference ( )

slot

void ParameterWidget::setFiltersVisible ( bool visible )

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	pName,
		QString	pParam,
		ParameterWidgetTypes	type = `Text`,
		QVariant	pDefault = `QVariant()`,
		QVariant	extraInfo = `QVariant()`
	)

slot

void Ui_ParameterWidget::setupUi ( QWidget * ParameterWidget )

inlineinherited

void ParameterWidget::setXComboBoxType	(	QString	pName,
		QString	pParam,
		enum XComboBox::XComboBoxTypes	xType,
		QVariant	pDefault = `QVariant()`
	)

slot

void ParameterWidget::setXComboBoxType	(	QString	pName,
		QString	pParam,
		QString	pQry,
		QVariant	pDefault = `QVariant()`
	)

slot

void ParameterWidget::showEvent ( QShowEvent * event )

protectedvirtual

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

Member Data Documentation

QToolButton * Ui_ParameterWidget::_addFilterRow

inherited

QPushButton * Ui_ParameterWidget::_filterButton

inherited

QFrame * Ui_ParameterWidget::_filterGroup

inherited

XComboBox * Ui_ParameterWidget::_filterList

inherited

QLabel * Ui_ParameterWidget::_filterListLit

inherited

QGridLayout * Ui_ParameterWidget::_filtersLayout

inherited

QHBoxLayout * Ui_ParameterWidget::_footerLayout

inherited

QSpacerItem * Ui_ParameterWidget::_footerSpacer

inherited

QHBoxLayout * Ui_ParameterWidget::_headerLayout

inherited

QSpacerItem * Ui_ParameterWidget::_headerSpacer

inherited

QPushButton * Ui_ParameterWidget::_manageButton

inherited

QPushButton * Ui_ParameterWidget::_saveButton

inherited

QGridLayout * Ui_ParameterWidget::gridLayout

inherited

QGridLayout * Ui_ParameterWidget::gridLayout_2

inherited

QVBoxLayout * Ui_ParameterWidget::verticalLayout

inherited

QSpacerItem * Ui_ParameterWidget::verticalSpacer

inherited

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

parameterwidget.h
parameterwidget.cpp

Public Types

Properties

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Slots

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation