Skip to content

rename

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.rename

RESERVED module-attribute 

RESERVED = ['rename', 'metadata']

BaseEditorWidget

Bases: QWidget

Source code in FoSpy/ui/app/editors/_base.py 
  9
 10
 11
 12
 13
 14
 15
 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
 77
 78
 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
130
131
132
133
134
135
136
class BaseEditorWidget(QWidget):
    def __init__(self, block_widget, editor_widget):
        super().__init__()

        self.blk_widget = block_widget

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

        self.editor = editor_widget
        self.refresh_editor()
        self.base_layout.addWidget(self.editor, stretch=0)

        self.setLayout(self.base_layout)

        button_layout = QHBoxLayout()
        button_layout.addStretch()

        self.apply_btn = QPushButton("Apply")
        self.apply_btn.clicked.connect(self.apply)
        button_layout.addWidget(self.apply_btn)

        self.okay_btn = QPushButton("OK")
        self.okay_btn.clicked.connect(self.ok)
        button_layout.addWidget(self.okay_btn)

        self.cancel_btn = QPushButton("Cancel")
        self.cancel_btn.clicked.connect(self.cancel)
        button_layout.addWidget(self.cancel_btn)

        self.base_layout.addLayout(button_layout, stretch=0)

        self.hintPanel = QVBoxLayout()
        self.hintLabel = QLabel()
        self.hintButton = QPushButton("More...")

        self.hintPanel.addWidget(self.hintLabel)
        self.hintPanel.addWidget(self.hintButton)
        self.hintButton.hide()
        self.hintPanel.addStretch()

        self.base_layout.addLayout(self.hintPanel, stretch=1)

        self.setLayout(self.base_layout)

    def ok(self):
        self.apply()
        self.cancel()

    def cancel(self):
        self.refresh_editor()
        if hasattr(self, "blk_widget"):
            self.blk_widget.deactivate_editor(self)

    def apply(self):
        # subclass pushes content to line_edit, then calls super().apply()
        try:
            self.on_apply()
            self.hint()
        except Exception as e:
            self.hint(str(e), "Failed to apply changes:", exc=e)
        self.refresh_editor()

    def refresh_editor(self):
        pass

    def hint(self, text="", header=None, exc=None):

        txt = f"<h4>{header}</h4>\n" if header else ""

        txt += text

        self.hintLabel.setText(txt)

        if exc is not None:
            self.hintButton.show()

            def raise_exc(*_, e=exc):
                raise e

            self.hintButton.clicked.connect(raise_exc)
        else:
            self.hintButton.hide()

    @staticmethod
    def hard_refresh(func):
        def decorated(self, *args, **kwargs):
            def pending(f=func, *a, **k):
                f(self,*a, **k)

            win = self.blk_widget.win
            blk = self.blk_widget.blk
            return win.hard_refresh(blk, func=pending, to_editor=self)
        return decorated

    def _hard_refresh(self, func:callable=lambda:None):
        from .comments import CommentEditorWidget

        blk = self.blk_widget.blk
        win = self.blk_widget.win

        if (self.blk_widget.active.count() > 1 and
            not win._custom_popup(
                "Warning!",
                "This change requires a refresh of the entire window for this block. "
                "You will lose changes made in other editor tabs.\n\n"
                "Continue?",
                ("Apply Changes and Refresh", True),
                cancel=True
        )):
            return

        func()

        win._set_flag(win.root_block, "refresh", True)
        win.go_to_block(win.root_block)

        blk_widget = win.find_widget(blk=blk, go_to=True)

        if isinstance(self, BasePropEditor):
            blk_widget.activate_prop_editor(self.prop_name)
        elif isinstance(self, CommentEditorWidget):
            blk_widget.activate_comment_editor(self.editor.prop_name)
        else:
            blk_widget.activate_misc_editor(self.editor_id)

        return blk_widget

apply_btn instance-attribute 

apply_btn = QPushButton('Apply')

base_layout instance-attribute 

base_layout = QVBoxLayout(self)

blk_widget instance-attribute 

blk_widget = block_widget

cancel_btn instance-attribute 

cancel_btn = QPushButton('Cancel')

editor instance-attribute 

editor = editor_widget

hintButton instance-attribute 

hintButton = QPushButton('More...')

hintLabel instance-attribute 

hintLabel = QLabel()

hintPanel instance-attribute 

hintPanel = QVBoxLayout()

okay_btn instance-attribute 

okay_btn = QPushButton('OK')

__init__ 

