8.6.5.1.4. pymodaq_gui.parameter.pymodaq_ptypes.filedir module

class pymodaq_gui.parameter.pymodaq_ptypes.filedir.FileDirParameter(**opts)

Bases: Parameter

Editable string; displayed as large text box in the tree. .. seealso:: file_browserParameterItem

Methods

itemClass

itemClass

alias of FileDirParameterItem

staticMetaObject = PySide6.QtCore.QMetaObject("FileDirParameter" inherits "Parameter": )

class pymodaq_gui.parameter.pymodaq_ptypes.filedir.FileDirParameterItem(param, depth)

Bases: WidgetParameterItem

Methods

makeWidget()

Make an initialized file_browser object with parameter options dictionnary ('readonly' key)0

makeWidget()

Make an initialized file_browser object with parameter options dictionnary (‘readonly’ key)0

Returns:

w – The initialized file browser.

Return type:

filebrowser

See also

file_browser

class pymodaq_gui.parameter.pymodaq_ptypes.filedir.FileDirWidget(init_path='D:/Data', file_type=False, filter='')

Bases: QWidget

Attributes	Type
value_changed	instance of pyqt Signal
path	string

See also

browse_path

Methods

browse_path()	Browse the path attribute if exist.
get_value()	Get the value of the base_path_edit attribute.
initUI()	Init the User Interface.
setReadOnly(readonly)	Lock only the text field; the browse button stays clickable regardless.
set_path(path_file)	Set the base path attribute with the given path_file.

value_changed

browse_path()

Browse the path attribute if exist.

See also

set_path

get_value()

Get the value of the base_path_edit attribute.

Returns:

the path name

Return type:

string

initUI()

Init the User Interface.

setReadOnly(readonly)

Lock only the text field; the browse button stays clickable regardless.

Without this, pyqtgraph’s generic WidgetParameterItem.optsChanged() falls back to disabling the whole widget on ‘readonly’ (no setReadOnly means no fine-grained control), which also greys out the browse button – not just the text edit.

set_path(path_file)

Set the base path attribute with the given path_file.

Parameters	Type	Description
path_file	string	the pathname of the file

staticMetaObject = PySide6.QtCore.QMetaObject("FileDirWidget" inherits "QWidget": Methods:   #33 type=Signal, signature=value_changed(QString), parameters=QString )

value_changed