iAFileParamDlg Class Reference

Provides a dialog for reading parameters, currently for a given file I/O type. More...

#include <iAFileParamDlg.h>

Inheritance diagram for iAFileParamDlg:

Public Member Functions
virtual	~iAFileParamDlg ()
virtual bool	askForParameters (QWidget *parent, iAAttributes const &parameters, QString const &ioName, QVariantMap &values, QString const &fileName, iADataSet const *dataSet=nullptr) const
	default implementation for asking file parameters The value contained in the values argument will be used as default values for the parameter, overwriting the default values provided in the parameters argument

Static Public Member Functions
static void	add (QString const &ioName, std::shared_ptr< iAFileParamDlg > dlg)
	register a dialog for a given I/O name:
static iAFileParamDlg *	get (QString const &ioName)
	factory method, creating a parameter dialog for the given file I/O name:
static bool	getParameters (QWidget *parent, iAFileIO const *io, iAFileIO::Operation op, QString const &fileName, QVariantMap &result, iADataSet const *dataSet=nullptr)
	Convenience function for retrieving parameters for loading/saving a file.
static void	setupDefaultFileParamDlgs ()
	set up a few custom file parameter dialogs

Detailed Description

Provides a dialog for reading parameters, currently for a given file I/O type.

Constructor & Destructor Documentation

~iAFileParamDlg()

iAFileParamDlg::~iAFileParamDlg ( )

virtual

Member Function Documentation

add()

void iAFileParamDlg::add ( QString const & ioName, std::shared_ptr< iAFileParamDlg > dlg )

static

register a dialog for a given I/O name:

askForParameters()

bool iAFileParamDlg::askForParameters ( QWidget * parent, iAAttributes const & parameters, QString const & ioName, QVariantMap & values, QString const & fileName, iADataSet const * dataSet = nullptr ) const

virtual

default implementation for asking file parameters The value contained in the values argument will be used as default values for the parameter, overwriting the default values provided in the parameters argument

Reimplemented in iAImageStackLoadParamDlg, iAImageStackSaveParamDlg, and iARawFileLoadParamDlg.

get()

iAFileParamDlg * iAFileParamDlg::get ( QString const & ioName )

static

factory method, creating a parameter dialog for the given file I/O name:

getParameters()

bool iAFileParamDlg::getParameters ( QWidget * parent, iAFileIO const * io, iAFileIO::Operation op, QString const & fileName, QVariantMap & result, iADataSet const * dataSet = nullptr )

static

Convenience function for retrieving parameters for loading/saving a file.

Note: in contrast to askForParameters, result is an out parameter only; the values in there will not be used as default

setupDefaultFileParamDlgs()

void iAFileParamDlg::setupDefaultFileParamDlgs ( )

static

set up a few custom file parameter dialogs

---

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

• libs/gui/iAFileParamDlg.h
• libs/gui/iAFileParamDlg.cpp