Skip to content

settings

Classes:

GraphicsViewSection 

GraphicsViewSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
118
119
120
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

auto_fit_default property 

auto_fit_default: QKeySequence

parent instance-attribute 

parent: ShortCutsSettings = parent

pop_out_plugins_default property 

pop_out_plugins_default: QKeySequence

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
134
135
136
137
138
def setup_shortcuts(self) -> None:
    main = self.parent.main

    self.create_shortcut(self.auto_fit_lineedit, main, main.auto_fit_keyswitch)
    self.create_shortcut(self.pop_out_plugins_lineedit, main, main.pop_out_plugins)

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
122
123
124
125
126
127
128
129
130
131
132
def setup_ui(self) -> None:
    self.zoom_levels_lineedit = ShortCutLineEdit()
    self.zoom_levels_lineedit.setText("Ctrl+Scroll")
    self.zoom_levels_lineedit.setDisabled(True)

    self.auto_fit_lineedit = ShortCutLineEdit()
    self.pop_out_plugins_lineedit = ShortCutLineEdit()

    self.setup_ui_shortcut("Cycle through zoom levels", self.zoom_levels_lineedit, hide_reset=True)
    self.setup_ui_shortcut("Auto-fit", self.auto_fit_lineedit, self.auto_fit_default)
    self.setup_ui_shortcut("Pop-out plugins :", self.pop_out_plugins_lineedit, self.pop_out_plugins_default)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

PluginSection 

PluginSection(parent: ShortCutsSettings, plugin: AbstractPlugin)

Bases: AbtractShortcutSectionQYAMLObject

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
942
943
944
945
946
def __init__(self, parent: ShortCutsSettings, plugin: AbstractPlugin) -> None:
    self.parent = parent
    self.plugin = plugin
    self.plugin_shortcut_settings = dict[str, _PluginShortcutSettings]()
    super().__init__()

parent instance-attribute 

parent: ShortCutsSettings = parent

plugin instance-attribute 

plugin = plugin

plugin_shortcut_settings instance-attribute 

plugin_shortcut_settings = dict[str, _PluginShortcutSettings]()

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
960
961
962
963
964
965
966
967
968
def setup_shortcuts(self) -> None:
    for sett in self.plugin_shortcut_settings.values():
        plsh = sett.plugin_shortcut

        self.create_shortcut(
            sett.lineedit,
            eval(plsh.parent.replace("self.", "self.plugin.")) if isinstance(plsh.parent, str) else plsh.parent,
            eval(plsh.handler.replace("self.", "self.plugin.")) if isinstance(plsh.handler, str) else plsh.handler,
        )

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
948
949
950
951
952
953
954
955
956
957
958
def setup_ui(self) -> None:
    if not self.plugin.shortcuts:
        return

    self.label = TitleLabel(self.plugin._config.display_name, "###")
    self.parent.vlayout.addWidget(self.label)

    for shortcut in self.plugin.shortcuts:
        le = ShortCutLineEdit()
        self.plugin_shortcut_settings[shortcut.name] = _PluginShortcutSettings(le, shortcut)
        self.setup_ui_shortcut(shortcut.description or shortcut.name, le, shortcut.key)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

ScriptErrorDialogSection 

ScriptErrorDialogSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
889
890
891
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

exit_default property 

exit_default: QKeySequence

parent instance-attribute 

parent: ShortCutsSettings = parent

reload_default property 

reload_default: QKeySequence

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
903
904
905
906
907
908
909
def setup_shortcuts(self) -> None:
    main = self.parent.main

    self.create_shortcut(
        self.reload_lineedit, main.script_error_dialog, main.script_error_dialog.reload_button.click
    )
    self.create_shortcut(self.exit_lineedit, main.script_error_dialog, main.script_error_dialog.exit_button.click)

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
893
894
895
896
897
898
899
900
901
def setup_ui(self) -> None:
    self.reload_lineedit = ShortCutLineEdit(conflictable=False)
    self.exit_lineedit = ShortCutLineEdit(conflictable=False)

    self.setup_ui_shortcut("Reload", self.reload_lineedit, self.reload_default, hide_reset=True)
    self.setup_ui_shortcut("Exit", self.exit_lineedit, self.exit_default, hide_reset=True)

    self.reload_lineedit.setDisabled(True)
    self.exit_lineedit.setDisabled(True)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

