Skip to content

Type improvements to landing.py and panel.py #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/tagstudio/qt/modals/build_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,7 @@ def __init__(self, library: Library, tag: Tag | None = None) -> None:

tsp = TagSearchPanel(self.lib, exclude_ids)
tsp.tag_chosen.connect(lambda x: self.add_parent_tag_callback(x))
self.add_tag_modal = PanelModal(tsp)
self.add_tag_modal.setTitle(Translations["tag.parent_tags.add"])
self.add_tag_modal = PanelModal(tsp, Translations["tag.parent_tags.add"])
self.add_tag_modal.setWindowTitle(Translations["tag.parent_tags.add"])
self.parent_tags_add_button.clicked.connect(self.add_tag_modal.show)

Expand Down
2 changes: 1 addition & 1 deletion src/tagstudio/qt/modals/tag_database.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ def build_tag(self, name: str):
panel = BuildTagPanel(self.lib)
self.modal = PanelModal(
panel,
Translations["tag.new"],
has_save=True,
)
self.modal.setTitle(Translations["tag.new"])
self.modal.setWindowTitle(Translations["tag.new"])
if name.strip():
panel.name_field.setText(name)
Expand Down
5 changes: 3 additions & 2 deletions src/tagstudio/qt/modals/tag_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,9 @@ def on_tag_modal_saved():
from tagstudio.qt.modals.build_tag import BuildTagPanel # here due to circular imports

self.build_tag_modal: BuildTagPanel = BuildTagPanel(self.lib)
self.add_tag_modal: PanelModal = PanelModal(self.build_tag_modal, has_save=True)
self.add_tag_modal.setTitle(Translations["tag.new"])
self.add_tag_modal: PanelModal = PanelModal(
self.build_tag_modal, Translations["tag.new"], has_save=True
)
self.add_tag_modal.setWindowTitle(Translations["tag.add"])

self.build_tag_modal.name_field.setText(name)
Expand Down
6 changes: 3 additions & 3 deletions src/tagstudio/qt/ts_qt.py
Original file line number Diff line number Diff line change
Expand Up @@ -363,12 +363,12 @@ def start(self) -> None:
# Initialize the Tag Manager panel
self.tag_manager_panel = PanelModal(
widget=TagDatabasePanel(self, self.lib),
title=Translations["tag_manager.title"],
done_callback=lambda: self.main_window.preview_panel.update_widgets(
update_preview=False
),
has_save=False,
)
self.tag_manager_panel.setTitle(Translations["tag_manager.title"])
self.tag_manager_panel.setWindowTitle(Translations["tag_manager.title"])

# Initialize the Color Group Manager panel
Expand Down Expand Up @@ -662,9 +662,9 @@ def init_file_extension_manager(self):
panel = FileExtensionModal(self.lib)
self.file_extension_panel = PanelModal(
panel,
Translations["ignore_list.title"],
has_save=True,
)
self.file_extension_panel.setTitle(Translations["ignore_list.title"])
self.file_extension_panel.setWindowTitle(Translations["ignore_list.title"])
self.file_extension_panel.saved.connect(
lambda: (panel.save(), self.update_browsing_state())
Expand Down Expand Up @@ -785,9 +785,9 @@ def add_tag_action_callback(self):
panel = BuildTagPanel(self.lib)
self.modal = PanelModal(
panel,
Translations["tag.new"],
has_save=True,
)
self.modal.setTitle(Translations["tag.new"])
self.modal.setWindowTitle(Translations["tag.add"])

self.modal.saved.connect(
Expand Down
3 changes: 1 addition & 2 deletions src/tagstudio/qt/widgets/landing.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,12 @@ def __init__(self, driver: "QtDriver", pixel_ratio: float):
self.landing_layout.addWidget(self.open_button, alignment=Qt.AlignmentFlag.AlignCenter)
self.landing_layout.addWidget(self.status_label, alignment=Qt.AlignmentFlag.AlignCenter)

def update_logo_color(self, style: str = "mono"):
def update_logo_color(self, style: typing.Literal["mono", "gradient"] = "mono"):
"""Update the color of the TagStudio logo.

Args:
style (str): = The style of the logo. Either "mono" or "gradient".
"""
logo_im: Image.Image = None
if style == "mono":
logo_im = theme_fg_overlay(self.logo_raw)
elif style == "gradient":
Expand Down
30 changes: 14 additions & 16 deletions src/tagstudio/qt/widgets/panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ def __init__(
widget: "PanelWidget",
title: str = "",
window_title: str = "",
done_callback: Callable | None = None,
save_callback: Callable | None = None,
done_callback: Callable[[], None] | None = None,
save_callback: Callable[[str], None] | None = None,
has_save: bool = False,
):
# [Done]
Expand All @@ -44,7 +44,7 @@ def __init__(
self.title_widget.setObjectName("fieldTitle")
self.title_widget.setWordWrap(True)
self.title_widget.setStyleSheet("font-weight:bold;font-size:14px;padding-top: 6px")
self.setTitle(title)
self.title_widget.setText(title)
self.title_widget.setAlignment(Qt.AlignmentFlag.AlignCenter)

self.button_container = QWidget()
Expand Down Expand Up @@ -89,7 +89,8 @@ def __init__(
# trigger save button actions when pressing enter in the widget
self.widget.add_callback(lambda: self.save_button.click())

widget.done.connect(lambda: save_callback(widget.get_content()))
if save_callback is not None:
widget.done.connect(lambda: save_callback(widget.get_content()))

self.root_layout.addWidget(self.title_widget)
self.root_layout.addWidget(widget)
Expand All @@ -98,22 +99,20 @@ def __init__(
self.root_layout.addWidget(self.button_container)
widget.parent_post_init()

def closeEvent(self, event): # noqa: N802
@override
def closeEvent(self, event: QtGui.QCloseEvent) -> None:
if self.cancel_button:
self.cancel_button.click()
elif self.done_button:
self.done_button.click()
event.accept()

def setTitle(self, title: str): # noqa: N802
self.title_widget.setText(title)


class PanelWidget(QWidget):
"""Used for widgets that go in a modal panel, ex. for editing or searching."""

done = Signal()
parent_modal: PanelModal = None
parent_modal: PanelModal | None = None
panel_save_button: QPushButton | None = None
panel_cancel_button: QPushButton | None = None
panel_done_button: QPushButton | None = None
Expand All @@ -122,19 +121,19 @@ def __init__(self):
super().__init__()

def get_content(self) -> str:
pass
return ""

def reset(self):
def reset(self) -> None:
pass

def parent_post_init(self):
def parent_post_init(self) -> None:
pass

def add_callback(self, callback: Callable, event: str = "returnPressed"):
def add_callback(self, callback: Callable[[], None], event: str = "returnPressed"):
logger.warning(f"[PanelModal] add_callback not implemented for {self.__class__.__name__}")

@override
def keyPressEvent(self, event: QtGui.QKeyEvent) -> None: # noqa N802
def keyPressEvent(self, event: QtGui.QKeyEvent) -> None:
if event.key() == QtCore.Qt.Key.Key_Escape:
if self.panel_cancel_button:
self.panel_cancel_button.click()
Expand All @@ -146,5 +145,4 @@ def keyPressEvent(self, event: QtGui.QKeyEvent) -> None: # noqa N802
elif self.panel_done_button:
self.panel_done_button.click()
else: # Other key presses
pass
return super().keyPressEvent(event)
super().keyPressEvent(event)