Skip to content

attachment

Full documentation pages are generated for docstring reference only and may contain symbols imported from other modules. Imported symbols are not distinguished from locally defined symbols and will appear in any module that they are imported into. For better information on where symbols should be imported from, review the sourcecode on the github.

FoSpy.ui.app.editors.attachment

BasePropEditor

Bases: BaseEditorWidget

Source code in FoSpy/ui/app/editors/_base.py 
139
140
141
142
143
144
145
class BasePropEditor(BaseEditorWidget):
    def __init__(self, block_widget, line_edit, editor_widget, on_apply, prop_name):
        self.on_apply = on_apply
        self.line_edit = line_edit
        self.prop_name = prop_name

        super().__init__(block_widget, editor_widget)

line_edit instance-attribute 

line_edit = line_edit

on_apply instance-attribute 

on_apply = on_apply

prop_name instance-attribute 

prop_name = prop_name

__init__ 

__init__(
    block_widget,
    line_edit,
    editor_widget,
    on_apply,
    prop_name,
)
Source code in FoSpy/ui/app/editors/_base.py 
140
141
142
143
144
145
def __init__(self, block_widget, line_edit, editor_widget, on_apply, prop_name):
    self.on_apply = on_apply
    self.line_edit = line_edit
    self.prop_name = prop_name

    super().__init__(block_widget, editor_widget)

FilePathEditor

Bases: BasePropEditor

Source code in FoSpy/ui/app/editors/attachment.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
class FilePathEditor(BasePropEditor):
    def __init__(self, block_widget, line_edit, on_apply=None, prop_name="file_name"):
        panel = FilePathPanel(block_widget)

        # BasePropEditor signature:
        # BasePropEditor(block_widget, line_edit, editor_widget, on_apply)
        super().__init__(block_widget, line_edit, panel, on_apply, prop_name)

    # ------------------------------------------------------------
    # Stub apply method — you fill in the real logic later
    # ------------------------------------------------------------

    @BasePropEditor.hard_refresh
    def apply(self):
        """
        Pull the selected path from the panel, convert to Path,
        process it, then eventually set attributes on self.blk_widget.blk.
        """

        path_obj = self.editor.get_selected_path()

        blk = self.blk_widget.blk
        blk.change_path(path_obj)

        win = self.blk_widget.win
        win._flag_edited(blk)

        # parent = blk._parent_block if hasattr(blk, "_parent_block") else None

        # # Refresh tree
        # win = self.blk_widget.win
        # win.refresh_tree(blk._parent_block if hasattr(blk, "_parent_block") else None)
        # win.go_to_block(parent)
        # win.go_to_block(blk)

        # # This editor is desynced. Find new editor
        # tree_item = win.tree_items[blk]
        # blk_widget = tree_item.data(WIDGET_DATA_ROLE)["widget"]

        # if blk_widget is None:
        #     listblk_item = win.tree_items[parent]
        #     listblk_widget = listblk_item.data(WIDGET_DATA_ROLE)["widget"]
        #     blk_widget = listblk_widget.blk_widgets[blk]

        # blk_widget.activate_prop_editor("file_name")

        # # Call BaseEditorWidget.apply() to run on_apply + hint + refresh
        # # super().apply()

    def is_changed(self):
        return self.editor.get_selected_path() != self.line_edit.text()

__init__ 

__init__(
    block_widget,
    line_edit,
    on_apply=None,
    prop_name="file_name",
)
Source code in FoSpy/ui/app/editors/attachment.py 
80
81
82
83
84
85
def __init__(self, block_widget, line_edit, on_apply=None, prop_name="file_name"):
    panel = FilePathPanel(block_widget)

    # BasePropEditor signature:
    # BasePropEditor(block_widget, line_edit, editor_widget, on_apply)
    super().__init__(block_widget, line_edit, panel, on_apply, prop_name)

apply 

apply()

Pull the selected path from the panel, convert to Path, process it, then eventually set attributes on self.blk_widget.blk.

Source code in FoSpy/ui/app/editors/attachment.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
@BasePropEditor.hard_refresh
def apply(self):
    """
    Pull the selected path from the panel, convert to Path,
    process it, then eventually set attributes on self.blk_widget.blk.
    """

    path_obj = self.editor.get_selected_path()

    blk = self.blk_widget.blk
    blk.change_path(path_obj)

    win = self.blk_widget.win
    win._flag_edited(blk)

is_changed 

is_changed()
Source code in FoSpy/ui/app/editors/attachment.py 
128
129
def is_changed(self):
    return self.editor.get_selected_path() != self.line_edit.text()