ShortCutsSettings 

ShortCutsSettings(main_window: MainWindow)

Bases: AbstractSettingsScrollArea

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def __init__(self, main_window: MainWindow) -> None:
    self.main = main_window

    self.sections = {
        "graphics_view": GraphicsViewSection(self),
        "main": ToolbarMainSection(self),
        "playback": ToolbarPlaybackSection(self),
        "scening": ToolbarSceningSection(self),
        "pipette": ToolbarPipetteSection(self),
        "misc": ToolbarMiscSection(self),
        "script_error": ScriptErrorDialogSection(self),
    }
    self.sections_plugins = {ns: PluginSection(self, plugin) for ns, plugin in self.main.plugins.plugins.items()}
    super().__init__()

frame instance-attribute 

frame: QFrame

hlayout instance-attribute 

hlayout: HBoxLayout

main instance-attribute 

main: MainWindow = main_window

sections instance-attribute 

sections: dict[str, AbtractShortcutSection] = {
    "graphics_view": GraphicsViewSection(self),
    "main": ToolbarMainSection(self),
    "playback": ToolbarPlaybackSection(self),
    "scening": ToolbarSceningSection(self),
    "pipette": ToolbarPipetteSection(self),
    "misc": ToolbarMiscSection(self),
    "script_error": ScriptErrorDialogSection(self),
}

sections_plugins instance-attribute 

sections_plugins: dict[str, "PluginSection"] = {
    ns: (PluginSection(self, plugin)) for (ns, plugin) in (items())
}

storable_attrs class-attribute 

storable_attrs: tuple[str, ...] = ()

vlayout instance-attribute 

vlayout: VBoxLayout

get_separator 

get_separator(horizontal: bool = False) -> QFrame
Source code in vspreview/core/abstracts.py 
318
319
320
321
322
def get_separator(self, horizontal: bool = False) -> QFrame:
    separator = QFrame(self)
    separator.setFrameShape(QFrame.Shape.HLine if horizontal else QFrame.Shape.VLine)
    separator.setFrameShadow(QFrame.Shadow.Sunken)
    return separator

set_defaults 

set_defaults() -> None
Source code in vspreview/shortcuts/settings.py 
81
82
def set_defaults(self) -> None:
    pass

set_qobject_names 

set_qobject_names() -> None
Source code in vspreview/core/abstracts.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
def set_qobject_names(self) -> None:
    if not hasattr(self, '__slots__'):
        return

    slots = list(self.__slots__)

    if isinstance(self, AbstractToolbar) and 'main' in slots:
        slots.remove('main')

    for attr_name in slots:
        attr = getattr(self, attr_name)
        if not isinstance(attr, QObject):
            continue
        attr.setObjectName(type(self).__name__ + '.' + attr_name)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
