The QgsFileWidget class creates a widget for selecting a file or a folder. More...

#include <qgsfilewidget.h>

Inheritance diagram for QgsFileWidget:

Public Types
enum	RelativeStorage { Absolute, RelativeProject, RelativeDefaultPath }
	The RelativeStorage enum determines if path is absolute, relative to the current project path or relative to a defined default path. More...

enum	StorageMode { GetFile, GetDirectory, GetMultipleFiles, SaveFile }
	The StorageMode enum determines if the file picker should pick files or directories. More...

Signals
void	blockEvents (bool)
	Emitted before and after showing the file dialog. More...

void	fileChanged (const QString &)
	emitted as soon as the current file or directory is changed More...

Public Member Functions
	QgsFileWidget (QWidget *parent=nullptr)
	QgsFileWidget creates a widget for selecting a file or a folder. More...

bool	confirmOverwrite () const
	Returns whether a confirmation will be shown when overwriting an existing file. More...

QString	defaultRoot () const
	returns the default root path More...

QString	dialogTitle () const
	returns the open file dialog title More...

QString	filePath ()
	Returns the current file path(s) when multiple files are selected, they are quoted and separated by a single space (for example: '"/path/foo" "path/bar"') More...

bool	fileWidgetButtonVisible () const
	determines if the tool button is shown More...

QString	filter () const
	returns the filters used for QDialog::getOpenFileName More...

bool	fullUrl () const
	returns if the links shows the full path or not More...

QgsFilterLineEdit *	lineEdit ()
	Returns a pointer to the widget's line edit, which can be used to customize the appearance and behavior of the line edit portion of the widget. More...

QgsFileWidget::RelativeStorage	relativeStorage () const
	returns if the relative path is with respect to the project path or the default path More...

QString	selectedFilter () const
	Returns the selected filter from the last opened file dialog. More...

void	setConfirmOverwrite (bool confirmOverwrite)
	Sets whether a confirmation to overwrite an existing file will appear. More...

void	setDefaultRoot (const QString &defaultRoot)
	determines the default root path used as the first shown location when picking a file and used if the RelativeStorage is RelativeDefaultPath More...

void	setDialogTitle (const QString &title)
	setDialogTitle defines the open file dialog title More...

void	setFilePath (QString path)
	Sets the file path. More...

void	setFileWidgetButtonVisible (bool visible)
	determines if the tool button is shown More...

void	setFilter (const QString &filter)
	setFilter sets the filter used by the model to filters. More...

void	setFullUrl (bool fullUrl)
	determines if the links shows the full path or not More...

void	setReadOnly (bool readOnly)
	defines if the widget is readonly More...

void	setRelativeStorage (QgsFileWidget::RelativeStorage relativeStorage)
	determines if the relative path is with respect to the project path or the default path More...

void	setSelectedFilter (const QString &selectedFilter)
	Sets the selected filter when the file dialog opens. More...

void	setStorageMode (QgsFileWidget::StorageMode storageMode)
	determines the storage mode (i.e. file or directory) More...

void	setUseLink (bool useLink)
	determines if the file path will be shown as a link More...

QgsFileWidget::StorageMode	storageMode () const
	returns the storage mode (i.e. file or directory) More...

bool	useLink () const
	determines if the file path will be shown as a link More...

Static Public Member Functions
static QStringList	splitFilePaths (const QString &path)
	Split the the quoted and space separated path and returns a QString list. More...

Properties
QString	defaultRoot

QString	dialogTitle

bool	fileWidgetButtonVisible

QString	filter

bool	fullUrl

RelativeStorage	relativeStorage

StorageMode	storageMode

bool	useLink

Friends
class	TestQgsFileWidget

Detailed Description

The QgsFileWidget class creates a widget for selecting a file or a folder.

Definition at line 35 of file qgsfilewidget.h.

Member Enumeration Documentation

enum QgsFileWidget::RelativeStorage

The RelativeStorage enum determines if path is absolute, relative to the current project path or relative to a defined default path.

Enumerator
Absolute
RelativeProject
RelativeDefaultPath

Definition at line 74 of file qgsfilewidget.h.

enum QgsFileWidget::StorageMode

The StorageMode enum determines if the file picker should pick files or directories.

Enumerator
GetFile
GetDirectory	Select a single file.
GetMultipleFiles	Select a directory.
SaveFile	Select multiple files.

Definition at line 63 of file qgsfilewidget.h.

Constructor & Destructor Documentation

QgsFileWidget::QgsFileWidget ( QWidget * parent = nullptr )

explicit

QgsFileWidget creates a widget for selecting a file or a folder.

Definition at line 34 of file qgsfilewidget.cpp.

Member Function Documentation

void QgsFileWidget::blockEvents ( bool )

signal

Emitted before and after showing the file dialog.

Note: not available in Python bindings

Since: QGIS 3.10

bool QgsFileWidget::confirmOverwrite ( ) const

inline

Returns whether a confirmation will be shown when overwriting an existing file.

Definition at line 144 of file qgsfilewidget.h.

QString QgsFileWidget::defaultRoot ( ) const

returns the default root path

QString QgsFileWidget::dialogTitle ( ) const

returns the open file dialog title

void QgsFileWidget::fileChanged ( const QString & )

signal

emitted as soon as the current file or directory is changed

QString QgsFileWidget::filePath ( )