FilePathPanel

Bases: QWidget

Source code in FoSpy/ui/app/editors/attachment.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
class FilePathPanel(QWidget):
    def __init__(self, block_widget):
        super().__init__()

        self.blk_widget = block_widget
        self.selected_path = None

        layout = QVBoxLayout(self)
        layout.setContentsMargins(0, 0, 0, 0)
        layout.setSpacing(10)

        # --- Row: label + non-editable path display + choose button ---
        row = QHBoxLayout()
        row.setContentsMargins(0, 0, 0, 0)

        row.addWidget(QLabel("File Path:"), stretch=0)

        self.path_display = QLineEdit()
        self.path_display.setReadOnly(True)
        self.path_display.setFocusPolicy(Qt.NoFocus)
        row.addWidget(self.path_display, stretch=1)

        self.choose_btn = QPushButton("Choose…")
        self.choose_btn.clicked.connect(self.choose_file)
        row.addWidget(self.choose_btn, stretch=0)

        layout.addLayout(row)

        self.refresh()

    # ------------------------------------------------------------
    # Public API for the editor
    # ------------------------------------------------------------

    def refresh(self):
        """Refresh display from the block."""
        if self.blk_widget.blk.find_fileblock()._sourceFile is not None:
            current = self.blk_widget.blk._get_filepath()
            self.selected_path = current
            self.choose_btn.setEnabled(True)
            self.path_display.setEnabled(True)
        else:
            current = "<Path cannot be set until the parent FoS file is saved>"
            self.choose_btn.setEnabled(False)
            self.path_display.setEnabled(False)
        self.path_display.setText(str(current))

    def get_selected_path(self) -> Path:
        """Return the selected path as a Path object."""
        return Path(self.selected_path) if self.selected_path else None

    # ------------------------------------------------------------
    # Internal behavior
    # ------------------------------------------------------------

    def choose_file(self):
        """Open a file dialog and update the display."""
        path, _ = QFileDialog.getOpenFileName(self, "Select File")
        if path:
            self.selected_path = path
            self.path_display.setText(path)

blk_widget instance-attribute 

blk_widget = block_widget

choose_btn instance-attribute 

choose_btn = QPushButton('Choose…')

path_display instance-attribute 

path_display = QLineEdit()

selected_path instance-attribute 

selected_path = None

__init__ 

__init__(block_widget)
Source code in FoSpy/ui/app/editors/attachment.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def __init__(self, block_widget):
    super().__init__()

    self.blk_widget = block_widget
    self.selected_path = None

    layout = QVBoxLayout(self)
    layout.setContentsMargins(0, 0, 0, 0)
    layout.setSpacing(10)

    # --- Row: label + non-editable path display + choose button ---
    row = QHBoxLayout()
    row.setContentsMargins(0, 0, 0, 0)

    row.addWidget(QLabel("File Path:"), stretch=0)

    self.path_display = QLineEdit()
    self.path_display.setReadOnly(True)
    self.path_display.setFocusPolicy(Qt.NoFocus)
    row.addWidget(self.path_display, stretch=1)

    self.choose_btn = QPushButton("Choose…")
    self.choose_btn.clicked.connect(self.choose_file)
    row.addWidget(self.choose_btn, stretch=0)

    layout.addLayout(row)

    self.refresh()

choose_file 

choose_file()

Open a file dialog and update the display.

Source code in FoSpy/ui/app/editors/attachment.py 
71
72
73
74
75
76
def choose_file(self):
    """Open a file dialog and update the display."""
    path, _ = QFileDialog.getOpenFileName(self, "Select File")
    if path:
        self.selected_path = path
        self.path_display.setText(path)

get_selected_path 

get_selected_path()

Return the selected path as a Path object.

Source code in FoSpy/ui/app/editors/attachment.py 
63
64
65
def get_selected_path(self) -> Path:
    """Return the selected path as a Path object."""
    return Path(self.selected_path) if self.selected_path else None

refresh 

refresh()

Refresh display from the block.

Source code in FoSpy/ui/app/editors/attachment.py 
50
51
52
53
54
55
56
57
58
59
60
61
def refresh(self):
    """Refresh display from the block."""
    if self.blk_widget.blk.find_fileblock()._sourceFile is not None:
        current = self.blk_widget.blk._get_filepath()
        self.selected_path = current
        self.choose_btn.setEnabled(True)
        self.path_display.setEnabled(True)
    else:
        current = "<Path cannot be set until the parent FoS file is saved>"
        self.choose_btn.setEnabled(False)
        self.path_display.setEnabled(False)
    self.path_display.setText(str(current))