FileDialogBuilder Class Reference

A builder object for constructing file dialogs, such as "Open" and "Save As" dialogs. More...

#include <FileDialogBuilder.h++>

Inheritance diagram for FileDialogBuilder:

Public Types
enum	Type { Open, Save, Directory }
	File dialog types. More...

Public Member Functions
	FileDialogBuilder (QWidget *parent, Type type, const QString &message)
	Constructor. More...
virtual	~FileDialogBuilder ()
	Destructor. More...
FileDialogBuilder &	setFeature (const QString &feature)
	Specifies the feature name for the dialog. More...
FileDialogBuilder &	setStartingDir (const QString &dir)
	Specifies the starting directory for the dialog. More...
FileDialogBuilder &	setNameFilter (const QString &filter)
	Specifies a filename filter for the dialog. More...
FileDialogBuilder &	setNameFilters (const QStringList &filters)
	Specifies a list of filename filters for the dialog. More...
FileDialogBuilder &	setOption (QFileDialog::Option option, bool on)
	Specifies options for the dialog. More...
FileDialogBuilder &	setSlot (QObject *target, const char *slot)
	Specifies a slot to be invoked when the dialog is accepted. More...
FileDialogBuilder &	setSlot (const char *slot)
	Specifies a slot of the dialog's parent widget to be invoked when the dialog is accepted. More...
template<typename T >
FileDialogBuilder &	addSlotArg (const T &arg)
	Adds an argument to be passed to the slot when the dialog is accepted. More...
void	show ()
	Constructs and displays the dialog. More...

Detailed Description

A builder object for constructing file dialogs, such as "Open" and "Save As" dialogs.

Author

Mark Lindner

Member Enumeration Documentation

Type

enum Type

File dialog types.

Enumerator
Open	Open file dialog.
Save	Save file dialog.
Directory	Select directory dialog.

Constructor & Destructor Documentation

FileDialogBuilder()

FileDialogBuilder	(	QWidget *	parent,
		Type	type,
		const QString &	message
	)

Constructor.

Begins the construction of an input dialog.

Parameters

parent	The parent widget for the dialog.
type	The type of dialog to be constructed.
message	The message text to be displayed in the dialog.

~FileDialogBuilder()

virtual ~FileDialogBuilder ( )

virtual

Destructor.

Member Function Documentation

addSlotArg()

FileDialogBuilder& addSlotArg ( const T &  arg )

inline

Adds an argument to be passed to the slot when the dialog is accepted.

This is useful for passing application state through the dialog.

Template Parameters

T	The type of the slot argument. This must be a type that can be converted to/from a QVariant.

Parameters

arg	The slot argument. A copy of the argument is made and stored within the dialog.

setFeature()

FileDialogBuilder& setFeature

(

const QString &

feature

)

Specifies the feature name for the dialog.

setNameFilter()

FileDialogBuilder& setNameFilter

(

const QString &

filter

)

Specifies a filename filter for the dialog.

setNameFilters()

FileDialogBuilder& setNameFilters

(

const QStringList &

filters

)

Specifies a list of filename filters for the dialog.

setOption()

FileDialogBuilder& setOption	(	QFileDialog::Option	option,
		bool	on
	)

Specifies options for the dialog.

See QFileDialog::setOption().

setSlot() [1/2]

FileDialogBuilder& setSlot	(	QObject *	target,
		const char *	slot
	)

Specifies a slot to be invoked when the dialog is accepted.

Parameters

target	The target object to invoke the slot on.
slot	The slot to invoke.

setSlot() [2/2]

FileDialogBuilder& setSlot ( const char *  slot )

inline

Specifies a slot of the dialog's parent widget to be invoked when the dialog is accepted.

Parameters

slot	The slot to invoke.

setStartingDir()

FileDialogBuilder& setStartingDir

(

const QString &

dir

)

Specifies the starting directory for the dialog.

show()

void show ( )

inherited

Constructs and displays the dialog.

---

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

• FileDialogBuilder.h++