Skip to content

feat(PreviewPanel): Truncate Path to a single line #429

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

Closed
wants to merge 11 commits into from
97 changes: 95 additions & 2 deletions tagstudio/src/qt/helpers/file_opener.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
from pathlib import Path

from PySide6.QtWidgets import QLabel
from PySide6.QtCore import Qt
from PySide6.QtCore import Qt, QEvent, QTimer
from PySide6.QtGui import Qt, QEnterEvent, QResizeEvent, QFontMetrics

ERROR = f"[ERROR]"
WARNING = f"[WARNING]"
Expand Down Expand Up @@ -125,15 +126,97 @@ def __init__(self, text, parent=None):
parent (QWidget, optional): The parent widget. Defaults to None.
"""
super().__init__(text, parent)
self.filepath = None
self.timer = QTimer()
self.timer.timeout.connect(self._show_full_path_callback)
self.font_metrics = QFontMetrics(self.font())

def setFilePath(self, filepath):
def setFilePath(self, filepath: str):
"""Set the filepath to open.

Args:
filepath (str): The path to the file to open.
"""
self.filepath = filepath

def truncate_filepath(self, filepath: Path | str):
"""Removes parent directories to fit path to a single line

Args:
filepath (Path | str): The path to the file to open.
"""
path = Path(filepath)
parts = path.parts
# Since font is not monospace, max chars comes out a little low since average is larger than most ASCII chars
# Ex: Manual counted max of 50 vs computed 45 chars
max_chars = self.width() // self.font_metrics.averageCharWidth()

if len(str(path)) < max_chars:
return str(path)

length = len(parts[0]) + len(path.name) + 4
trunc = [path.drive, "\u2026", path.name]

j = len(parts) - 2
for i in range(1, len(parts) // 2):
# Append front dir
trunc.insert(i, parts[i])
length += len(parts[i])
if length > max_chars:
# Remove exceding element
trunc.pop(i)
break

# Append back dir
trunc.insert(2 + i, parts[j])
length += len(parts[j])
if length > max_chars:
# Remove exceding element
trunc.pop(2 + i)
break
j -= 1
# There's a small region where all dirs can be added but its still trying to truncate,
# remove the ellipsis in that case
if len(trunc) == len(parts) + 1:
trunc.remove("\u2026")

return os.sep.join(trunc)

def setText(self, text: str):
"""Overwrites the text style if there is a filepath to be shown"""
if not self.filepath:
return super().setText(text)

filepath = Path(text)
file_str: str = ""
sep_color: str = "#777777" # Gray
for i, part in enumerate(filepath.parts):
part_ = part.strip(os.path.sep)
if i == 0:
file_str += f"{"\u200b".join(part_)}<a style='color: {sep_color}'><b>{os.path.sep}</a></b>"
elif i != 0 and i != len(filepath.parts) - 1:
file_str += f"{"\u200b".join(part_)}<a style='color: {sep_color}'><b>{os.path.sep}</b></a>"
else:
file_str += f"<b>{"\u200b".join(part_)}</b>"
return super().setText(file_str)

def enterEvent(self, event: QEnterEvent) -> None:
if self.filepath:
# Delay 250ms before revealing full path
self.timer.start(250)
return super().enterEvent(event)

def leaveEvent(self, event: QEvent) -> None:
if self.filepath:
# Cancel full path showing if mouse leaves before timer is up
self.timer.stop()
self.setText(self.truncate_filepath(self.filepath))
return super().leaveEvent(event)

def _show_full_path_callback(self):
"""Shows the full filepath instead of truncated version"""
self.setText(str(self.filepath))

def mousePressEvent(self, event):
"""Handle mouse press events.

Expand All @@ -150,3 +233,13 @@ def mousePressEvent(self, event):
elif event.button() == Qt.RightButton:
# Show context menu
pass

def resizeEvent(self, event: QResizeEvent) -> None:
"""Handle QLabel resize events.

Updates the text truncation as the label's width is changing
"""
# Don't update text if not filepath or same width
if self.filepath and event.size().width() != event.oldSize().width():
self.setText(self.truncate_filepath(self.filepath))
return super().resizeEvent(event)
99 changes: 74 additions & 25 deletions tagstudio/src/qt/widgets/preview_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio

