Class: QgsFileWidget

class qgis.gui.QgsFileWidget

Bases: PyQt5.QtWidgets.QWidget

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

QgsFileWidget(parent: QWidget = None) QgsFileWidget creates a widget for selecting a file or a folder.

Methods

actionEvent

changeEvent

childEvent

closeEvent

confirmOverwrite

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

connectNotify

contextMenuEvent

create

customEvent

defaultRoot

Returns the default root path.

destroy

dialogTitle

Returns the open file dialog title.

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

filePath

Returns the current file path(s).

fileWidgetButtonVisible

Returns True if the tool button is shown.

filter

returns the filters used for QDialog.getOpenFileName

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

fullUrl

Returns True if the links shown use the full path.

hideEvent

initPainter

inputMethodEvent

isMultiFiles

Returns true if path is a multifiles

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

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.

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

options

Returns the additional options used for QFileDialog.

paintEvent

receivers

relativePath

Returns a filePath with relative path options applied (or not) !

relativeStorage

Returns if the relative path is with respect to the project path or the default path.

resizeEvent

selectedFilter

Returns the selected filter from the last opened file dialog.

sender

senderSignalIndex

setConfirmOverwrite

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

setDefaultRoot

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

setDialogTitle

Sets the title to use for the open file dialog.

setFilePath

Sets the current file path.

setFilePaths

Update filePath according to filePaths list

setFileWidgetButtonVisible

Sets whether the tool button is visible.

setFilter

setFilter sets the filter used by the model to filters.

setFullUrl

Sets whether links shown use the full path.

setOptions

Set additional options used for QFileDialog.

setReadOnly

Sets whether the widget should be read only.

setRelativeStorage

Sets whether the relative path is with respect to the project path or the default path.

setSelectedFileNames

Called whenever user select fileNames from dialog

setSelectedFilter

Sets the selected filter when the file dialog opens.

setStorageMode

Sets the widget's storage mode (i.e.

setUseLink

Sets whether the file path will be shown as a link.

sharedPainter

showEvent

splitFilePaths

Split the the quoted and space separated path and returns a list of strings.

storageMode

Returns the widget's storage mode (i.e.

tabletEvent

timerEvent

toUrl

returns a HTML code with a link to the given file path

updateLayout

Update buttons visibility

updateMicroFocus

useLink

Returns True if the file path will be shown as a link.

wheelEvent

Signals

fileChanged

Emitted whenever the current file or directory path is changed.

Attributes

Absolute

GetDirectory

GetFile

GetMultipleFiles

RelativeDefaultPath

RelativeProject

SaveFile

Absolute = 0
GetDirectory = 1
GetFile = 0
GetMultipleFiles = 2
RelativeDefaultPath = 2
RelativeProject = 1
class RelativeStorage

Bases: int

baseClass

alias of qgis._gui.QgsFileWidget

SaveFile = 3
class StorageMode

Bases: int

baseClass

alias of qgis._gui.QgsFileWidget

actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
confirmOverwrite(self) bool

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

Return type

bool

connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
defaultRoot(self) str

Returns the default root path.

See also

setDefaultRoot()

Return type

str

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
dialogTitle(self) str

Returns the open file dialog title.

See also

setDialogTitle()

Return type

str

disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) bool
fileChanged

Emitted whenever the current file or directory path is changed. [signal]

Parameters

path (str) –

filePath(self) str

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

setFilePath()

See also

splitFilePaths()

Return type

str

fileWidgetButtonVisible(self) bool

Returns True if the tool button is shown.

Return type

bool

filter(self) str

returns the filters used for QDialog.getOpenFileName

Return type

str

focusInEvent(self, QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, bool) bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) bool
fullUrl(self) bool

Returns True if the links shown use the full path.

See also

setFullUrl()

Return type

bool

hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isMultiFiles(path: str) bool

Returns true if path is a multifiles

Parameters

path (str) –

Return type

bool

isSignalConnected(self, QMetaMethod) bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
lineEdit(self) QgsFilterLineEdit

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.

New in version 3.0.

Return type

QgsFilterLineEdit

