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>

List of all members.

Public Types
enum	FileMoveOption { Nothing, Suffix, ChangeDir, Delete }
Public Member Functions
	FileMoveSelector (QWidget *parent=0, Qt::WFlags fl=0)
	~FileMoveSelector ()
Q_INVOKABLE QString	code () const
	Return the text code value of the currently-selected return option.
Q_INVOKABLE QString	codeForOption (FileMoveOption poption) const
	Translate a FileMoveOption enumerated value to a text code value.
Q_INVOKABLE QString	destdir () const
	The destination directory for files which are to be moved.
Q_INVOKABLE FileMoveOption	option () const
	The enumerated FileMoveOption value of the current selection.
Q_INVOKABLE QString	suffix () const
	The suffix that should be appended to files that have been processed.
Public Slots
bool	setCode (QString pcode)
	Programatically set the selection using a text code value.
bool	setDestdir (QString pdir)
	Programatically set the destination directory.
bool	setOption (FileMoveOption poption)
	Programatically set the selection using one of the FileMoveOption enumerated values.
bool	setSuffix (QString psuffix)
	Programatically set the suffix to append.
Protected Slots
virtual void	languageChange ()

---

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

enum FileMoveSelector::FileMoveOption

Enumerator:

Nothing
Suffix
ChangeDir
Delete

---

Constructor & Destructor Documentation

FileMoveSelector::FileMoveSelector	(	QWidget *	parent = 0,
		Qt::WFlags	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

(

)

[protected, virtual, slot]

Reimplemented from QWidget.

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.

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

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.

---

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

• filemoveselector.h
• filemoveselector.cpp