Veronica Berglyd Olsen
765 lines
26 KiB
Python
765 lines
26 KiB
Python
"""
|
||
novelWriter – GUI Welcome Dialog
|
||
================================
|
||
|
||
File History:
|
||
Created: 2023-12-14 [2.3b1] GuiWelcome
|
||
|
||
This file is a part of novelWriter
|
||
Copyright (C) 2023 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 datetime import datetime
|
||
from pathlib import Path
|
||
|
||
from PyQt6.QtCore import (
|
||
QAbstractListModel, QModelIndex, QObject, QPoint, QSize, Qt, pyqtSignal,
|
||
pyqtSlot
|
||
)
|
||
from PyQt6.QtGui import QAction, QCloseEvent, QFont, QPainter, QPaintEvent, QPen, QShortcut
|
||
from PyQt6.QtWidgets import (
|
||
QApplication, QFileDialog, QFormLayout, QHBoxLayout, QLabel, QLineEdit,
|
||
QListView, QMenu, QPushButton, QScrollArea, QStackedWidget,
|
||
QStyledItemDelegate, QStyleOptionViewItem, QVBoxLayout, QWidget
|
||
)
|
||
|
||
from novelwriter import CONFIG, SHARED
|
||
from novelwriter.common import formatInt, makeFileNameSafe, qtAddAction, qtLambda
|
||
from novelwriter.constants import nwFiles
|
||
from novelwriter.core.coretools import ProjectBuilder
|
||
from novelwriter.enum import nwItemClass
|
||
from novelwriter.extensions.configlayout import NWrappedWidgetBox
|
||
from novelwriter.extensions.modified import NDialog, NIconToolButton, NSpinBox
|
||
from novelwriter.extensions.switch import NSwitch
|
||
from novelwriter.extensions.versioninfo import VersionInfoWidget
|
||
from novelwriter.types import QtAlignLeft, QtAlignRightTop, QtHexArgb, QtScrollAsNeeded, QtSelected
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
PANEL_ALPHA = 178
|
||
|
||
|
||
class GuiWelcome(NDialog):
|
||
"""GUI: Welcome Dialog.
|
||
|
||
This is the main dialog shown when novelWriter launches or when the
|
||
user wants to create or open another project.
|
||
"""
|
||
|
||
openProjectRequest = pyqtSignal(Path)
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
logger.debug("Create: GuiWelcome")
|
||
self.setObjectName("GuiWelcome")
|
||
|
||
self.setWindowTitle(self.tr("Welcome"))
|
||
self.setMinimumWidth(650)
|
||
self.setMinimumHeight(450)
|
||
self.resize(*CONFIG.welcomeWinSize)
|
||
|
||
btnIconSize = SHARED.theme.buttonIconSize
|
||
|
||
# Elements
|
||
# ========
|
||
|
||
self.bgImage = SHARED.theme.getDecoration("welcome")
|
||
self.nwImage = SHARED.theme.getDecoration("nw-text", h=36)
|
||
|
||
self.nwLogo = QLabel(self)
|
||
self.nwLogo.setPixmap(SHARED.theme.getPixmap("novelwriter", (128, 128)))
|
||
|
||
self.nwLabel = QLabel(self)
|
||
self.nwLabel.setPixmap(self.nwImage)
|
||
|
||
self.nwInfo = VersionInfoWidget(self)
|
||
|
||
self.tabOpen = _OpenProjectPage(self)
|
||
self.tabOpen.openProjectRequest.connect(self._openProjectPath)
|
||
|
||
self.tabNew = _NewProjectPage(self)
|
||
self.tabNew.openProjectRequest.connect(self._openProjectPath)
|
||
|
||
self.mainStack = QStackedWidget(self)
|
||
self.mainStack.addWidget(self.tabOpen)
|
||
self.mainStack.addWidget(self.tabNew)
|
||
|
||
# Buttons
|
||
# =======
|
||
|
||
self.btnList = QPushButton(self.tr("List"), self)
|
||
self.btnList.setIcon(SHARED.theme.getIcon("list", "blue"))
|
||
self.btnList.setIconSize(btnIconSize)
|
||
self.btnList.clicked.connect(self._showOpenProjectPage)
|
||
|
||
self.btnNew = QPushButton(self.tr("New"), self)
|
||
self.btnNew.setIcon(SHARED.theme.getIcon("add", "green"))
|
||
self.btnNew.setIconSize(btnIconSize)
|
||
self.btnNew.clicked.connect(self._showNewProjectPage)
|
||
|
||
self.btnBrowse = QPushButton(self.tr("Browse"), self)
|
||
self.btnBrowse.setIcon(SHARED.theme.getIcon("browse", "yellow"))
|
||
self.btnBrowse.setIconSize(btnIconSize)
|
||
self.btnBrowse.clicked.connect(self._browseForProject)
|
||
|
||
self.btnCancel = QPushButton(self.tr("Cancel"), self)
|
||
self.btnCancel.setIcon(SHARED.theme.getIcon("cancel", "red"))
|
||
self.btnCancel.setIconSize(btnIconSize)
|
||
self.btnCancel.clicked.connect(qtLambda(self.close))
|
||
|
||
self.btnCreate = QPushButton(self.tr("Create"), self)
|
||
self.btnCreate.setIcon(SHARED.theme.getIcon("star", "yellow"))
|
||
self.btnCreate.setIconSize(btnIconSize)
|
||
self.btnCreate.clicked.connect(self.tabNew.createNewProject)
|
||
|
||
self.btnOpen = QPushButton(self.tr("Open"), self)
|
||
self.btnOpen.setIcon(SHARED.theme.getIcon("open", "blue"))
|
||
self.btnOpen.setIconSize(btnIconSize)
|
||
self.btnOpen.clicked.connect(self._openSelectedItem)
|
||
|
||
self.btnBox = QHBoxLayout()
|
||
self.btnBox.addStretch(1)
|
||
self.btnBox.addWidget(self.btnList)
|
||
self.btnBox.addWidget(self.btnNew)
|
||
self.btnBox.addWidget(self.btnBrowse)
|
||
self.btnBox.addWidget(self.btnCancel)
|
||
self.btnBox.addWidget(self.btnCreate)
|
||
self.btnBox.addWidget(self.btnOpen)
|
||
self._setButtonVisibility()
|
||
|
||
# Assemble
|
||
# ========
|
||
|
||
self.innerBox = QVBoxLayout()
|
||
self.innerBox.addSpacing(16)
|
||
self.innerBox.addWidget(self.nwLabel)
|
||
self.innerBox.addWidget(self.nwInfo)
|
||
self.innerBox.addSpacing(8)
|
||
self.innerBox.addWidget(self.mainStack)
|
||
self.innerBox.addSpacing(16)
|
||
self.innerBox.addLayout(self.btnBox)
|
||
|
||
self.outerBox = QHBoxLayout()
|
||
self.outerBox.addWidget(self.nwLogo, 3, QtAlignRightTop)
|
||
self.outerBox.addLayout(self.innerBox, 9)
|
||
self.outerBox.setContentsMargins(128, 48, 24, 48)
|
||
|
||
self.setLayout(self.outerBox)
|
||
self.setSizeGripEnabled(True)
|
||
|
||
logger.debug("Ready: GuiWelcome")
|
||
|
||
def __del__(self) -> None: # pragma: no cover
|
||
logger.debug("Delete: GuiWelcome")
|
||
|
||
##
|
||
# Events
|
||
##
|
||
|
||
def paintEvent(self, event: QPaintEvent) -> None:
|
||
"""Overload the paint event to draw the background image."""
|
||
hWin = self.height()
|
||
hPix = min(hWin, 600)
|
||
tMode = Qt.TransformationMode.SmoothTransformation
|
||
painter = QPainter(self)
|
||
painter.drawPixmap(0, hWin - hPix, self.bgImage.scaledToHeight(hPix, tMode))
|
||
painter.end()
|
||
super().paintEvent(event)
|
||
|
||
def closeEvent(self, event: QCloseEvent) -> None:
|
||
"""Capture the user closing the window and save settings."""
|
||
self._saveSettings()
|
||
event.accept()
|
||
self.softDelete()
|
||
|
||
##
|
||
# Private Slots
|
||
##
|
||
|
||
@pyqtSlot()
|
||
def _showNewProjectPage(self) -> None:
|
||
"""Show the create new project page."""
|
||
self.mainStack.setCurrentWidget(self.tabNew)
|
||
self._setButtonVisibility()
|
||
self.tabNew.enterForm()
|
||
|
||
@pyqtSlot()
|
||
def _showOpenProjectPage(self) -> None:
|
||
"""Show the open exiting project page."""
|
||
self.mainStack.setCurrentWidget(self.tabOpen)
|
||
self._setButtonVisibility()
|
||
|
||
@pyqtSlot()
|
||
def _browseForProject(self) -> None:
|
||
"""Browse for a project to open."""
|
||
if path := SHARED.getProjectPath(self, path=CONFIG.homePath(), allowZip=False):
|
||
self._openProjectPath(path)
|
||
|
||
@pyqtSlot()
|
||
def _openSelectedItem(self) -> None:
|
||
"""Open the currently selected project item."""
|
||
if self.mainStack.currentWidget() == self.tabOpen:
|
||
self.tabOpen.openSelectedItem()
|
||
|
||
@pyqtSlot(Path)
|
||
def _openProjectPath(self, path: Path) -> None:
|
||
"""Emit a project open signal."""
|
||
if isinstance(path, Path):
|
||
# Hide before emitting the open project signal so that any
|
||
# close/backup dialogs don't pop up over it.
|
||
self.hide()
|
||
self.openProjectRequest.emit(path)
|
||
self.close()
|
||
|
||
##
|
||
# Internal Functions
|
||
##
|
||
|
||
def _saveSettings(self) -> None:
|
||
"""Save the user GUI settings."""
|
||
logger.debug("Saving State: GuiWelcome")
|
||
CONFIG.setWelcomeWinSize(self.width(), self.height())
|
||
|
||
def _setButtonVisibility(self) -> None:
|
||
"""Change the visibility of the dialog buttons."""
|
||
listMode = self.mainStack.currentWidget() == self.tabOpen
|
||
self.btnList.setVisible(not listMode)
|
||
self.btnNew.setVisible(listMode)
|
||
self.btnBrowse.setVisible(listMode)
|
||
self.btnCreate.setVisible(not listMode)
|
||
self.btnOpen.setVisible(listMode)
|
||
if listMode:
|
||
self.btnOpen.setFocus()
|
||
else:
|
||
self.btnCreate.setFocus()
|
||
|
||
|
||
class _OpenProjectPage(QWidget):
|
||
|
||
openProjectRequest = pyqtSignal(Path)
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
# List View
|
||
self.listModel = _ProjectListModel(self)
|
||
self.itemDelegate = _ProjectListItem(self)
|
||
|
||
self.listWidget = QListView(self)
|
||
self.listWidget.setItemDelegate(self.itemDelegate)
|
||
self.listWidget.setModel(self.listModel)
|
||
self.listWidget.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
|
||
self.listWidget.clicked.connect(self._projectClicked)
|
||
self.listWidget.doubleClicked.connect(self._projectDoubleClicked)
|
||
self.listWidget.customContextMenuRequested.connect(self._openContextMenu)
|
||
|
||
# Info / Tool
|
||
self.aMissing = QAction(self)
|
||
self.aMissing.setIcon(SHARED.theme.getIcon("alert_warn", "orange"))
|
||
self.aMissing.setToolTip(self.tr("The project path is not reachable."))
|
||
|
||
self.selectedPath = QLineEdit(self)
|
||
self.selectedPath.setReadOnly(True)
|
||
self.selectedPath.addAction(self.aMissing, QLineEdit.ActionPosition.TrailingPosition)
|
||
|
||
self.keyDelete = QShortcut(self)
|
||
self.keyDelete.setKey("Del")
|
||
self.keyDelete.activated.connect(self._deleteSelectedItem)
|
||
|
||
# Assemble
|
||
self.outerBox = QVBoxLayout()
|
||
self.outerBox.addWidget(self.listWidget)
|
||
self.outerBox.addWidget(self.selectedPath)
|
||
self.outerBox.setContentsMargins(0, 0, 0, 0)
|
||
|
||
self.setLayout(self.outerBox)
|
||
|
||
self._selectFirstItem()
|
||
|
||
base = self.palette().base().color()
|
||
base.setAlpha(PANEL_ALPHA)
|
||
baseCol = base.name(QtHexArgb)
|
||
self.setStyleSheet(
|
||
f"QListView {{border: none; background: {baseCol};}} "
|
||
f"QLineEdit {{border: none; background: {baseCol}; padding: 4px;}} "
|
||
)
|
||
|
||
##
|
||
# Public Slots
|
||
##
|
||
|
||
@pyqtSlot()
|
||
def openSelectedItem(self) -> None:
|
||
"""Open the currently selected project item."""
|
||
if (selection := self.listWidget.selectedIndexes()) and (index := selection[0]).isValid():
|
||
self.openProjectRequest.emit(Path(str(index.data()[1])))
|
||
|
||
##
|
||
# Private Slots
|
||
##
|
||
|
||
@pyqtSlot(QModelIndex)
|
||
def _projectClicked(self, index: QModelIndex) -> None:
|
||
"""Process single click on project item."""
|
||
path = self.tr("Path")
|
||
value = index.data()[1] if index.isValid() else ""
|
||
text = f"{path}: {value}"
|
||
self.selectedPath.setText(text)
|
||
self.selectedPath.setToolTip(text)
|
||
self.selectedPath.setCursorPosition(0)
|
||
self.aMissing.setVisible(not (Path(value) / nwFiles.PROJ_FILE).is_file())
|
||
|
||
@pyqtSlot(QModelIndex)
|
||
def _projectDoubleClicked(self, index: QModelIndex) -> None:
|
||
"""Process double click on project item."""
|
||
if index.isValid():
|
||
self.openProjectRequest.emit(Path(str(index.data()[1])))
|
||
|
||
@pyqtSlot()
|
||
def _deleteSelectedItem(self) -> None:
|
||
"""Delete the currently selected project item."""
|
||
if (selection := self.listWidget.selectedIndexes()) and (index := selection[0]).isValid():
|
||
text = self.tr(
|
||
"Remove '{0}' from the recent projects list? "
|
||
"The project files will not be deleted."
|
||
).format(index.data()[0])
|
||
if SHARED.question(text):
|
||
self.listModel.removeEntry(index)
|
||
self._selectFirstItem()
|
||
|
||
@pyqtSlot("QPoint")
|
||
def _openContextMenu(self, pos: QPoint) -> None:
|
||
"""Open the custom context menu."""
|
||
ctxMenu = QMenu(self)
|
||
ctxMenu.setObjectName("ContextMenu") # Used for testing
|
||
action = qtAddAction(ctxMenu, self.tr("Open Project"))
|
||
action.triggered.connect(self.openSelectedItem)
|
||
action = qtAddAction(ctxMenu, self.tr("Remove Project"))
|
||
action.triggered.connect(self._deleteSelectedItem)
|
||
ctxMenu.exec(self.mapToGlobal(pos))
|
||
ctxMenu.setParent(None)
|
||
|
||
##
|
||
# Internal Functions
|
||
##
|
||
|
||
def _selectFirstItem(self) -> None:
|
||
"""Select the first item, if any are available."""
|
||
index = self.listModel.index(0)
|
||
self.listWidget.setCurrentIndex(index)
|
||
self._projectClicked(index)
|
||
|
||
|
||
class _ProjectListItem(QStyledItemDelegate):
|
||
|
||
__slots__ = ("_dFont", "_dPen", "_hPx", "_icon", "_pPx", "_tFont")
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
fPx = SHARED.theme.fontPixelSize
|
||
fPt = SHARED.theme.fontPointSize
|
||
tPx = round(1.2 * fPx)
|
||
iPx = tPx + fPx
|
||
|
||
self._pPx = (iPx + 4, tPx + 4) # Painter coordinates
|
||
self._hPx = 8 + tPx + fPx # Fixed height
|
||
|
||
self._tFont = QApplication.font()
|
||
self._tFont.setPointSizeF(1.2*fPt)
|
||
self._tFont.setWeight(QFont.Weight.Bold)
|
||
|
||
self._dFont = QApplication.font()
|
||
self._dFont.setPointSizeF(fPt)
|
||
self._dPen = QPen(SHARED.theme.helpText)
|
||
|
||
self._icon = SHARED.theme.getPixmap("proj_nwx", (iPx, iPx))
|
||
|
||
def paint(self, painter: QPainter, opt: QStyleOptionViewItem, index: QModelIndex) -> None:
|
||
"""Paint a project entry on the canvas."""
|
||
rect = opt.rect
|
||
title, _, details = index.data()
|
||
tFlag = Qt.TextFlag.TextSingleLine
|
||
x, y = self._pPx
|
||
|
||
painter.save()
|
||
if opt.state & QtSelected == QtSelected:
|
||
painter.setOpacity(0.25)
|
||
painter.fillRect(rect, QApplication.palette().text())
|
||
painter.setOpacity(1.0)
|
||
|
||
painter.drawPixmap(2, rect.top() + 6, self._icon)
|
||
painter.setFont(self._tFont)
|
||
painter.drawText(rect.adjusted(x, 4, 0, 0), tFlag, title)
|
||
painter.setFont(self._dFont)
|
||
painter.setPen(self._dPen)
|
||
painter.drawText(rect.adjusted(x, y, 0, 0), tFlag, details)
|
||
painter.restore()
|
||
|
||
def sizeHint(self, opt: QStyleOptionViewItem, index: QModelIndex) -> QSize:
|
||
"""Set the size hint to fixed height."""
|
||
return QSize(opt.rect.width(), self._hPx)
|
||
|
||
|
||
class _ProjectListModel(QAbstractListModel):
|
||
|
||
def __init__(self, parent: QObject) -> None:
|
||
super().__init__(parent=parent)
|
||
data = []
|
||
words = self.tr("Word Count")
|
||
opened = self.tr("Last Opened")
|
||
records = sorted(CONFIG.recentProjects.listEntries(), key=lambda x: x[3], reverse=True)
|
||
for path, title, count, time in records:
|
||
when = CONFIG.localDate(datetime.fromtimestamp(time))
|
||
data.append((title, path, f"{opened}: {when}, {words}: {formatInt(count)}"))
|
||
self._data = data
|
||
|
||
def rowCount(self, parent: QModelIndex | None = None) -> int:
|
||
"""Return the size of the model."""
|
||
return len(self._data)
|
||
|
||
def data(self, index: QModelIndex, role: int = 0) -> tuple[str, str, str]:
|
||
"""Return data for an individual item."""
|
||
try:
|
||
return self._data[index.row()] if index.isValid() else ("", "", "")
|
||
except IndexError:
|
||
return "", "", ""
|
||
|
||
def removeEntry(self, index: QModelIndex) -> bool:
|
||
"""Remove an entry in the model."""
|
||
if index.isValid() and (path := index.data()[1]):
|
||
try:
|
||
self.beginRemoveRows(index.parent(), index.row(), index.row())
|
||
self._data.pop(index.row())
|
||
self.endRemoveRows()
|
||
except IndexError:
|
||
return False
|
||
CONFIG.recentProjects.remove(path)
|
||
return True
|
||
return False
|
||
|
||
|
||
class _NewProjectPage(QWidget):
|
||
|
||
openProjectRequest = pyqtSignal(Path)
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
# Main Form
|
||
# =========
|
||
|
||
self.projectForm = _NewProjectForm(self)
|
||
|
||
self.scrollArea = QScrollArea(self)
|
||
self.scrollArea.setWidget(self.projectForm)
|
||
self.scrollArea.setWidgetResizable(True)
|
||
self.scrollArea.setHorizontalScrollBarPolicy(QtScrollAsNeeded)
|
||
self.scrollArea.setVerticalScrollBarPolicy(QtScrollAsNeeded)
|
||
|
||
self.enterForm = self.projectForm.enterForm
|
||
|
||
# Assemble
|
||
# ========
|
||
|
||
self.outerBox = QVBoxLayout()
|
||
self.outerBox.addWidget(self.scrollArea)
|
||
self.outerBox.setContentsMargins(0, 0, 0, 0)
|
||
|
||
self.setLayout(self.outerBox)
|
||
|
||
# Styles
|
||
# ======
|
||
|
||
base = self.palette().base().color()
|
||
base.setAlpha(PANEL_ALPHA)
|
||
baseCol = base.name(QtHexArgb)
|
||
self.setStyleSheet(
|
||
f"QScrollArea {{border: none; background: {baseCol};}} "
|
||
f"_NewProjectForm {{border: none; background: {baseCol};}} "
|
||
)
|
||
|
||
##
|
||
# Public Slots
|
||
##
|
||
|
||
@pyqtSlot()
|
||
def createNewProject(self) -> None:
|
||
"""Create a new project from the data in the form."""
|
||
data = self.projectForm.getProjectData()
|
||
if not data.get("name"):
|
||
SHARED.error(self.tr("A project name is required."))
|
||
return
|
||
builder = ProjectBuilder()
|
||
if builder.buildProject(data) and (path := builder.projPath):
|
||
self.openProjectRequest.emit(path)
|
||
return
|
||
|
||
|
||
class _NewProjectForm(QWidget):
|
||
|
||
FILL_BLANK = 0
|
||
FILL_SAMPLE = 1
|
||
FILL_COPY = 2
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
self._basePath = CONFIG.lastPath("project")
|
||
self._fillMode = self.FILL_BLANK
|
||
self._copyPath = None
|
||
|
||
iPx = SHARED.theme.baseIconHeight
|
||
iSz = SHARED.theme.baseIconSize
|
||
|
||
# Project Settings
|
||
# ================
|
||
|
||
# Project Name
|
||
self.projName = QLineEdit(self)
|
||
self.projName.setMaxLength(200)
|
||
self.projName.setPlaceholderText(self.tr("Required"))
|
||
self.projName.textChanged.connect(self._updateProjPath)
|
||
|
||
# Author(s)
|
||
self.projAuthor = QLineEdit(self)
|
||
self.projAuthor.setMaxLength(200)
|
||
self.projAuthor.setPlaceholderText(self.tr("Optional"))
|
||
self.projAuthor.setText(CONFIG.lastAuthor)
|
||
|
||
# Project Path
|
||
self.projPath = QLineEdit(self)
|
||
self.projPath.setReadOnly(True)
|
||
|
||
self.browsePath = NIconToolButton(self, iSz, "browse")
|
||
self.browsePath.clicked.connect(self._doBrowse)
|
||
|
||
self.pathBox = QHBoxLayout()
|
||
self.pathBox.addWidget(self.projPath)
|
||
self.pathBox.addWidget(self.browsePath)
|
||
|
||
# Fill Project
|
||
self.projFill = QLineEdit(self)
|
||
self.projFill.setReadOnly(True)
|
||
|
||
self.browseFill = NIconToolButton(self, iSz, "document_add", "blue")
|
||
|
||
self.fillMenu = QMenu(self.browseFill)
|
||
|
||
self.fillBlank = qtAddAction(self.fillMenu, self.tr("Create a fresh project"))
|
||
self.fillBlank.setIcon(SHARED.theme.getIcon("document"))
|
||
self.fillBlank.triggered.connect(self._setFillBlank)
|
||
|
||
self.fillSample = qtAddAction(self.fillMenu, self.tr("Create an example project"))
|
||
self.fillSample.setIcon(SHARED.theme.getIcon("document_add", "blue"))
|
||
self.fillSample.triggered.connect(self._setFillSample)
|
||
|
||
self.fillCopy = qtAddAction(self.fillMenu, self.tr("Copy an existing project"))
|
||
self.fillCopy.setIcon(SHARED.theme.getIcon("project_copy", "green"))
|
||
self.fillCopy.triggered.connect(self._setFillCopy)
|
||
|
||
self.browseFill.setMenu(self.fillMenu)
|
||
|
||
self.fillBox = QHBoxLayout()
|
||
self.fillBox.addWidget(self.projFill)
|
||
self.fillBox.addWidget(self.browseFill)
|
||
|
||
# Project Form
|
||
self.projectForm = QFormLayout()
|
||
self.projectForm.setAlignment(QtAlignLeft)
|
||
self.projectForm.addRow(self.tr("Project Name"), self.projName)
|
||
self.projectForm.addRow(self.tr("Author"), self.projAuthor)
|
||
self.projectForm.addRow(self.tr("Project Path"), self.pathBox)
|
||
self.projectForm.addRow(self.tr("Prefill Project"), self.fillBox)
|
||
|
||
# Chapters and Scenes
|
||
# ===================
|
||
|
||
self.numChapters = NSpinBox(self)
|
||
self.numChapters.setRange(0, 200)
|
||
self.numChapters.setValue(0)
|
||
self.numChapters.setToolTip(self.tr("Set to 0 to only add scenes"))
|
||
|
||
self.chapterBox = NWrappedWidgetBox(
|
||
self.tr("Add {0} chapter documents"), self.numChapters
|
||
)
|
||
self.chapterBox.addStretch(1)
|
||
|
||
self.numScenes = NSpinBox(self)
|
||
self.numScenes.setRange(0, 200)
|
||
self.numScenes.setValue(0)
|
||
|
||
self.sceneBox = NWrappedWidgetBox(
|
||
self.tr("Add {0} scene documents (to each chapter)"), self.numScenes
|
||
)
|
||
self.sceneBox.addStretch(1)
|
||
|
||
self.novelForm = QVBoxLayout()
|
||
self.novelForm.addLayout(self.chapterBox)
|
||
self.novelForm.addLayout(self.sceneBox)
|
||
|
||
# Project Notes
|
||
# =============
|
||
|
||
self.addPlot = NSwitch(self, height=iPx)
|
||
self.addPlot.setChecked(True)
|
||
self.addPlot.clicked.connect(self._syncSwitches)
|
||
|
||
self.addChar = NSwitch(self, height=iPx)
|
||
self.addChar.setChecked(True)
|
||
self.addChar.clicked.connect(self._syncSwitches)
|
||
|
||
self.addWorld = NSwitch(self, height=iPx)
|
||
self.addWorld.setChecked(False)
|
||
self.addWorld.clicked.connect(self._syncSwitches)
|
||
|
||
self.addNotes = NSwitch(self, height=iPx)
|
||
self.addNotes.setChecked(False)
|
||
|
||
self.notesForm = QFormLayout()
|
||
self.notesForm.setAlignment(QtAlignLeft)
|
||
self.notesForm.addRow(self.tr("Add a folder for plot notes"), self.addPlot)
|
||
self.notesForm.addRow(self.tr("Add a folder for character notes"), self.addChar)
|
||
self.notesForm.addRow(self.tr("Add a folder for location notes"), self.addWorld)
|
||
self.notesForm.addRow(self.tr("Add example notes to the above"), self.addNotes)
|
||
|
||
# Assemble
|
||
# ========
|
||
|
||
self.extraBox = QVBoxLayout()
|
||
self.extraBox.addWidget(QLabel("<b>{0}</b>".format(self.tr("Chapters and Scenes")), self))
|
||
self.extraBox.addLayout(self.novelForm)
|
||
self.extraBox.addSpacing(16)
|
||
self.extraBox.addWidget(QLabel("<b>{0}</b>".format(self.tr("Project Notes")), self))
|
||
self.extraBox.addLayout(self.notesForm)
|
||
self.extraBox.setContentsMargins(0, 0, 0, 0)
|
||
|
||
self.extraWidget = QWidget(self)
|
||
self.extraWidget.setLayout(self.extraBox)
|
||
self.extraWidget.setContentsMargins(0, 0, 0, 0)
|
||
|
||
self.formBox = QVBoxLayout()
|
||
self.formBox.addWidget(QLabel("<b>{0}</b>".format(self.tr("Create New Project")), self))
|
||
self.formBox.addLayout(self.projectForm)
|
||
self.formBox.addSpacing(16)
|
||
self.formBox.addWidget(self.extraWidget)
|
||
self.formBox.addStretch(1)
|
||
|
||
self.setLayout(self.formBox)
|
||
|
||
self._updateProjPath()
|
||
self._updateFillInfo()
|
||
|
||
def enterForm(self) -> None:
|
||
"""Focus the project name field when entering the form."""
|
||
self.projName.setFocus()
|
||
self.projName.selectAll()
|
||
|
||
def getProjectData(self) -> dict:
|
||
"""Collect form data and return it as a dictionary."""
|
||
roots = []
|
||
if self.addPlot.isChecked():
|
||
roots.append(nwItemClass.PLOT)
|
||
if self.addChar.isChecked():
|
||
roots.append(nwItemClass.CHARACTER)
|
||
if self.addWorld.isChecked():
|
||
roots.append(nwItemClass.WORLD)
|
||
return {
|
||
"name": self.projName.text().strip(),
|
||
"author": self.projAuthor.text().strip(),
|
||
"path": self.projPath.text(),
|
||
"blank": self._fillMode == self.FILL_BLANK,
|
||
"sample": self._fillMode == self.FILL_SAMPLE,
|
||
"template": self._copyPath if self._fillMode == self.FILL_COPY else None,
|
||
"chapters": self.numChapters.value(),
|
||
"scenes": self.numScenes.value(),
|
||
"roots": roots,
|
||
"notes": self.addNotes.isChecked(),
|
||
}
|
||
|
||
##
|
||
# Private Slots
|
||
##
|
||
|
||
@pyqtSlot()
|
||
def _doBrowse(self) -> None:
|
||
"""Select a project folder."""
|
||
if path := QFileDialog.getExistingDirectory(
|
||
self, self.tr("Select Project Folder"),
|
||
str(self._basePath), options=QFileDialog.Option.ShowDirsOnly
|
||
):
|
||
self._basePath = Path(path)
|
||
self._updateProjPath()
|
||
CONFIG.setLastPath("project", path)
|
||
|
||
@pyqtSlot()
|
||
def _updateProjPath(self) -> None:
|
||
"""Update the path box to show the full project path."""
|
||
projName = makeFileNameSafe(self.projName.text().strip())
|
||
self.projPath.setText(str(self._basePath / projName))
|
||
|
||
@pyqtSlot()
|
||
def _syncSwitches(self) -> None:
|
||
"""Check if the add notes option should also be switched off."""
|
||
addPlot = self.addPlot.isChecked()
|
||
addChar = self.addChar.isChecked()
|
||
addWorld = self.addWorld.isChecked()
|
||
if not (addPlot or addChar or addWorld):
|
||
self.addNotes.setChecked(False)
|
||
|
||
@pyqtSlot()
|
||
def _setFillBlank(self) -> None:
|
||
"""Set fill mode to blank project."""
|
||
self._fillMode = self.FILL_BLANK
|
||
self._updateFillInfo()
|
||
|
||
@pyqtSlot()
|
||
def _setFillSample(self) -> None:
|
||
"""Set fill mode to sample project."""
|
||
self._fillMode = self.FILL_SAMPLE
|
||
self._updateFillInfo()
|
||
|
||
@pyqtSlot()
|
||
def _setFillCopy(self) -> None:
|
||
"""Set fill mode to copy project."""
|
||
if copyPath := SHARED.getProjectPath(self, allowZip=True):
|
||
self._fillMode = self.FILL_COPY
|
||
self._copyPath = copyPath
|
||
self._updateFillInfo()
|
||
|
||
##
|
||
# Internal Functions
|
||
##
|
||
|
||
def _updateFillInfo(self) -> None:
|
||
"""Update the text of the project fill box."""
|
||
text = ""
|
||
if self._fillMode == self.FILL_BLANK:
|
||
text = self.tr("Fresh Project")
|
||
elif self._fillMode == self.FILL_SAMPLE:
|
||
text = self.tr("Example Project")
|
||
elif self._fillMode == self.FILL_COPY:
|
||
text = self.tr("Template: {0}").format(str(self._copyPath))
|
||
|
||
self.projFill.setText(text)
|
||
self.projFill.setToolTip(text)
|
||
self.projFill.setCursorPosition(0)
|
||
self.extraWidget.setVisible(self._fillMode == self.FILL_BLANK)
|