84
85
86
def setup_shortcuts(self) -> None:
    for section in self.sections.values():
        section.setup_shortcuts()

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
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
def setup_ui(self) -> None:
    super().setup_ui()

    self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAlwaysOn)
    self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAlwaysOff)

    self.vlayout.addWidget(TitleLabel("Graphics view"))
    self.sections["graphics_view"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Toolbars"))

    self.vlayout.addWidget(TitleLabel("Main", "###"))
    self.sections["main"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Playback", "###"))
    self.sections["playback"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Scening", "###"))
    self.sections["scening"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Pipette", "###"))
    self.sections["pipette"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Misc", "###"))
    self.sections["misc"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Script error dialog"))
    self.sections["script_error"].setup_ui()

    self.vlayout.addWidget(TitleLabel("Plugins"))
    for section in self.sections_plugins.values():
        section.setup_ui()

    self.main.app_settings.addTab(self, "Shortcuts")

ToolbarMainSection 

ToolbarMainSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
172
173
174
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

copy_frame_default property 

copy_frame_default: QKeySequence

parent instance-attribute 

parent: ShortCutsSettings = parent

switch_output_default property 

switch_output_default: list[QKeySequence]

switch_output_next_default property 

switch_output_next_default: QKeySequence

switch_output_previous_default property 

switch_output_previous_default: QKeySequence

sync_ouputs_default property 

sync_ouputs_default: QKeySequence

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
def setup_shortcuts(self) -> None:
    main = self.parent.main
    main_toolbar = main.toolbars.main

    for i, le in enumerate(self.switch_output_lineedit):
        if not le.text():
            continue
        self.create_shortcut(le, main, partial(main.switch_output, i))
        self.create_shortcut(
            QKeySequence(
                QKeyCombination(
                    self.switch_output_modifier_combobox.currentValue().modifier, QKeySequence(le.text())[0].key()
                ).toCombined()
            ),
            main,
            partial(main.switch_output, -(i + 1)),
        )

    self.create_shortcut(
        self.switch_output_next_lineedit,
        main,
        lambda: main.switch_output(main_toolbar.outputs_combobox.currentIndex() + 1),
    )
    self.create_shortcut(
        self.switch_output_previous_lineedit,
        main,
        lambda: main.switch_output(main_toolbar.outputs_combobox.currentIndex() - 1),
    )
    self.create_shortcut(self.copy_frame_lineedit, main, main_toolbar.on_copy_frame_button_clicked)
    self.create_shortcut(self.copy_timestamp_lineedit, main, main_toolbar.on_copy_timestamp_button_clicked)

    self.create_shortcut(self.sync_ouputs_lineedit, main, main_toolbar.sync_outputs_checkbox.click)

    self.create_shortcut(self.switch_timeline_mode_lineedit, main, main_toolbar.switch_timeline_mode_button.click)
    self.create_shortcut(self.settings_lineedit, main, main_toolbar.settings_button.click)

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
def setup_ui(self) -> None:
    self.switch_output_lineedit = [
        ShortCutLineEdit(allow_modifiers=False) for _ in range(len(self.switch_output_default))
    ]

    self.switch_output_modifier_combobox = ComboBox[Modifier](
        model=ModifierModel([Modifier.CTRL, Modifier.SHIFT, Modifier.ALT])
    )
    self.switch_output_modifier_combobox.setMaximumWidth(MAX_WIDTH_LINE_EDIT)

    self.switch_output_next_lineedit = ShortCutLineEdit()
    self.switch_output_previous_lineedit = ShortCutLineEdit()

    self.copy_frame_lineedit = ShortCutLineEdit()
    self.copy_timestamp_lineedit = ShortCutLineEdit()

    self.sync_ouputs_lineedit = ShortCutLineEdit()

    self.switch_timeline_mode_lineedit = ShortCutLineEdit()
    self.settings_lineedit = ShortCutLineEdit()

    for i, (le, num_key) in enumerate(zip(self.switch_output_lineedit, self.switch_output_default)):
        self.setup_ui_shortcut(f"View output node {i}", le, num_key)

    self.setup_ui_shortcut("View output node last index modifier", self.switch_output_modifier_combobox)

    self.setup_ui_shortcut(
        "View next output node", self.switch_output_next_lineedit, self.switch_output_next_default
    )
    self.setup_ui_shortcut(
        "View previous output node", self.switch_output_previous_lineedit, self.switch_output_previous_default
    )

    self.setup_ui_shortcut(
        "Copy current frame number to clipboard", self.copy_frame_lineedit, self.copy_frame_default
    )
    self.setup_ui_shortcut(
        "Copy current timestamp to clipboard", self.copy_timestamp_lineedit, self.unassigned_default
    )

    self.setup_ui_shortcut(
        "Toggle whether output nodes are synced", self.sync_ouputs_lineedit, self.sync_ouputs_default
    )

    self.setup_ui_shortcut("Switch timeline mode", self.switch_timeline_mode_lineedit, self.unassigned_default)
    self.setup_ui_shortcut("Open settings window", self.settings_lineedit, self.unassigned_default)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

ToolbarMiscSection 

ToolbarMiscSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
791
792
793
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

copy_frame_default property 

copy_frame_default: QKeySequence

parent instance-attribute 

parent: ShortCutsSettings = parent

reload_script_default property 

reload_script_default: QKeySequence

save_frame_as_default property 

save_frame_as_default: QKeySequence

save_storage_default property 

save_storage_default: QKeySequence

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
def setup_shortcuts(self) -> None:
    main = self.parent.main
    misc_toolbar = main.toolbars.misc

    self.create_shortcut(self.autosave_lineedit, misc_toolbar, misc_toolbar.autosave_checkbox.click)

    if main.reload_enabled:
        self.create_shortcut(self.reload_script_lineedit, main, misc_toolbar.reload_script_button.click)

    self.create_shortcut(self.save_storage_lineedit, main, misc_toolbar.save_storage_button.click)
    self.create_shortcut(self.copy_frame_lineedit, main, misc_toolbar.copy_frame_button.click)

    self.create_shortcut(self.save_frame_as_lineedit, main, misc_toolbar.save_frame_as_button.click)

    self.create_shortcut(self.toggle_sar_lineedit, main, misc_toolbar.ar_active_switch.click)

    self.create_shortcut(self.enable_crop_lineedit, misc_toolbar, misc_toolbar.crop_active_switch.click)
    self.create_shortcut(self.copy_crop_command_lineedit, misc_toolbar, misc_toolbar.crop_copycommand_button.click)

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
def setup_ui(self) -> None:
    self.autosave_lineedit = ShortCutLineEdit()

    self.reload_script_lineedit = ShortCutLineEdit()
    if not self.parent.main.reload_enabled:
        self.reload_script_lineedit.setDisabled(True)

    self.save_storage_lineedit = ShortCutLineEdit()
    self.copy_frame_lineedit = ShortCutLineEdit()

    self.save_frame_as_lineedit = ShortCutLineEdit()

    self.toggle_sar_lineedit = ShortCutLineEdit()
    self.enable_crop_lineedit = ShortCutLineEdit()
    self.copy_crop_command_lineedit = ShortCutLineEdit()

    self.setup_ui_shortcut("Toggle whether autosave is enabled", self.autosave_lineedit, self.unassigned_default)

    self.setup_ui_shortcut("Reload script", self.reload_script_lineedit, self.reload_script_default)
    self.setup_ui_shortcut("Manually save storage", self.save_storage_lineedit, self.save_storage_default)
    self.setup_ui_shortcut("Copy current frame to clipboard", self.copy_frame_lineedit, self.copy_frame_default)

    self.setup_ui_shortcut("Save current frame as", self.save_frame_as_lineedit, self.save_frame_as_default)

    self.parent.vlayout.addWidget(TitleLabel("Cropping assistant", "####"))
    self.setup_ui_shortcut(
        "Toggle whether SAR props are respected", self.toggle_sar_lineedit, self.unassigned_default
    )
    self.setup_ui_shortcut("Toggle crop assistant", self.enable_crop_lineedit, self.unassigned_default)
    self.setup_ui_shortcut("Copy crop command", self.copy_crop_command_lineedit, self.unassigned_default)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

ToolbarPipetteSection 

ToolbarPipetteSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
751
752
753
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

parent instance-attribute 

parent: ShortCutsSettings = parent

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
762
763
764
765
766
def setup_shortcuts(self) -> None:
    main = self.parent.main
    toolbar_pipette = main.toolbars.pipette

    self.create_shortcut(self.copy_position_lineedit, toolbar_pipette, toolbar_pipette.copy_position_button.click)

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
755
756
757
758
759
760
def setup_ui(self) -> None:
    self.copy_position_lineedit = ShortCutLineEdit()

    self.setup_ui_shortcut(
        "Copy coordinates of pixel position", self.copy_position_lineedit, self.unassigned_default
    )

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

ToolbarPlaybackSection 

ToolbarPlaybackSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
341
342
343
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

parent instance-attribute 

parent: ShortCutsSettings = parent

play_pause_default property 

play_pause_default: QKeySequence

seek_n_frames_b property writable 

seek_n_frames_b: list[str]

seek_n_frames_b_default property 

seek_n_frames_b_default: tuple[QKeySequence, QKeySequence]

seek_n_frames_f property writable 

seek_n_frames_f: list[str]

seek_n_frames_f_default property 

seek_n_frames_f_default: tuple[QKeySequence, QKeySequence]

seek_to_end_default property 

seek_to_end_default: QKeySequence

seek_to_next_default property 

seek_to_next_default: QKeySequence

seek_to_prev_default property 

seek_to_prev_default: QKeySequence

seek_to_start_default property 

seek_to_start_default: QKeySequence

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
def setup_shortcuts(self) -> None:
    main = self.parent.main
    playback_toolbar = main.toolbars.playback

    self.create_shortcut(self.play_pause_lineedit, main, playback_toolbar.play_pause_button.click)

    self.create_shortcut(self.seek_to_prev_lineedit, main, playback_toolbar.seek_to_prev_button.click)
    self.create_shortcut(self.seek_to_next_lineedit, main, playback_toolbar.seek_to_next_button.click)

    for le in self.seek_n_frames_b_lineedit:
        self.create_shortcut(le, main, playback_toolbar.seek_n_frames_b_button.click)
    for le in self.seek_n_frames_f_lineedit:
        self.create_shortcut(le, main, playback_toolbar.seek_n_frames_f_button.click)

    self.create_shortcut(self.seek_to_start_lineedit, main, playback_toolbar.seek_to_start_button.click)
    self.create_shortcut(self.seek_to_end_lineedit, main, playback_toolbar.seek_to_end_button.click)

    self.create_shortcut(self.play_n_frames_lineedit, main, playback_toolbar.play_n_frames_button.click)

    self.create_shortcut(self.reset_fps_lineedit, main, playback_toolbar.fps_reset_button.click)
    self.create_shortcut(
        self.unlimited_fps_lineedit, main, playback_toolbar.fps_unlimited_checkbox.click
    )
    self.create_shortcut(self.variable_fps_lineedit, main, playback_toolbar.fps_variable_checkbox.click)
    self.create_shortcut(self.mute_lineedit, main, playback_toolbar.mute_button.click)

    volume_steps = [x * 10 for x in range(11)]
    volume_slider = playback_toolbar.audio_volume_slider

    self.create_shortcut(
        self.decrease_volume_lineedit,
        main,
        lambda: playback_toolbar.setVolume(
            volume_steps[bisect_left(volume_steps, volume_slider.value() - 10)], updateGui=True
        ),
    )
    self.create_shortcut(
        self.increase_volume_lineedit,
        main,
        lambda: playback_toolbar.setVolume(
            volume_steps[bisect_right(volume_steps, volume_slider.value() + 10) - 1], updateGui=True
        ),
    )

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
def setup_ui(self) -> None:
    self.play_pause_lineedit = ShortCutLineEdit()

    self.seek_to_prev_lineedit = ShortCutLineEdit()
    self.seek_to_next_lineedit = ShortCutLineEdit()

    self.seek_n_frames_b_lineedit = (ShortCutLineEdit(), ShortCutLineEdit())
    self.seek_n_frames_f_lineedit = (ShortCutLineEdit(), ShortCutLineEdit())

    self.seek_to_start_lineedit = ShortCutLineEdit()
    self.seek_to_end_lineedit = ShortCutLineEdit()

    self.play_n_frames_lineedit = ShortCutLineEdit()

    self.reset_fps_lineedit = ShortCutLineEdit()
    self.unlimited_fps_lineedit = ShortCutLineEdit()
    self.variable_fps_lineedit = ShortCutLineEdit()

    self.mute_lineedit = ShortCutLineEdit()
    self.decrease_volume_lineedit = ShortCutLineEdit()
    self.increase_volume_lineedit = ShortCutLineEdit()

    self.setup_ui_shortcut("Play/Pause", self.play_pause_lineedit, self.play_pause_default)

    self.setup_ui_shortcut("Seek to previous frame", self.seek_to_prev_lineedit, self.seek_to_prev_default)
    self.setup_ui_shortcut("Seek to next frame", self.seek_to_next_lineedit, self.seek_to_next_default)

    self.setup_ui_shortcut("Seek back n frames", self.seek_n_frames_b_lineedit[0], self.seek_n_frames_b_default[0])
    self.setup_ui_shortcut("", self.seek_n_frames_b_lineedit[1], self.seek_n_frames_b_default[1])
    self.setup_ui_shortcut(
        "Seek forward n frames", self.seek_n_frames_f_lineedit[0], self.seek_n_frames_f_default[0]
    )
    self.setup_ui_shortcut("", self.seek_n_frames_f_lineedit[1], self.seek_n_frames_f_default[1])

    self.setup_ui_shortcut("Seek to first frame", self.seek_to_start_lineedit, self.seek_to_start_default)
    self.setup_ui_shortcut("Seek to last frame", self.seek_to_end_lineedit, self.seek_to_end_default)

    self.setup_ui_shortcut("Play n frames", self.play_n_frames_lineedit, self.unassigned_default)

    self.setup_ui_shortcut("Reset FPS", self.reset_fps_lineedit, self.unassigned_default)
    self.setup_ui_shortcut("Toggle unlimited FPS", self.unlimited_fps_lineedit, self.unassigned_default)
    self.setup_ui_shortcut("Toggle variable FPS", self.variable_fps_lineedit, self.unassigned_default)

    self.setup_ui_shortcut("Toggle audio mute", self.mute_lineedit, self.unassigned_default)
    self.setup_ui_shortcut("Decrease volume", self.decrease_volume_lineedit, self.unassigned_default)
    self.setup_ui_shortcut("Increase volume", self.increase_volume_lineedit, self.unassigned_default)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])

ToolbarSceningSection 

ToolbarSceningSection(parent: ShortCutsSettings)

Bases: AbtractShortcutSectionYAMLObjectSingleton

Methods:

Attributes:

Source code in vspreview/shortcuts/settings.py 
540
541
542
def __init__(self, parent: ShortCutsSettings) -> None:
    self.parent = parent
    super().__init__()

add_frame_scene_default property 

add_frame_scene_default: QKeySequence

add_to_list_default property 

add_to_list_default: QKeySequence

delete_scene_default property 

delete_scene_default: QKeySequence

parent instance-attribute 

parent: ShortCutsSettings = parent

paste_frame_scening_model_default property 

paste_frame_scening_model_default: QKeySequence

remove_last_from_list_default property 

remove_last_from_list_default: QKeySequence

remove_scene_at_current_frame_default property 

remove_scene_at_current_frame_default: QKeySequence

seek_to_next_scene_start_default property 

seek_to_next_scene_start_default: QKeySequence

seek_to_prev_scene_start_default property 

seek_to_prev_scene_start_default: QKeySequence

switch_list_default property 

switch_list_default: list[QKeySequence]

toggle_first_frame_default property 

toggle_first_frame_default: QKeySequence

toggle_second_frame_default property 

toggle_second_frame_default: QKeySequence

unassigned_default property 

unassigned_default: QKeySequence

create_shortcut 

create_shortcut(
    key: ShortCutLineEdit | QKeySequence | StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None
Source code in vspreview/shortcuts/abstract.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
def create_shortcut(
    self,
    key: ShortCutLineEdit | QKeySequence | QKeySequence.StandardKey | str | int | None,
    parent: QObject | None,
    handler: Callable[[], None],
) -> None:
    if isinstance(key, str) and not key:
        return None

    if isinstance(key, ShortCutLineEdit):
        key = key.text()

    Shortcut(key, parent, handler)

setup_shortcuts 

setup_shortcuts() -> None
Source code in vspreview/shortcuts/settings.py 
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
def setup_shortcuts(self) -> None:
    main = self.parent.main
    scening_toolbar = main.toolbars.scening

    self.create_shortcut(self.add_frame_scene_lineedit, scening_toolbar, scening_toolbar.on_toggle_single_frame)
    self.create_shortcut(
        self.toggle_first_frame_lineedit, scening_toolbar, scening_toolbar.toggle_first_frame_button.click
    )
    self.create_shortcut(
        self.toggle_second_frame_lineedit, scening_toolbar, scening_toolbar.toggle_second_frame_button.click
    )

    self.create_shortcut(self.add_to_list_lineedit, scening_toolbar, scening_toolbar.add_to_list_button.click)
    self.create_shortcut(
        self.remove_last_from_list_lineedit, scening_toolbar, scening_toolbar.remove_last_from_list_button.click
    )
    self.create_shortcut(
        self.remove_scene_at_current_frame_lineedit,
        scening_toolbar,
        scening_toolbar.remove_at_current_frame_button.click,
    )

    for i, le in enumerate(self.switch_list_lineedit):
        self.create_shortcut(le, scening_toolbar, partial(scening_toolbar.switch_list, i))

    self.create_shortcut(
        self.seek_to_prev_scene_start_lineedit, scening_toolbar, scening_toolbar.seek_to_prev_button.click
    )
    self.create_shortcut(
        self.seek_to_next_scene_start_lineedit, scening_toolbar, scening_toolbar.seek_to_next_button.click
    )

    self.create_shortcut(
        self.paste_frame_scening_model_lineedit,
        scening_toolbar.scening_list_dialog,
        lambda: scening_toolbar.scening_list_dialog.label_lineedit.setText(
            str(main.current_output.last_showed_frame)
        ),
    )
    self.create_shortcut(
        self.delete_scene_lineedit,
        scening_toolbar.scening_list_dialog,
        scening_toolbar.scening_list_dialog.delete_button.click,
    )

setup_ui 

setup_ui() -> None
Source code in vspreview/shortcuts/settings.py 
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
def setup_ui(self) -> None:
    self.add_frame_scene_lineedit = ShortCutLineEdit()
    self.toggle_first_frame_lineedit = ShortCutLineEdit()
    self.toggle_second_frame_lineedit = ShortCutLineEdit()

    self.add_to_list_lineedit = ShortCutLineEdit()
    self.remove_last_from_list_lineedit = ShortCutLineEdit()
    self.remove_scene_at_current_frame_lineedit = ShortCutLineEdit()

    self.switch_list_lineedit = [ShortCutLineEdit() for _ in range(len(self.switch_list_default))]

    self.seek_to_prev_scene_start_lineedit = ShortCutLineEdit()
    self.seek_to_next_scene_start_lineedit = ShortCutLineEdit()

    self.paste_frame_scening_model_lineedit = ShortCutLineEdit()
    self.delete_scene_lineedit = ShortCutLineEdit()

    self.setup_ui_shortcut(
        "Add current frame as single frame scene", self.add_frame_scene_lineedit, self.add_frame_scene_default
    )
    self.setup_ui_shortcut(
        "Toggle whether current frame is first frame",
        self.toggle_first_frame_lineedit,
        self.toggle_first_frame_default,
    )
    self.setup_ui_shortcut(
        "Toggle whether current frame is last frame",
        self.toggle_second_frame_lineedit,
        self.toggle_second_frame_default,
    )

    self.setup_ui_shortcut(
        "Add A-B selection to current scene list", self.add_to_list_lineedit, self.add_to_list_default
    )
    self.setup_ui_shortcut(
        "Remove last scene from current scene list",
        self.remove_last_from_list_lineedit,
        self.remove_last_from_list_default,
    )
    self.setup_ui_shortcut(
        "Remove scene at current frame",
        self.remove_scene_at_current_frame_lineedit,
        self.remove_scene_at_current_frame_default,
    )

    for i, (le, num_key) in enumerate(zip(self.switch_list_lineedit, self.switch_list_default)):
        self.setup_ui_shortcut(f"Switch to scene list {i}", le, num_key)

    self.setup_ui_shortcut(
        "Seek to previous scene start",
        self.seek_to_prev_scene_start_lineedit,
        self.seek_to_prev_scene_start_default,
    )
    self.setup_ui_shortcut(
        "Seek to next scene start", self.seek_to_next_scene_start_lineedit, self.seek_to_next_scene_start_default
    )

    self.parent.vlayout.addWidget(TitleLabel("Scening List Dialog", "####"))
    self.setup_ui_shortcut(
        "Paste current frame number\ninto active scening model",
        self.paste_frame_scening_model_lineedit,
        self.paste_frame_scening_model_default,
    )
    self.setup_ui_shortcut("Delete selected scene", self.delete_scene_lineedit, self.delete_scene_default)

setup_ui_shortcut 

setup_ui_shortcut(
    label: str,
    widget: QWidget,
    default: QKeySequence | None = None,
    hide_reset: bool = False,
) -> None
Source code in vspreview/shortcuts/abstract.py 
172
173
174
175
176
177
178
179
180
181
182
183
def setup_ui_shortcut(
    self, label: str, widget: QWidget, default: QKeySequence | None = None, hide_reset: bool = False
) -> None:
    button = ResetPushButton("Reset", self.parent)

    if not isinstance(widget, ShortCutLineEdit) or hide_reset or default is None:
        button.make_hidden()
    else:
        widget.setText(default.toString())
        button.clicked.connect(lambda: widget.setText(default.toString()))

    HBoxLayout(self.parent.vlayout, [QLabel(label), widget, button])