ps6_finder.py

""" Application to launch PySide6 online documentation in the default browser
    for a selected class or Enum.

    Note: window size/position is stored to disk via QSettings class.
"""
import sys
from typing_extensions import override
import webbrowser

from PySide6.QtCore import QPoint, QSize, QSettings
from PySide6.QtGui import QFont, QIcon
from PySide6.QtWidgets import (
    QApplication,
    QFrame,
    QHBoxLayout,
    QLabel,
    QLineEdit,
    QListWidget,
    QListWidgetItem,
    QMainWindow,
    QSizePolicy,
    QVBoxLayout,
    QWidget,
)

from ps6_term_list import TermEntry, PS6TermList

APP_NAME = 'Search PySide6'
APP_DOMAIN = 'resnbl.com'
APP_FONT = QFont('Lato', 14)        # use None for default font
APP_ICON = 'qtforpython.png'


class MainWindow(QMainWindow):
    def __init__(self, parent=None):
        super().__init__(parent=parent)
        self.setWindowTitle(APP_NAME)
        self.settings = self.read_settings(APP_DOMAIN, APP_NAME.replace(' ', ''))

        self.ps6_terms = PS6TermList()
        self.found_terms: list[TermEntry] = []

        # define "changeable" widgets and signal handlers here
        self.search_edt = QLineEdit()
        self.search_edt.textEdited.connect(self.change_search)
        self.term_lst = QListWidget()
        self.term_lst.itemClicked.connect(self.disp_url)
        self.term_lst.itemDoubleClicked.connect(self.launch_url)
        self.url_lbl = QLabel()

        # Layout widgets into main Widget
        widget = QWidget()
        widget.setLayout(self.make_layout())
        self.setCentralWidget(widget)
        self.statusBar().showMessage(self.ps6_terms.stats(), 5000)

    def change_search(self, text: str):
        # Respond to a change in the search field
        self.term_lst.clear()
        self.found_terms = self.ps6_terms.search(text)
        for term in self.found_terms:
            self.term_lst.addItem(term.display)
        self.url_lbl.clear()

    def disp_url(self, item: QListWidgetItem):
        # Term selection -> (partial) URL display
        term = self.found_terms[self.term_lst.row(item)]
        self.url_lbl.setText(term.suffix)

    def launch_url(self, item: QListWidgetItem):
        # Term double-click launches full URL in browser
        term = self.found_terms[self.term_lst.row(item)]
        webbrowser.open_new_tab(self.ps6_terms.make_url(term))

    def make_layout(self):
        # layout and customize widgets here
        layout = QVBoxLayout()

        terms_box = QHBoxLayout()

        entry_box = QVBoxLayout()
        entry_box.addStretch()
        entry_box.addWidget(QLabel('Search class or enum name:'))
        entry_box.addWidget(self.search_edt)
        entry_box.addStretch()
        entry_box.addWidget(QLabel('Selection URL:'))
        terms_box.addLayout(entry_box)

        terms_box.addWidget(QSep(QSep.VER))
        self.term_lst.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.MinimumExpanding)
        terms_box.addWidget(self.term_lst)
        layout.addLayout(terms_box)

        # layout.addWidget(QLabel('Selection URL:'))
        self.url_lbl.setFrameStyle(QFrame.Shape.Panel | QFrame.Shadow.Sunken)
        layout.addWidget(self.url_lbl)

        return layout

    def read_settings(self, app_domain, app_name) -> QSettings:
        settings = QSettings(app_domain, app_name)

        # Restore window size/position
        pos = settings.value('pos')
        if isinstance(pos, QPoint):
            self.move(pos)
        size = settings.value('size')
        if isinstance(size, QSize):
            self.resize(size)

        return settings

    @override
    def closeEvent(self, event):
        # Save window size/position before quitting
        self.settings.setValue('pos', self.pos())
        self.settings.setValue('size', self.size())


class QSep(QFrame):
    """ Helper class for a horizontal or vertical separator """
    HOR = True
    VER = False

    def __init__(self, orientation=HOR, parent=None):
        super().__init__(parent=parent)
        self.setFrameShape(QFrame.Shape.HLine if orientation else QFrame.Shape.VLine)
        self.setFrameShadow(QFrame.Shadow.Sunken)


if __name__ == '__main__':
    app = QApplication(sys.argv)
    if APP_ICON:
        app.setWindowIcon(QIcon(APP_ICON))
    if isinstance(APP_FONT, QFont):
        app.setFont(APP_FONT)
    window = MainWindow()
    window.show()
    app.exec()