Veronica Berglyd Olsen
249 lines
8.5 KiB
Python
249 lines
8.5 KiB
Python
"""
|
||
novelWriter – GUI User Wordlist
|
||
===============================
|
||
|
||
File History:
|
||
Created: 2021-02-12 [1.2rc1] GuiWordList
|
||
|
||
This file is a part of novelWriter
|
||
Copyright (C) 2021 Veronica Berglyd Olsen and novelWriter contributors
|
||
|
||
This program is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation, either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful, but
|
||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
""" # noqa
|
||
from __future__ import annotations
|
||
|
||
import logging
|
||
|
||
from pathlib import Path
|
||
from typing import TYPE_CHECKING
|
||
|
||
from PyQt6.QtCore import Qt, pyqtSignal, pyqtSlot
|
||
from PyQt6.QtWidgets import (
|
||
QAbstractItemView, QApplication, QDialogButtonBox, QFileDialog,
|
||
QHBoxLayout, QLineEdit, QListWidget, QVBoxLayout, QWidget
|
||
)
|
||
|
||
from novelwriter import CONFIG, SHARED
|
||
from novelwriter.common import formatFileFilter
|
||
from novelwriter.core.spellcheck import UserDictionary
|
||
from novelwriter.enum import nwStandardButton
|
||
from novelwriter.extensions.configlayout import NColorLabel
|
||
from novelwriter.extensions.modified import NDialog, NIconToolButton
|
||
from novelwriter.types import QtRoleAccept, QtRoleDestruct
|
||
|
||
if TYPE_CHECKING:
|
||
from PyQt6.QtGui import QCloseEvent
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
|
||
class GuiWordList(NDialog):
|
||
"""GUI: User Dictionary Edit Tool."""
|
||
|
||
newWordListReady = pyqtSignal()
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
logger.debug("Create: GuiWordList")
|
||
self.setObjectName("GuiWordList")
|
||
self.setWindowTitle(self.tr("Project Word List"))
|
||
|
||
iSz = SHARED.theme.baseIconSize
|
||
|
||
self.setMinimumWidth(250)
|
||
self.setMinimumHeight(250)
|
||
self.resize(
|
||
SHARED.project.options.getInt("GuiWordList", "winWidth", 320),
|
||
SHARED.project.options.getInt("GuiWordList", "winHeight", 340),
|
||
)
|
||
|
||
# Header
|
||
self.headLabel = NColorLabel(
|
||
self.tr("Project Word List"), self, color=SHARED.theme.helpText,
|
||
scale=NColorLabel.HEADER_SCALE
|
||
)
|
||
|
||
self.importButton = NIconToolButton(self, iSz, "import", "apply")
|
||
self.importButton.setToolTip(self.tr("Import words from text file"))
|
||
self.importButton.clicked.connect(self._importWords)
|
||
|
||
self.exportButton = NIconToolButton(self, iSz, "export", "action")
|
||
self.exportButton.setToolTip(self.tr("Export words to text file"))
|
||
self.exportButton.clicked.connect(self._exportWords)
|
||
|
||
self.headerBox = QHBoxLayout()
|
||
self.headerBox.addWidget(self.headLabel, 1)
|
||
self.headerBox.addWidget(self.importButton, 0)
|
||
self.headerBox.addWidget(self.exportButton, 0)
|
||
|
||
# List Box
|
||
self.listBox = QListWidget(self)
|
||
self.listBox.setDragDropMode(QAbstractItemView.DragDropMode.NoDragDrop)
|
||
self.listBox.setSelectionMode(QAbstractItemView.SelectionMode.ExtendedSelection)
|
||
self.listBox.setSortingEnabled(True)
|
||
|
||
# Add/Remove Form
|
||
self.newEntry = QLineEdit(self)
|
||
|
||
self.addButton = NIconToolButton(self, iSz, "add", "add")
|
||
self.addButton.setToolTip(self.tr("Add Word"))
|
||
self.addButton.clicked.connect(self._doAdd)
|
||
|
||
self.delButton = NIconToolButton(self, iSz, "remove", "remove")
|
||
self.delButton.setToolTip(self.tr("Remove Word"))
|
||
self.delButton.clicked.connect(self._doDelete)
|
||
|
||
self.editBox = QHBoxLayout()
|
||
self.editBox.addWidget(self.newEntry, 1)
|
||
self.editBox.addWidget(self.addButton, 0)
|
||
self.editBox.addWidget(self.delButton, 0)
|
||
|
||
# Buttons
|
||
self.btnSave = SHARED.theme.getStandardButton(nwStandardButton.SAVE, self)
|
||
self.btnSave.clicked.connect(self._doSave)
|
||
|
||
self.btnClose = SHARED.theme.getStandardButton(nwStandardButton.CLOSE, self)
|
||
self.btnClose.clicked.connect(self.reject)
|
||
|
||
self.btnBox = QDialogButtonBox(self)
|
||
self.btnBox.addButton(self.btnSave, QtRoleAccept)
|
||
self.btnBox.addButton(self.btnClose, QtRoleDestruct)
|
||
|
||
# Assemble
|
||
self.outerBox = QVBoxLayout()
|
||
self.outerBox.addLayout(self.headerBox, 0)
|
||
self.outerBox.addWidget(self.listBox, 1)
|
||
self.outerBox.addLayout(self.editBox, 0)
|
||
self.outerBox.addSpacing(12)
|
||
self.outerBox.addWidget(self.btnBox, 0)
|
||
self.outerBox.setSpacing(4)
|
||
|
||
self.setLayout(self.outerBox)
|
||
|
||
self._loadWordList()
|
||
|
||
logger.debug("Ready: GuiWordList")
|
||
|
||
def __del__(self) -> None: # pragma: no cover
|
||
logger.debug("Delete: GuiWordList")
|
||
|
||
##
|
||
# Events
|
||
##
|
||
|
||
def closeEvent(self, event: QCloseEvent) -> None:
|
||
"""Capture the close event and perform cleanup."""
|
||
self._saveGuiSettings()
|
||
event.accept()
|
||
self.softDelete()
|
||
|
||
##
|
||
# Private Slots
|
||
##
|
||
|
||
@pyqtSlot()
|
||
def _doAdd(self) -> None:
|
||
"""Add a new word to the word list."""
|
||
word = self.newEntry.text().strip()
|
||
self.newEntry.setText("")
|
||
self.listBox.clearSelection()
|
||
self._addWord(word)
|
||
if items := self.listBox.findItems(word, Qt.MatchFlag.MatchExactly):
|
||
self.listBox.setCurrentItem(items[0])
|
||
self.listBox.scrollToItem(items[0], QAbstractItemView.ScrollHint.PositionAtCenter)
|
||
|
||
@pyqtSlot()
|
||
def _doDelete(self) -> None:
|
||
"""Delete the selected items."""
|
||
for item in self.listBox.selectedItems():
|
||
self.listBox.takeItem(self.listBox.row(item))
|
||
|
||
@pyqtSlot()
|
||
def _doSave(self) -> None:
|
||
"""Save the new word list and close."""
|
||
userDict = UserDictionary(SHARED.project)
|
||
for word in self._listWords():
|
||
userDict.add(word)
|
||
userDict.save()
|
||
self.newWordListReady.emit()
|
||
QApplication.processEvents()
|
||
self.close()
|
||
|
||
@pyqtSlot()
|
||
def _importWords(self) -> None:
|
||
"""Import words from file."""
|
||
SHARED.info(self.tr(
|
||
"Note: The import file must be a plain text file with UTF-8 or ASCII encoding."
|
||
))
|
||
if path := QFileDialog.getOpenFileName(
|
||
self, self.tr("Import File"), str(CONFIG.homePath()),
|
||
filter=formatFileFilter(["*.txt", "*"]),
|
||
)[0]:
|
||
try:
|
||
with open(path, mode="r", encoding="utf-8") as fo:
|
||
words = set(w.strip() for w in fo.read().split())
|
||
except Exception as exc:
|
||
SHARED.error("Could not read file.", exc=exc)
|
||
return
|
||
for word in words:
|
||
self._addWord(word)
|
||
return
|
||
|
||
@pyqtSlot()
|
||
def _exportWords(self) -> None:
|
||
"""Export words to file."""
|
||
name = f"{SHARED.project.data.fileSafeName} - {self.windowTitle()}.txt"
|
||
if path := QFileDialog.getSaveFileName(
|
||
self, self.tr("Export File"), str(CONFIG.homePath() / name),
|
||
)[0]:
|
||
try:
|
||
path = Path(path).with_suffix(".txt")
|
||
with open(path, mode="w", encoding="utf-8") as fo:
|
||
fo.write("\n".join(self._listWords()))
|
||
except Exception as exc:
|
||
SHARED.error("Could not write file.", exc=exc)
|
||
|
||
##
|
||
# Internal Functions
|
||
##
|
||
|
||
def _loadWordList(self) -> None:
|
||
"""Load the project's word list, if it exists."""
|
||
userDict = UserDictionary(SHARED.project)
|
||
userDict.load()
|
||
self.listBox.clear()
|
||
for word in userDict:
|
||
self.listBox.addItem(word)
|
||
|
||
def _saveGuiSettings(self) -> None:
|
||
"""Save GUI settings."""
|
||
logger.debug("Saving State: GuiWordList")
|
||
pOptions = SHARED.project.options
|
||
pOptions.setValue("GuiWordList", "winWidth", self.width())
|
||
pOptions.setValue("GuiWordList", "winHeight", self.height())
|
||
|
||
def _addWord(self, word: str) -> None:
|
||
"""Add a single word to the list."""
|
||
if word and not self.listBox.findItems(word, Qt.MatchFlag.MatchExactly):
|
||
self.listBox.addItem(word)
|
||
self._changed = True
|
||
|
||
def _listWords(self) -> list[str]:
|
||
"""List all words in the list box."""
|
||
return [
|
||
word for i in range(self.listBox.count())
|
||
if (item := self.listBox.item(i)) and (word := item.text().strip())
|
||
]
|