metric(self, QPaintDevice.PaintDeviceMetric) int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int]
options(self) QFileDialog.Options

Returns the additional options used for QFileDialog.

See also

setOptions()

New in version 3.14.

Return type

QFileDialog.Options

paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) int
relativePath(self, filePath: str, removeRelative: bool) str

Returns a filePath with relative path options applied (or not) !

Parameters
  • filePath (str) –

  • removeRelative (bool) –

Return type

str

relativeStorage(self) QgsFileWidget.RelativeStorage

Returns if the relative path is with respect to the project path or the default path.

Return type

QgsFileWidget.RelativeStorage

resizeEvent(self, QResizeEvent)
selectedFilter(self) str

Returns the selected filter from the last opened file dialog.

Return type

str

sender(self) QObject
senderSignalIndex(self) int
setConfirmOverwrite(self, confirmOverwrite: bool)

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

By default, a confirmation will appear.

Parameters

confirmOverwrite (bool) – If set to True, an overwrite confirmation will be shown

setDefaultRoot(self, defaultRoot: str)

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

See also

defaultRoot()

Parameters

defaultRoot (str) –

setDialogTitle(self, title: str)

Sets the title to use for the open file dialog.

Note

If not defined, the title is “Select a file” or “Select a directory” or “Select one or more files” depending on the configuration.

See also

dialogTitle()

Parameters

title (str) –

setFilePath(self, path: str)

Sets the current file path.

See also

filePath()

Parameters

path (str) –

setFilePaths(self, filePaths: Iterable[str])

Update filePath according to filePaths list

Parameters

filePaths (Iterable[str]) –

setFileWidgetButtonVisible(self, visible: bool)

Sets whether the tool button is visible.

Parameters

visible (bool) –

setFilter(self, filter: str)

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 (str) – Only files that match the given filter are shown, it may be an empty string. If you want multiple filters, separate them with ‘;;’,

setFullUrl(self, fullUrl: bool)

Sets whether links shown use the full path.

See also

fullUrl()

Parameters

fullUrl (bool) –

setOptions(self, options: Union[QFileDialog.Options, QFileDialog.Option])

Set additional options used for QFileDialog.

These options affect the look and feel of the QFileDialog shown when a user is interactively browsing for paths.

See also

options()

New in version 3.14.

Parameters

options (Union[QFileDialog.Options) –

setReadOnly(self, readOnly: bool)

Sets whether the widget should be read only.

Parameters

readOnly (bool) –

setRelativeStorage(self, relativeStorage: QgsFileWidget.RelativeStorage)

Sets whether the relative path is with respect to the project path or the default path.

Parameters

relativeStorage (QgsFileWidget.RelativeStorage) –

setSelectedFileNames(self, fileNames: Iterable[str])

Called whenever user select fileNames from dialog

Parameters

fileNames (Iterable[str]) –

setSelectedFilter(self, selectedFilter: str)

Sets the selected filter when the file dialog opens.

See also

selectedFilter()

Parameters

selectedFilter (str) –

setStorageMode(self, storageMode: QgsFileWidget.StorageMode)

Sets the widget’s storage mode (i.e. file or directory).

See also

storageMode()

Parameters

storageMode (QgsFileWidget.StorageMode) –

Sets whether the file path will be shown as a link.

See also

useLink()

Parameters

useLink (bool) –

sharedPainter(self) QPainter
showEvent(self, QShowEvent)
splitFilePaths(path: str) List[str]

Split the the quoted and space separated path and returns a list of strings.

See also

filePath()

Parameters

path (str) –

Return type

List[str]

storageMode(self) QgsFileWidget.StorageMode

Returns the widget’s storage mode (i.e. file or directory).

See also

setStorageMode()

Return type

QgsFileWidget.StorageMode

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
toUrl(self, path: str) str

returns a HTML code with a link to the given file path

Parameters

path (str) –

Return type

str

updateLayout(self)

Update buttons visibility

updateMicroFocus(self)

Returns True if the file path will be shown as a link.

See also

setUseLink()

Return type

bool

wheelEvent(self, QWheelEvent)