__init__(block_widget, editor_widget)
Source code in FoSpy/ui/app/editors/_base.py 
10
11
12
13
14
15
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
def __init__(self, block_widget, editor_widget):
    super().__init__()

    self.blk_widget = block_widget

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

    self.editor = editor_widget
    self.refresh_editor()
    self.base_layout.addWidget(self.editor, stretch=0)

    self.setLayout(self.base_layout)

    button_layout = QHBoxLayout()
    button_layout.addStretch()

    self.apply_btn = QPushButton("Apply")
    self.apply_btn.clicked.connect(self.apply)
    button_layout.addWidget(self.apply_btn)

    self.okay_btn = QPushButton("OK")
    self.okay_btn.clicked.connect(self.ok)
    button_layout.addWidget(self.okay_btn)

    self.cancel_btn = QPushButton("Cancel")
    self.cancel_btn.clicked.connect(self.cancel)
    button_layout.addWidget(self.cancel_btn)

    self.base_layout.addLayout(button_layout, stretch=0)

    self.hintPanel = QVBoxLayout()
    self.hintLabel = QLabel()
    self.hintButton = QPushButton("More...")

    self.hintPanel.addWidget(self.hintLabel)
    self.hintPanel.addWidget(self.hintButton)
    self.hintButton.hide()
    self.hintPanel.addStretch()

    self.base_layout.addLayout(self.hintPanel, stretch=1)

    self.setLayout(self.base_layout)

_hard_refresh 

_hard_refresh(func=lambda: None)
Source code in FoSpy/ui/app/editors/_base.py 
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
130
131
132
133
134
135
136
def _hard_refresh(self, func:callable=lambda:None):
    from .comments import CommentEditorWidget

    blk = self.blk_widget.blk
    win = self.blk_widget.win

    if (self.blk_widget.active.count() > 1 and
        not win._custom_popup(
            "Warning!",
            "This change requires a refresh of the entire window for this block. "
            "You will lose changes made in other editor tabs.\n\n"
            "Continue?",
            ("Apply Changes and Refresh", True),
            cancel=True
    )):
        return

    func()

    win._set_flag(win.root_block, "refresh", True)
    win.go_to_block(win.root_block)

    blk_widget = win.find_widget(blk=blk, go_to=True)

    if isinstance(self, BasePropEditor):
        blk_widget.activate_prop_editor(self.prop_name)
    elif isinstance(self, CommentEditorWidget):
        blk_widget.activate_comment_editor(self.editor.prop_name)
    else:
        blk_widget.activate_misc_editor(self.editor_id)

    return blk_widget

apply 

apply()
Source code in FoSpy/ui/app/editors/_base.py 
64
65
66
67
68
69
70
71
def apply(self):
    # subclass pushes content to line_edit, then calls super().apply()
    try:
        self.on_apply()
        self.hint()
    except Exception as e:
        self.hint(str(e), "Failed to apply changes:", exc=e)
    self.refresh_editor()

cancel 

cancel()
Source code in FoSpy/ui/app/editors/_base.py 
59
60
61
62
def cancel(self):
    self.refresh_editor()
    if hasattr(self, "blk_widget"):
        self.blk_widget.deactivate_editor(self)

hard_refresh staticmethod 

hard_refresh(func)
Source code in FoSpy/ui/app/editors/_base.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
@staticmethod
def hard_refresh(func):
    def decorated(self, *args, **kwargs):
        def pending(f=func, *a, **k):
            f(self,*a, **k)

        win = self.blk_widget.win
        blk = self.blk_widget.blk
        return win.hard_refresh(blk, func=pending, to_editor=self)
    return decorated

hint 

hint(text='', header=None, exc=None)
Source code in FoSpy/ui/app/editors/_base.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def hint(self, text="", header=None, exc=None):

    txt = f"<h4>{header}</h4>\n" if header else ""

    txt += text

    self.hintLabel.setText(txt)

    if exc is not None:
        self.hintButton.show()

        def raise_exc(*_, e=exc):
            raise e

        self.hintButton.clicked.connect(raise_exc)
    else:
        self.hintButton.hide()

ok 

ok()
Source code in FoSpy/ui/app/editors/_base.py 
55
56
57
def ok(self):
    self.apply()
    self.cancel()

refresh_editor 

refresh_editor()
Source code in FoSpy/ui/app/editors/_base.py 
73
74
def refresh_editor(self):
    pass

RenameEditorPanel

Bases: QWidget

Source code in FoSpy/ui/app/editors/rename.py 
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
77
78
79
80
81
82
83
class RenameEditorPanel(QWidget):
    def __init__(self, blk):
        super().__init__()

        parent_blk = blk._parent_block
        self.blk = blk
        self.parent_blk = parent_blk

        self.main_layout = QVBoxLayout(self)
        self.main_layout.setContentsMargins(0, 0, 0, 0)
        self.setLayout(self.main_layout)

        header = QLabel("<h4>Rename Properties</h4>")
        desc = QLabel("Select an existing property and type what you want to rename it to below. Then click 'Apply'.")
        desc.setWordWrap(True)

        blk_props = parent_blk.get_prop_dict()
        for prop in RESERVED:
            blk_props.pop(prop, None)

        rename_dict = parent_blk.rename_dict()

        selector_list = []
        for prop in blk_props:
            if prop in rename_dict.values():
                txt = "*"+prop
            else:
                txt = prop
            selector_list.append(txt)

        selector_list.extend(list(rename_dict.keys()))

        self.selector = QComboBox()
        self.selector.addItems(selector_list)
        self.selector.setEditable(False)
        self.selector.currentTextChanged.connect(self.on_change)

        self.input = QLineEdit()

        for w in (header, desc, self.selector, self.input):
            self.main_layout.addWidget(w)

    def on_change(self, text):
        text = text.lstrip("*")
        rename_dict = self.parent_blk.rename_dict()
        rename_from = {v:k for k,v in rename_dict.items()}
        set_to = False
        if text in rename_from:
            set_to = text
            self.selector.setCurrentText(rename_from[text])
        else:
            set_to = rename_dict.get(text, "")

        self.input.setText(set_to)

