abstract ¶

def add_shortcut(
    self,
    name_or_key: Any,
    parent_or_handler: Any,
    /,
    handler: Callable[[], None] | str = "",
    key: QKeySequence | None = None,
    description: str | None = None
) -> None:
    if isinstance(name_or_key, str) and isinstance(parent_or_handler, (QObject | str)):
        name, parent, handler = name_or_key, parent_or_handler, handler
    else:
        name, parent, = f"shortcut_{self.__legacy_counter_shortcuts}", cast(QObject, self), 
        handler, key = parent_or_handler, QKeySequence(name_or_key)
        description = f"Shortcut {self.__legacy_counter_shortcuts}"
        self.__legacy_counter_shortcuts += 1

    self.shortcuts.append(PluginShortcut(name, parent, handler, key, description))

def add_shortcuts(self) -> None:
    ...

def first_load(self) -> bool:
    if not self._first_load_done:
        self.setup_ui()

        self.setup_shortcuts()

        self.set_qobject_names()

        self.on_first_load.emit()  # type: ignore

        self._first_load_done = True

        return True

    return False

def get_notches(self) -> Notches:
    from .custom import Notches
    return Notches()

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

def init_notches(self, main: MainWindow = ...) -> None:
    self.notches_changed.connect(main.timeline.update_notches)

def init_outputs(self) -> None:
    ...

def on_current_frame_changed(self, frame: Frame) -> None:
    ...

def on_current_output_changed(self, index: int, prev_index: int) -> None:
    ...

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)

def setup_shortcuts(self) -> None:
    self.main.shortcuts.sections_plugins[self._config.namespace].setup_shortcuts()

def setup_ui(self) -> None:
    self.vlayout = VBoxLayout(self)
    self.hlayout = HBoxLayout(self.vlayout)

def can_run_file(self, filepath: Path) -> bool:
    raise NotImplementedError

def cleanup(self) -> None:
    for file in self.temp_handles:
        try:
            if not file.exists():
                continue

            if file.is_dir():
                file.rmdirs(True)
            else:
                file.unlink(True)
        except PermissionError:
            continue

def get_extensions(self) -> Iterable[str]:
    return []

def get_temp_path(self, is_folder: bool = False) -> SPath:
    from tempfile import mkdtemp, mkstemp

    if is_folder:
        temp = mkdtemp()
    else:
        temp = mkstemp()[1]

    temp_path = SPath(temp)

    self.temp_handles.add(temp_path)

    return temp_path

def resolve_path(self, filepath: Path) -> ResolvedScript:
    raise NotImplementedError