A widget used for selecting an existing folder.
Bases: QWidget
A widget used for selecting an existing folder.
Parameters:
Name | Type | Description | Default |
text | str | Text displayed on the button. | required |
Source code in src/careamics_napari/widgets/folder_widget.py
| class FolderWidget(QWidget):
"""A widget used for selecting an existing folder.
Parameters
----------
text : str
Text displayed on the button.
"""
def __init__(self: Self, text: str) -> None:
"""Initialize the widget.
Parameters
----------
text : str
Text displayed on the button.
"""
super().__init__()
self.setLayout(QHBoxLayout())
self.layout().setSpacing(0)
self.layout().setContentsMargins(0, 0, 0, 0)
# text field
self.text_field = QLineEdit("")
self.layout().addWidget(self.text_field)
# folder selection button
self.button = QPushButton(text)
self.layout().addWidget(self.button)
self.button.clicked.connect(self._open_dialog)
def _open_dialog(self: Self) -> None:
"""Open a dialog to select a folder."""
path = QFileDialog.getExistingDirectory(self, "Select Folder")
print(path)
# set text in the text field
self.text_field.setText(path)
def get_folder(self: Self) -> str:
"""Get the selected folder.
Returns
-------
str
The selected folder as read out from the text field.
"""
return self.text_field.text()
def get_text_widget(self: Self) -> QLineEdit:
"""Get the text widget.
Returns
-------
QLineEdit
The text widget.
"""
return self.text_field
|
Initialize the widget.
Parameters:
Name | Type | Description | Default |
text | str | Text displayed on the button. | required |
Source code in src/careamics_napari/widgets/folder_widget.py
| def __init__(self: Self, text: str) -> None:
"""Initialize the widget.
Parameters
----------
text : str
Text displayed on the button.
"""
super().__init__()
self.setLayout(QHBoxLayout())
self.layout().setSpacing(0)
self.layout().setContentsMargins(0, 0, 0, 0)
# text field
self.text_field = QLineEdit("")
self.layout().addWidget(self.text_field)
# folder selection button
self.button = QPushButton(text)
self.layout().addWidget(self.button)
self.button.clicked.connect(self._open_dialog)
|
Get the selected folder.
Returns:
Type | Description |
str | The selected folder as read out from the text field. |
Source code in src/careamics_napari/widgets/folder_widget.py
| def get_folder(self: Self) -> str:
"""Get the selected folder.
Returns
-------
str
The selected folder as read out from the text field.
"""
return self.text_field.text()
|
get_text_widget()
Get the text widget.
Returns:
Type | Description |
QLineEdit | |
Source code in src/careamics_napari/widgets/folder_widget.py
| def get_text_widget(self: Self) -> QLineEdit:
"""Get the text widget.
Returns
-------
QLineEdit
The text widget.
"""
return self.text_field
|