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

The FileMoveSelector provides a standardized user interface for selecting what the application should do with a file in the host file system after it has been processed. More...

#include <filemoveselector.h>

Inheritance diagram for FileMoveSelector:
QWidget Ui::FileMoveSelector QObject QPaintDevice Ui_FileMoveSelector Ui_FileMoveSelector

Public Types

enum  FileMoveOption { Nothing, Suffix, ChangeDir, Delete }
 

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

bool setCode (QString pcode)
 Programatically set the selection using a text code value. More...
 
bool setDestdir (QString pdir)
 Programatically set the destination directory. More...
 
bool setOption (FileMoveOption poption)
 Programatically set the selection using one of the FileMoveOption enumerated values. More...
 
bool setSuffix (QString psuffix)
 Programatically set the suffix to append. More...
 

Public Member Functions

 FileMoveSelector (QWidget *parent=0, Qt::WindowFlags fl=0)
 
 ~FileMoveSelector ()
 
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 ()
 
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 ()
 
Q_INVOKABLE QString code () const
 Return the text code value of the currently-selected return option. More...
 
Q_INVOKABLE QString codeForOption (FileMoveOption poption) const
 Translate a FileMoveOption enumerated value to a text code value. More...
 
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
 
Q_INVOKABLE QString destdir () const
 The destination directory for files which are to be moved. More...
 
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)
 
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)
 
Q_INVOKABLE FileMoveOption option () const
 The enumerated FileMoveOption value of the current selection. More...
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const
 
bool paintingActive () const
 
const QPalettepalette () const
 
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 *FileMoveSelector)
 
void retranslateUi (QWidget *FileMoveSelector)
 
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 (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
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 *FileMoveSelector)
 
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
 
Q_INVOKABLE QString suffix () const
 The suffix that should be appended to files that have been processed. More...
 
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 ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
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

QWidget_deletePage
 
QWidget_invalidPage
 
FileCluster_movedir
 
XLabel_movedirLit
 
QWidget_movePage
 
QWidget_nothingPage
 
XComboBox_status
 
QStackedWidget_statusStack
 
XLineEdit_suffix
 
XLabel_suffixLit
 
QWidget_suffixPage
 
QHBoxLayouthorizontalLayout
 
QHBoxLayouthorizontalLayout_2
 
QHBoxLayouthorizontalLayout_3
 
typedef RenderFlags
 

Protected Slots

virtual void languageChange ()
 

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)
 
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 ()
 
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
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
virtual void timerEvent (QTimerEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 

Detailed Description

The FileMoveSelector provides a standardized user interface for selecting what the application should do with a file in the host file system after it has been processed.

The FileMoveSelector encodes a simple user interface paradigm for how the application should handle files after they have been processed. The application window that has a FileMoveSelector must store the user's selection. The application code that processes the files should check this stored selection and have its own means of handling files in the selected manner.

See also
configureIE
ImportHelper

Member Enumeration Documentation

Enumerator
Nothing 
Suffix 
ChangeDir 
Delete 

Constructor & Destructor Documentation

FileMoveSelector::FileMoveSelector ( QWidget parent = 0,
Qt::WindowFlags  fl = 0 
)
FileMoveSelector::~FileMoveSelector ( )

Member Function Documentation

QString FileMoveSelector::code ( ) const

Return the text code value of the currently-selected return option.

See also
codeForOption(FileMoveOption) for possible return values
QString FileMoveSelector::codeForOption ( FileMoveOption  poption) const

Translate a FileMoveOption enumerated value to a text code value.

The text code values are not translatable. They are intended to be used for storing the user's selection in a database or configuration file, and for applications to read from the database or configuration file when deciding how to handle a file after it has been processed.

Returns
The text code value corresponding to the FileMoveOption enumerated value. Possible values are "None", "Rename", "Move", and "Delete", or QString::null if poption is invalid or not yet supported.
QString FileMoveSelector::destdir ( ) const

The destination directory for files which are to be moved.

This value reflects the current contents of the destination directory field. The destination directory may not be visible, depending on the currently selected option.

Returns
The text entered in the destination directory field of the FileMoveSelector. This value should not be used to determine how the user would like files to be handled. Use code() or option() for this purpose.
void FileMoveSelector::languageChange ( )
protectedvirtualslot
FileMoveSelector::FileMoveOption FileMoveSelector::option ( ) const

The enumerated FileMoveOption value of the current selection.

Returns
The currently selected option, or -1 if there is an error.
void Ui_FileMoveSelector::retranslateUi ( QWidget FileMoveSelector)
inlineinherited
void Ui_FileMoveSelector::retranslateUi ( QWidget FileMoveSelector)
inlineinherited
bool FileMoveSelector::setCode ( QString  pcode)
slot

Programatically set the selection using a text code value.

Returns
true if successful or false if the pcode does not exactly match a known value.
bool FileMoveSelector::setDestdir ( QString  pdir)
slot

Programatically set the destination directory.

This does not automatically set the selection to ChangeDir.

Returns
true
bool FileMoveSelector::setOption ( FileMoveOption  poption)
slot

Programatically set the selection using one of the FileMoveOption enumerated values.

Returns
true if successful or false if poption is not valid.
bool FileMoveSelector::setSuffix ( QString  psuffix)
slot

Programatically set the suffix to append.

This does not automatically set the selection to Suffix.

Returns
true
void Ui_FileMoveSelector::setupUi ( QWidget FileMoveSelector)
inlineinherited
QString FileMoveSelector::suffix ( ) const

The suffix that should be appended to files that have been processed.

This value reflects the current contents of the suffix field. This field may not be visible, depending on the currently selected option.

Returns
The text entered in the suffix field of the FileMoveSelector. This value should not be used to determine how the user would like files to be handled. Use code() or option() for this purpose.

Member Data Documentation

QWidget * Ui_FileMoveSelector::_deletePage
inherited
QWidget * Ui_FileMoveSelector::_invalidPage
inherited
FileCluster * Ui_FileMoveSelector::_movedir
inherited
XLabel * Ui_FileMoveSelector::_movedirLit
inherited
QWidget * Ui_FileMoveSelector::_movePage
inherited
QWidget * Ui_FileMoveSelector::_nothingPage
inherited
XComboBox * Ui_FileMoveSelector::_status
inherited
QStackedWidget * Ui_FileMoveSelector::_statusStack
inherited
XLineEdit * Ui_FileMoveSelector::_suffix
inherited
XLabel * Ui_FileMoveSelector::_suffixLit
inherited
QWidget * Ui_FileMoveSelector::_suffixPage
inherited
QHBoxLayout * Ui_FileMoveSelector::horizontalLayout
inherited
QHBoxLayout * Ui_FileMoveSelector::horizontalLayout_2
inherited
QHBoxLayout * Ui_FileMoveSelector::horizontalLayout_3
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