import logging
import os
from pathlib import Path
import platform
import time
Expand All @@ -12,8 +13,8 @@
import rawpy
from PIL import Image, UnidentifiedImageError, ImageFont
from PIL.Image import DecompressionBombError
from PySide6.QtCore import QModelIndex, Signal, Qt, QSize, QByteArray, QBuffer
from PySide6.QtGui import QGuiApplication, QResizeEvent, QAction, QMovie
from PySide6.QtCore import QModelIndex, Signal, Qt, QSize, QByteArray, QBuffer, QEvent
from PySide6.QtGui import QGuiApplication, QResizeEvent, QAction, QMovie, QEnterEvent
from PySide6.QtWidgets import (
QWidget,
QVBoxLayout,
Expand Down Expand Up @@ -98,6 +99,21 @@ def __init__(self, library: Library, driver: "QtDriver"):
image_layout = QHBoxLayout(self.image_container)
image_layout.setContentsMargins(0, 0, 0, 0)

file_label_style = "font-size: 12px"
properties_style = (
f"background-color:{self.label_bg_color};"
"color:#FFFFFF;"
"font-family:Oxanium;"
"font-weight:bold;"
"font-size:12px;"
"border-radius:3px;"
"padding-top: 4px;"
"padding-right: 1px;"
"padding-bottom: 1px;"
"padding-left: 1px;"
)
date_style = "font-size:12px;"

self.open_file_action = QAction("Open file", self)
self.trash_term: str = "Trash"
if platform.system() == "Windows":
Expand Down Expand Up @@ -157,31 +173,26 @@ def __init__(self, library: Library, driver: "QtDriver"):
image_layout.addWidget(self.preview_vid)
image_layout.setAlignment(self.preview_vid, Qt.AlignmentFlag.AlignCenter)
self.image_container.setMinimumSize(*self.img_button_size)
self.file_label = FileOpenerLabel("Filename")
self.file_label = FileOpenerLabel("filename")
self.file_label.setTextFormat(Qt.TextFormat.RichText)
self.file_label.setWordWrap(True)
self.file_label.setTextInteractionFlags(
Qt.TextInteractionFlag.TextSelectableByMouse
)
self.file_label.setStyleSheet("font-weight: bold; font-size: 12px")
self.file_label.setStyleSheet(file_label_style)

self.dimensions_label = QLabel("Dimensions")
self.dimensions_label.setWordWrap(True)
# self.dim_label.setTextInteractionFlags(
# Qt.TextInteractionFlag.TextSelectableByMouse)
self.date_created_label = QLabel("dateCreatedLabel")
self.date_created_label.setAlignment(Qt.AlignmentFlag.AlignLeft)
self.date_created_label.setTextFormat(Qt.TextFormat.RichText)
self.date_created_label.setStyleSheet(date_style)

properties_style = (
f"background-color:{self.label_bg_color};"
"color:#FFFFFF;"
"font-family:Oxanium;"
"font-weight:bold;"
"font-size:12px;"
"border-radius:3px;"
"padding-top: 4px;"
"padding-right: 1px;"
"padding-bottom: 1px;"
"padding-left: 1px;"
)
self.date_modified_label = QLabel("dateModifiedLabel")
self.date_modified_label.setAlignment(Qt.AlignmentFlag.AlignLeft)
self.date_modified_label.setTextFormat(Qt.TextFormat.RichText)
self.date_modified_label.setStyleSheet(date_style)

self.dimensions_label = QLabel("dimensionsLabel")
self.dimensions_label.setWordWrap(True)
self.dimensions_label.setStyleSheet(properties_style)

self.scroll_layout = QVBoxLayout()
Expand Down Expand Up @@ -219,7 +230,15 @@ def __init__(self, library: Library, driver: "QtDriver"):
)
scroll_area.setWidget(scroll_container)

date_container = QWidget()
date_layout = QVBoxLayout(date_container)
date_layout.setContentsMargins(0, 2, 0, 0)
date_layout.setSpacing(0)
date_layout.addWidget(self.date_created_label)
date_layout.addWidget(self.date_modified_label)

info_layout.addWidget(self.file_label)
info_layout.addWidget(date_container)
info_layout.addWidget(self.dimensions_label)
info_layout.addWidget(scroll_area)