blk instance-attribute 

blk = blk

input instance-attribute 

input = QLineEdit()

main_layout instance-attribute 

main_layout = QVBoxLayout(self)

parent_blk instance-attribute 

parent_blk = parent_blk

selector instance-attribute 

selector = QComboBox()

__init__ 

__init__(blk)
Source code in FoSpy/ui/app/editors/rename.py 
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
def __init__(self, blk):
    super().__init__()

    parent_blk = blk._parent_block
    self.blk = blk
    self.parent_blk = parent_blk

    self.main_layout = QVBoxLayout(self)
    self.main_layout.setContentsMargins(0, 0, 0, 0)
    self.setLayout(self.main_layout)

    header = QLabel("<h4>Rename Properties</h4>")
    desc = QLabel("Select an existing property and type what you want to rename it to below. Then click 'Apply'.")
    desc.setWordWrap(True)

    blk_props = parent_blk.get_prop_dict()
    for prop in RESERVED:
        blk_props.pop(prop, None)

    rename_dict = parent_blk.rename_dict()

    selector_list = []
    for prop in blk_props:
        if prop in rename_dict.values():
            txt = "*"+prop
        else:
            txt = prop
        selector_list.append(txt)

    selector_list.extend(list(rename_dict.keys()))

    self.selector = QComboBox()
    self.selector.addItems(selector_list)
    self.selector.setEditable(False)
    self.selector.currentTextChanged.connect(self.on_change)

    self.input = QLineEdit()

    for w in (header, desc, self.selector, self.input):
        self.main_layout.addWidget(w)

on_change 

on_change(text)
Source code in FoSpy/ui/app/editors/rename.py 
72
73
74
75
76
77
78
79
80
81
82
83
def on_change(self, text):
    text = text.lstrip("*")
    rename_dict = self.parent_blk.rename_dict()
    rename_from = {v:k for k,v in rename_dict.items()}
    set_to = False
    if text in rename_from:
        set_to = text
        self.selector.setCurrentText(rename_from[text])
    else:
        set_to = rename_dict.get(text, "")

    self.input.setText(set_to)

RenameEditorWidget

Bases: BaseEditorWidget

Source code in FoSpy/ui/app/editors/rename.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class RenameEditorWidget(BaseEditorWidget):
    editor_id = Sentinel("rename editor id")
    def __init__(self, block_widget):
        panel = RenameEditorPanel(block_widget.blk)
        super().__init__(block_widget, panel)
        self.okay_btn.setVisible(False)
        self.cancel_btn.setVisible(False)

    @BaseEditorWidget.hard_refresh
    def apply(self):
        rename_from = self.editor.selector.currentText()
        rename_to = self.editor.input.text()
        self.editor.parent_blk.rename_block(rename_from, rename_to)
        self.blk_widget.win._flag_edited(self.editor.parent_blk)

editor_id class-attribute instance-attribute 

editor_id = Sentinel('rename editor id')

__init__ 

__init__(block_widget)
Source code in FoSpy/ui/app/editors/rename.py 
15
16
17
18
19
def __init__(self, block_widget):
    panel = RenameEditorPanel(block_widget.blk)
    super().__init__(block_widget, panel)
    self.okay_btn.setVisible(False)
    self.cancel_btn.setVisible(False)

apply 

apply()
Source code in FoSpy/ui/app/editors/rename.py 
21
22
23
24
25
26
@BaseEditorWidget.hard_refresh
def apply(self):
    rename_from = self.editor.selector.currentText()
    rename_to = self.editor.input.text()
    self.editor.parent_blk.rename_block(rename_from, rename_to)
    self.blk_widget.win._flag_edited(self.editor.parent_blk)

Sentinel

Source code in FoSpy/ui/app/window.py 
38
39
40
41
42
43
44
45
class Sentinel:
    def __init__(self, hint, bool_val=True):
        self.hint = hint
        self.bool_val = bool_val
    def __bool__(self):
        return self.bool_val
    def __repr__(self):
        return f"<{self.hint}>"

bool_val instance-attribute 

bool_val = bool_val

hint instance-attribute 

hint = hint

__bool__ 

__bool__()
Source code in FoSpy/ui/app/window.py 
42
43
def __bool__(self):
    return self.bool_val

__init__ 

__init__(hint, bool_val=True)
Source code in FoSpy/ui/app/window.py 
39
40
41
def __init__(self, hint, bool_val=True):
    self.hint = hint
    self.bool_val = bool_val

__repr__ 

__repr__()
Source code in FoSpy/ui/app/window.py 
44
45
def __repr__(self):
    return f"<{self.hint}>"