Returns the current file path(s) when multiple files are selected, they are quoted and separated by a single space (for example: '"/path/foo" "path/bar"')

See also: splitFilePaths()

Definition at line 69 of file qgsfilewidget.cpp.

bool QgsFileWidget::fileWidgetButtonVisible ( ) const

determines if the tool button is shown

QString QgsFileWidget::filter ( ) const

returns the filters used for QDialog::getOpenFileName

bool QgsFileWidget::fullUrl ( ) const

returns if the links shows the full path or not

QgsFilterLineEdit * QgsFileWidget::lineEdit ( )

Returns a pointer to the widget's line edit, which can be used to customize the appearance and behavior of the line edit portion of the widget.

Since: QGIS 3.0

Definition at line 216 of file qgsfilewidget.cpp.

QgsFileWidget::RelativeStorage QgsFileWidget::relativeStorage ( ) const

returns if the relative path is with respect to the project path or the default path

QString QgsFileWidget::selectedFilter ( ) const

inline

Returns the selected filter from the last opened file dialog.

Definition at line 132 of file qgsfilewidget.h.

void QgsFileWidget::setConfirmOverwrite ( bool confirmOverwrite )

inline

Sets whether a confirmation to overwrite an existing file will appear.

By default, a confirmation will appear.

Parameters

confirmOverwrite If set to true, an overwrite confirmation will be shown

Definition at line 139 of file qgsfilewidget.h.

void QgsFileWidget::setDefaultRoot ( const QString & defaultRoot )

determines the default root path used as the first shown location when picking a file and used if the RelativeStorage is RelativeDefaultPath

Definition at line 190 of file qgsfilewidget.cpp.

void QgsFileWidget::setDialogTitle ( const QString & title )

setDialogTitle defines the open file dialog title

Note: if not defined, the title is "Select a file" or "Select a directory" or "Select one or more files" depending on the configuration.

Definition at line 110 of file qgsfilewidget.cpp.

void QgsFileWidget::setFilePath ( QString path )

Sets the file path.

Definition at line 87 of file qgsfilewidget.cpp.

void QgsFileWidget::setFileWidgetButtonVisible ( bool visible )

determines if the tool button is shown

Definition at line 131 of file qgsfilewidget.cpp.

void QgsFileWidget::setFilter ( const QString & filter )

setFilter sets the filter used by the model to filters.

The filter is used to specify the kind of files that should be shown.

Parameters

filter Only files that match the given filter are shown, it may be an empty string. If you want multiple filters, separate them with ';;',

Definition at line 120 of file qgsfilewidget.cpp.

void QgsFileWidget::setFullUrl ( bool fullUrl )

determines if the links shows the full path or not

Definition at line 180 of file qgsfilewidget.cpp.

void QgsFileWidget::setReadOnly ( bool readOnly )

defines if the widget is readonly

Definition at line 99 of file qgsfilewidget.cpp.

void QgsFileWidget::setRelativeStorage ( QgsFileWidget::RelativeStorage relativeStorage )

determines if the relative path is with respect to the project path or the default path

Definition at line 211 of file qgsfilewidget.cpp.

void QgsFileWidget::setSelectedFilter ( const QString & selectedFilter )

inline

Sets the selected filter when the file dialog opens.

Definition at line 127 of file qgsfilewidget.h.

void QgsFileWidget::setStorageMode ( QgsFileWidget::StorageMode storageMode )

determines the storage mode (i.e. file or directory)

Definition at line 200 of file qgsfilewidget.cpp.

void QgsFileWidget::setUseLink ( bool useLink )

determines if the file path will be shown as a link

Definition at line 158 of file qgsfilewidget.cpp.

QStringList QgsFileWidget::splitFilePaths ( const QString & path )

static

Split the the quoted and space separated path and returns a QString list.

See also: filePath

Definition at line 74 of file qgsfilewidget.cpp.

QgsFileWidget::StorageMode QgsFileWidget::storageMode ( ) const

returns the storage mode (i.e. file or directory)

bool QgsFileWidget::useLink ( ) const

determines if the file path will be shown as a link

Friends And Related Function Documentation

friend class TestQgsFileWidget

friend

Definition at line 223 of file qgsfilewidget.h.

Property Documentation

QString QgsFileWidget::defaultRoot

readwrite

Definition at line 54 of file qgsfilewidget.h.

QString QgsFileWidget::dialogTitle

readwrite

Definition at line 52 of file qgsfilewidget.h.

bool QgsFileWidget::fileWidgetButtonVisible

readwrite

Definition at line 49 of file qgsfilewidget.h.

QString QgsFileWidget::filter

readwrite

Definition at line 53 of file qgsfilewidget.h.

bool QgsFileWidget::fullUrl

readwrite

Definition at line 51 of file qgsfilewidget.h.

QgsFileWidget::RelativeStorage QgsFileWidget::relativeStorage

readwrite

Definition at line 56 of file qgsfilewidget.h.

QgsFileWidget::StorageMode QgsFileWidget::storageMode

readwrite

Definition at line 55 of file qgsfilewidget.h.

bool QgsFileWidget::useLink

readwrite

Definition at line 50 of file qgsfilewidget.h.

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

/build/qgis-3.4.15+24xenial/src/gui/qgsfilewidget.h
/build/qgis-3.4.15+24xenial/src/gui/qgsfilewidget.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Property Documentation