List of all members | Classes | Public Types | Properties | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Slots | Protected Member Functions
ParameterWidget Class Reference

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

#include <parameterwidget.h>

Inheritance diagram for ParameterWidget:
QWidget Ui::ParameterWidget QObject QPaintDevice Ui_ParameterWidget Ui_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
 
 toolTipDuration
 
 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 (const 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
 
QPalette::ColorRole backgroundRole () const
 
QBackingStorebackingStore () const
 
QSize baseSize () const
 
bool blockSignals (bool block)
 
QWidgetchildAt (int x, int y) const
 
QWidgetchildAt (const QPoint &p) const
 
const QObjectList & children () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
int colorCount () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) 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)
 
int devicePixelRatio () const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
WId effectiveWinId () const
 
void ensurePolished () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
Q_INVOKABLE QString filter ()
 
findChild (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const
 
Qt::FocusPolicy focusPolicy () const
 
QWidgetfocusProxy () const
 
QWidgetfocusWidget () const
 
const QFontfont () const
 
QFontInfo fontInfo () const
 
QFontMetrics fontMetrics () const
 
QPalette::ColorRole foregroundRole () const
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 
bool hasEditFocus () const
 
bool hasFocus () const
 
virtual bool hasHeightForWidth () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int w) const
 
int heightMM () const
 
void hide ()
 
bool inherits (const char *className) const
 
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 installEventFilter (QObject *filterObj)
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *ancestor) const
 
bool isEnabledToTLW () const
 
bool isFullScreen () const
 
bool isHidden () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isTopLevel () const
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *ancestor) const
 
bool isWidgetType () const
 
bool isWindow () const
 
bool isWindowModified () const
 
bool isWindowType () const
 
void killTimer (int id)
 
QLayoutlayout () const
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const
 
QPoint mapFromGlobal (const QPoint &pos) const
 
QPoint mapFromParent (const QPoint &pos) const
 
QPoint mapTo (const 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 QMetaObjectmetaObject () 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)
 
QWidgetnativeParentWidget () const
 
QWidgetnextInFocusChain () const
 
QRect normalGeometry () const
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const
 
bool paintingActive () const
 
const QPalettepalette () const
 
Q_INVOKABLE ParameterList parameters ()
 
Q_INVOKABLE int paramIndex (QString pName)
 
QObjectparent () const
 
QWidgetparentWidget () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () const
 
QVariant property (const char *name) const
 
void raise ()
 
QRect rect () const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void removeEventFilter (QObject *obj)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
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 setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
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 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 setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QRegion &region)
 
void setMask (const QBitmap &bitmap)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setObjectName (const QString &name)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setSizePolicy (QSizePolicy)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
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 (Qt::WindowFlags 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 (Qt::WindowStates windowState)
 
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, Qt::TimerType timerType)
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute attribute) const
 
QThreadthread () const
 
QString toolTip () const
 
int toolTipDuration () const
 
QWidgettopLevelWidget () const
 
bool underMouse () const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 
void update ()
 
void update (const QRegion &rgn)
 
void update (const QRect &rect)
 
void updateGeometry ()
 
bool updatesEnabled () const
 
QRegion visibleRegion () const
 
QString whatsThis () const
 
int width () const
 
int widthMM () const
 
QWidgetwindow () const
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 
QWindowwindowHandle () const
 
QIcon windowIcon () const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 
Qt::WindowStates windowState () const
 
QString windowTitle () const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const
 
WId winId () const
 
int x () const
 
int y () const
 

Static Public Member Functions

QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
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)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
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)
 

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
 
QGridLayoutgridLayout
 
QGridLayoutgridLayout_2
 
typedef RenderFlags
 
QVBoxLayoutverticalLayout
 
QSpacerItemverticalSpacer
 

Protected Slots

void resetMultiselect (QTableWidgetItem *item)
 

Protected Member Functions

virtual void actionEvent (QActionEvent *event)
 
virtual void changeEvent (QEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
virtual void connectNotify (const QMetaMethod &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 QMetaMethod &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)
 
QWidgetgetFilterWidget (const int index)
 
QString getParameterTypeKey (QString)
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *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 bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void paintEvent (QPaintEvent *event)
 
int receivers (const char *signal) const
 
virtual void resizeEvent (QResizeEvent *event)
 
QObjectsender () 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)
 

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

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
pParentThe parent of this widget
pNameThe 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
pNameThe user-visible name for this filter to distinguish it from other filters in the same set
pParamThe name to use for the parameter in the ParameterList
pTypeThe type of widget for the user to enter a criterion in
pDefaultThe default value to use for this parameter
pRequiredRequired parameters cannot be removed from the filter set
pExtraInfoA 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
pNameThe user-visible name for this filter to distinguish it from other filters in the same set
pParamThe name to use for the parameter in the ParameterList
pQuerySet the XComboBox to populate itself with this query
pDefaultThe default internal id to select for this XComboBox
pRequiredRequired 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
pNameThe user-visible name for this filter to distinguish it from other filters in the same set
pParamThe name to use for the parameter in the ParameterList
pTypeSet the XComboBox to use the corresponding XComboBox::XComboBoxTypes value
pDefaultThe default internal id to select for this XComboBox
pRequiredRequired 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]pParamsThe 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::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:

Generated on Fri Aug 11 2017 xTuple ERP Programmer Reference, Version 4.11.0 doxygen 1.8.10