Expand Down Expand Up @@ -470,6 +489,28 @@ def add_field_to_selected(self, field_list: list[QModelIndex]):
for field_item in field_list:
self.lib.add_field_to_entry(item_id, field_item.row())

def update_date_label(self, filepath: Path | None = None) -> None:
"""Update the "Date Created" and "Date Modified" file property labels."""
if filepath and filepath.is_file():
created: dt = dt.fromtimestamp(filepath.stat().st_ctime)
modified: dt = dt.fromtimestamp(filepath.stat().st_mtime)
self.date_created_label.setText(
f"<b>Date Created:</b> {dt.strftime(created, "%a, %x, %X")}"
)
self.date_modified_label.setText(
f"<b>Date Modified:</b> {dt.strftime(modified, "%a, %x, %X")}"
)
self.date_created_label.setHidden(False)
self.date_modified_label.setHidden(False)
elif filepath:
self.date_created_label.setText("<b>Date Created:</b> <i>N/A</i>")
self.date_modified_label.setText("<b>Date Modified:</b> <i>N/A</i>")
self.date_created_label.setHidden(False)
self.date_modified_label.setHidden(False)
else:
self.date_created_label.setHidden(True)
self.date_modified_label.setHidden(True)

# def update_widgets(self, item: Union[Entry, Collation, Tag]):
def update_widgets(self):
"""
Expand All @@ -486,11 +527,12 @@ def update_widgets(self):
# 0 Selected Items
if not self.driver.selected:
if self.selected or not self.initialized:
self.file_label.setText("No Items Selected")
self.file_label.setFilePath("")
self.file_label.setText("<i>No Items Selected</i>")
self.file_label.setFilePath(None)
self.file_label.setCursor(Qt.CursorShape.ArrowCursor)

self.dimensions_label.setText("")
self.update_date_label()
self.preview_img.setContextMenuPolicy(
Qt.ContextMenuPolicy.NoContextMenu
)
Expand Down Expand Up @@ -546,7 +588,7 @@ def update_widgets(self):
ratio,
update_on_ratio_change=True,
)
self.file_label.setText("\u200b".join(str(filepath)))
self.file_label.setText(self.file_label.truncate_filepath(filepath))
self.file_label.setCursor(Qt.CursorShape.PointingHandCursor)

self.preview_img.setContextMenuPolicy(
Expand Down Expand Up @@ -675,6 +717,7 @@ def update_widgets(self):
self.dimensions_label.setText(
f"{ext.upper()[1:]} • {format_size(filepath.stat().st_size)}"
)
self.update_date_label(filepath)

if not filepath.is_file():
raise FileNotFoundError
Expand All @@ -684,12 +727,14 @@ def update_widgets(self):
logging.info(
f"[PreviewPanel][ERROR] Couldn't Render thumbnail for {filepath} (because of {e})"
)
self.update_date_label()

except (FileNotFoundError, cv2.error) as e:
self.dimensions_label.setText(f"{ext.upper()[1:]}")
logging.info(
f"[PreviewPanel][ERROR] Couldn't Render thumbnail for {filepath} (because of {e})"
)
self.update_date_label()
except (
UnidentifiedImageError,
DecompressionBombError,
Expand All @@ -700,6 +745,7 @@ def update_widgets(self):
logging.info(
f"[PreviewPanel][ERROR] Couldn't Render thumbnail for {filepath} (because of {e})"
)
self.update_date_label(filepath)

# TODO: Implement a clickable label to use for the GIF preview.
if self.preview_img.is_connected:
Expand Down Expand Up @@ -735,10 +781,13 @@ def update_widgets(self):
self.preview_gif.hide()
self.preview_vid.stop()
self.preview_vid.hide()
self.update_date_label()
if self.selected != self.driver.selected:
self.file_label.setText(f"{len(self.driver.selected)} Items Selected")
self.file_label.setText(
f"<b>{len(self.driver.selected)}</b> Items Selected"
)
self.file_label.setCursor(Qt.CursorShape.ArrowCursor)
self.file_label.setFilePath("")
self.file_label.setFilePath(None)
self.dimensions_label.setText("")

self.preview_img.setContextMenuPolicy(
Expand Down