DlgExportStoryboard Class Reference

#include <DlgExportStoryboard.h>

Inheritance diagram for DlgExportStoryboard:

Public Member Functions
int	columns () const
	DlgExportStoryboard (ExportFormat format, QSharedPointer< StoryboardModel > model)
ExportLayout	exportLayout () const
int	fontSize () const
ExportFormat	format () const
bool	layoutSpecifiedBySvgFile () const
QString	layoutSvgFile () const
QPageLayout::Orientation	pageOrientation () const
QPageSize	pageSize () const
int	rows () const
QString	saveFileName () const
void	setUsableMaximums (QPageSize pPageSize, QPageLayout::Orientation pOrientation, ExportLayout pLayout)
	~DlgExportStoryboard () override
Public Member Functions inherited from KoDialog
QPushButton *	button (ButtonCode id) const
QIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
	KoDialog (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())
QWidget *	mainWidget ()
QSize	minimumSizeHint () const override
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const QIcon &icon)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
QSize	sizeHint () const override
	~KoDialog () override

Private Slots
void	slotExportClicked ()
void	slotLayoutChanged (int state)
void	slotPageSettingsChanged (int)

Private Attributes
QString	m_exportFileName
ExportFormat	m_format
QSharedPointer< StoryboardModel >	m_model
WdgExportStoryboard *	m_page {0}

Additional Inherited Members
Public Types inherited from KoDialog
enum	ButtonCode {   None = 0x00000000 , Help = 0x00000001 , Default = 0x00000002 , Ok = 0x00000004 ,   Apply = 0x00000008 , Try = 0x00000010 , Cancel = 0x00000020 , Close = 0x00000040 ,   No = 0x00000080 , Yes = 0x00000100 , Reset = 0x00000200 , Details = 0x00000400 ,   User1 = 0x00001000 , User2 = 0x00002000 , User3 = 0x00004000 , NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0 , DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0 , AppNameCaption = 1 , ModifiedCaption = 2 , HIGCompliantCaption = AppNameCaption }
Public Slots inherited from KoDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)
Signals inherited from KoDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KoDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()
Static Public Member Functions inherited from KoDialog
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static int	spacingHint ()
Protected Slots inherited from KoDialog
virtual void	slotButtonClicked (int button)
Protected Member Functions inherited from KoDialog
void	closeEvent (QCloseEvent *e) override
void	hideEvent (QHideEvent *) override
void	keyPressEvent (QKeyEvent *) override
void	showEvent (QShowEvent *e) override

Detailed Description

Definition at line 49 of file DlgExportStoryboard.h.

Constructor & Destructor Documentation

DlgExportStoryboard()

DlgExportStoryboard::DlgExportStoryboard	(	ExportFormat	format,
		QSharedPointer< StoryboardModel >	model )

Definition at line 17 of file DlgExportStoryboard.cpp.

        : KoDialog()
        , m_format(format)
        , m_model(model)
{
    m_page = new WdgExportStoryboard(this);
 
    setCaption(format == ExportFormat::PDF
               ? i18nc("Export storyboard dialog caption", "Export Storyboard as PDF")
               : i18nc("Export storyboard dialog caption", "Export Storyboard as SVG"));
 
    setButtons(Apply | Cancel);
    setButtonText(Apply, i18n("Export"));
    setDefaultButton(Apply);
 
    connect(this, SIGNAL(applyClicked()), this, SLOT(slotExportClicked()));
    connect(m_page->boardLayoutComboBox, SIGNAL(activated(int)), this, SLOT(slotLayoutChanged(int)));
    connect(m_page->pageSizeComboBox, SIGNAL(activated(int)), this, SLOT(slotPageSettingsChanged(int)));
    connect(m_page->pageOrientationComboBox, SIGNAL(activated(int)), this, SLOT(slotPageSettingsChanged(int)));
    connect(m_page->rowsSpinBox, SIGNAL(valueChanged(int)), this, SLOT(slotPageSettingsChanged(int)));
    connect(m_page->columnsSpinBox, SIGNAL(valueChanged(int)), this, SLOT(slotPageSettingsChanged(int)));
    connect(m_page->gridRowsSpinBox, SIGNAL(valueChanged(int)), this, SLOT(slotPageSettingsChanged(int)));
    connect(m_page->gridColumnsSpinBox, SIGNAL(valueChanged(int)), this, SLOT(slotPageSettingsChanged(int)));
 
    KisConfig cfg(true);
    m_page->boardLayoutComboBox->setCurrentIndex(cfg.readEntry<int>("storyboard/layoutType", ExportLayout::ROWS));
    m_page->pageOrientationComboBox->setCurrentIndex(cfg.readEntry<int>("storyboard/pageOrientation", 0));
    m_page->rowsSpinBox->setValue(cfg.readEntry<int>("storyboard/rows", 3));
    m_page->columnsSpinBox->setValue(cfg.readEntry<int>("storyboard/columns", 3));
    m_page->fontSizeSpinBox->setValue(cfg.readEntry<int>("storyboard/fontSize", 15));
    m_page->svgTemplatePathFileRequester->setFileName(cfg.readEntry<QString>("storyboard/svgLayoutFileName", ""));
    m_page->exportPathFileRequester->setFileName(cfg.readEntry<QString>("storyboard/exportFilePath"));
    m_page->gridRowsSpinBox->setValue(cfg.readEntry<int>("storyboard/rows", 3));
    m_page->gridColumnsSpinBox->setValue(cfg.readEntry<int>("storyboard/columns", 3));
    
    if (format == ExportFormat::PDF) {
        QStringList mimeTypes;
        mimeTypes << "application/pdf";
        m_page->exportPathFileRequester->setMimeTypeFilters(mimeTypes);
        m_page->exportPathFileRequester->setMode(KoFileDialog::SaveFile);
    }
    else {
        m_page->exportPathFileRequester->setMode(KoFileDialog::OpenDirectory);
    }
 
    QStringList mimeTypes;
    mimeTypes << "image/svg+xml";
    m_page->svgTemplatePathFileRequester->setMimeTypeFilters(mimeTypes);
    m_page->svgTemplatePathFileRequester->setMode(KoFileDialog::OpenFile);
 
    setMainWidget(m_page);
    slotLayoutChanged(m_page->boardLayoutComboBox->currentIndex());
    setUsableMaximums(pageSize(), pageOrientation(), exportLayout());
}

References KoDialog::Apply, KoDialog::applyClicked(), KoDialog::Cancel, exportLayout(), format(), m_page, KoFileDialog::OpenDirectory, KoFileDialog::OpenFile, pageOrientation(), pageSize(), PDF, KisConfig::readEntry(), ROWS, KoFileDialog::SaveFile, KoDialog::setButtons(), KoDialog::setButtonText(), KoDialog::setCaption(), KoDialog::setDefaultButton(), KoDialog::setMainWidget(), setUsableMaximums(), slotExportClicked(), slotLayoutChanged(), and slotPageSettingsChanged().

~DlgExportStoryboard()

DlgExportStoryboard::~DlgExportStoryboard ( )

override

Definition at line 72 of file DlgExportStoryboard.cpp.

{
}

Member Function Documentation

columns()

int DlgExportStoryboard::columns

(

)

const

Definition at line 91 of file DlgExportStoryboard.cpp.

{
    const int layoutIndex = m_page->boardLayoutComboBox->currentIndex();
    if (layoutIndex == ExportLayout::ROWS || layoutIndex == ExportLayout::SVG_TEMPLATE) {
        return 1;
    }
    else if (layoutIndex == ExportLayout::GRID) {
        return qMax(m_page->gridColumnsSpinBox->value(), 1);
    }
    else {
        return qMax(m_page->columnsSpinBox->value(), 1);
    }
}

References GRID, m_page, ROWS, and SVG_TEMPLATE.

exportLayout()

ExportLayout DlgExportStoryboard::exportLayout

(

)

const

Definition at line 153 of file DlgExportStoryboard.cpp.

{
    return static_cast<ExportLayout>(m_page->boardLayoutComboBox->currentIndex());
}

References m_page.

fontSize()

int DlgExportStoryboard::fontSize

(

)

const

Definition at line 158 of file DlgExportStoryboard.cpp.

{
    return m_page->fontSizeSpinBox->value();
}

References m_page.

format()

ExportFormat DlgExportStoryboard::format

(

)

const

Definition at line 148 of file DlgExportStoryboard.cpp.

{
    return m_format;
}

References m_format.

layoutSpecifiedBySvgFile()

bool DlgExportStoryboard::layoutSpecifiedBySvgFile

(

)

const

Definition at line 132 of file DlgExportStoryboard.cpp.

{
    const int layoutIndex = m_page->boardLayoutComboBox->currentIndex();
    return layoutIndex == ExportLayout::SVG_TEMPLATE;
}

References m_page, and SVG_TEMPLATE.

layoutSvgFile()

QString DlgExportStoryboard::layoutSvgFile

(

)

const

Definition at line 138 of file DlgExportStoryboard.cpp.

{
    return m_page->svgTemplatePathFileRequester->fileName();
}

References m_page.

pageOrientation()

QPageLayout::Orientation DlgExportStoryboard::pageOrientation

(

)

const

Definition at line 127 of file DlgExportStoryboard.cpp.

{
    return (QPageLayout::Orientation)m_page->pageOrientationComboBox->currentIndex();
}

References m_page.

pageSize()

QPageSize DlgExportStoryboard::pageSize

(

)

const

Definition at line 105 of file DlgExportStoryboard.cpp.

{
    int index = m_page->pageSizeComboBox->currentIndex();
    switch (index) {
        case 0:
            return QPageSize(QPageSize::PageSizeId::A0);
        case 1:
            return QPageSize(QPageSize::PageSizeId::A1);
        case 2:
            return QPageSize(QPageSize::PageSizeId::A2);
        case 3:
            return QPageSize(QPageSize::PageSizeId::A3);
        case 4:
            return QPageSize(QPageSize::PageSizeId::A4);
        case 5:
            return QPageSize(QPageSize::PageSizeId::A5);
        case 6:
        default:
            return QPageSize(QPageSize::PageSizeId::Letter);
    }
}

References m_page.

rows()

int DlgExportStoryboard::rows

(

)

const

Definition at line 77 of file DlgExportStoryboard.cpp.

{
    const int layoutIndex = m_page->boardLayoutComboBox->currentIndex();
    if (layoutIndex == ExportLayout::COLUMNS || layoutIndex == ExportLayout::SVG_TEMPLATE) {
        return 1;
    }
    else if (layoutIndex == ExportLayout::GRID) {
        return qMax(m_page->gridRowsSpinBox->value(), 1);
    }
    else {
        return qMax(m_page->rowsSpinBox->value(), 1);
    }
}

References COLUMNS, GRID, m_page, and SVG_TEMPLATE.

saveFileName()

QString DlgExportStoryboard::saveFileName

(

)

const

Definition at line 143 of file DlgExportStoryboard.cpp.

{
    return m_page->exportPathFileRequester->fileName();
}

References m_page.

setUsableMaximums()

void DlgExportStoryboard::setUsableMaximums	(	QPageSize	pPageSize,
		QPageLayout::Orientation	pOrientation,
		ExportLayout	pLayout )

Definition at line 163 of file DlgExportStoryboard.cpp.

{
    if (pLayout == ExportLayout::SVG_TEMPLATE) { // Bypass estimates -- We can't really make any educated guess here!
        m_page->fontSizeSpinBox->setMaximum(50);
    } else {
        const QSize pointSize = pPageSize.sizePoints();
        const QSize orientedPointSize = pOrientation == QPageLayout::Landscape ? QSize(pointSize.height(), pointSize.width()) : pointSize;
        const QSize sizeInPointsPerBoard = QSize(orientedPointSize.width() / columns(), orientedPointSize.height() / rows());
 
        const int commentCount = m_model ? qMax(m_model->totalCommentCount(), 1) : 1;
        const bool stacked = sizeInPointsPerBoard.width() < sizeInPointsPerBoard.height();
        const QSize sizeInPointsPerComment = stacked ? QSize(sizeInPointsPerBoard.width(), sizeInPointsPerBoard.height() / commentCount)
                                                     : QSize(sizeInPointsPerBoard.width() / commentCount, sizeInPointsPerBoard.height());
        const QSize usableMaximumFontSize = sizeInPointsPerComment / 12;
        m_page->fontSizeSpinBox->setMaximum(qMin(usableMaximumFontSize.width(), usableMaximumFontSize.height()));
    }
}

References columns(), m_model, m_page, rows(), and SVG_TEMPLATE.

slotExportClicked

void DlgExportStoryboard::slotExportClicked ( )

privateslot

Definition at line 181 of file DlgExportStoryboard.cpp.

{
    if (m_page->exportPathFileRequester->fileName().isEmpty()) {
        if (m_format == ExportFormat::PDF) {
            QMessageBox::warning(this, i18nc("@title:window", "Krita"), i18n("Please enter a file name to export to."));
        }
        else {
            QMessageBox::warning(this, i18nc("@title:window", "Krita"), i18n("Please enter a directory to export to."));
        }
        return;
    }
 
    if (m_format == ExportFormat::SVG) {
 
        QDir dir(m_page->exportPathFileRequester->fileName());
        if (!dir.exists()) {
            QMessageBox::warning(this, i18nc("@title:window", "Krita"), i18n("Please enter an existing directory."));
            return;
        }
 
        QFileInfo info("[0-9]*.svg");
        QStringList filesList = dir.entryList({ info.fileName() });
 
        if (!filesList.isEmpty()) {
            QMessageBox::StandardButton result =
                QMessageBox::warning(0,
                                     i18n("Existing files with similar naming scheme"),
                                     i18n("Files with the same naming "
                                          "scheme exist in the destination "
                                          "directory. They might be "
                                          "deleted, continue?\n\n"
                                          "Directory: %1\n"
                                          "Files: %2",
                                          dir.absolutePath(), filesList.at(0) + "..."),
                                     QMessageBox::Yes | QMessageBox::No,
                                     QMessageBox::No);
            if (result == QMessageBox::No) {
                return;
            }
        }
    }
 
    if (layoutSpecifiedBySvgFile() && m_page->svgTemplatePathFileRequester->fileName().isEmpty()) {
        QMessageBox::warning(this, i18nc("@title:window", "Krita"), i18n("Please choose svg file to specify the layout for exporting."));
        return;
    }
    QFileInfo fi(m_page->svgTemplatePathFileRequester->fileName());
    if (layoutSpecifiedBySvgFile() && !fi.exists()) {
        QMessageBox::warning(this, i18nc("@title:window", "Krita"), i18n("The SVG file to specify layout doesn't exist. Please choose an existing SVG file."));
        return;
    }
 
    KisConfig cfg(false);
    cfg.writeEntry("storyboard/layoutType", m_page->boardLayoutComboBox->currentIndex());
    cfg.writeEntry("storyboard/pageOrientation", m_page->pageOrientationComboBox->currentIndex());
    if (exportLayout() == ExportLayout::GRID) {
        cfg.writeEntry("storyboard/rows", m_page->gridRowsSpinBox->value());
        cfg.writeEntry("storyboard/columns", m_page->gridColumnsSpinBox->value());
    } else {
        cfg.writeEntry("storyboard/rows", m_page->rowsSpinBox->value());
        cfg.writeEntry("storyboard/columns", m_page->columnsSpinBox->value());
    }
    cfg.writeEntry("storyboard/svgLayoutFileName", m_page->svgTemplatePathFileRequester->fileName());
    cfg.writeEntry("storyboard/exportFilePath", m_page->exportPathFileRequester->fileName());
    cfg.writeEntry("storyboard/fontSize", m_page->fontSizeSpinBox->value());
 
    accept();
}

References exportLayout(), GRID, layoutSpecifiedBySvgFile(), m_format, m_page, PDF, SVG, and KisConfig::writeEntry().

slotLayoutChanged

void DlgExportStoryboard::slotLayoutChanged ( int state )

privateslot

Definition at line 250 of file DlgExportStoryboard.cpp.

{
    m_page->rowsLabel->hide();
    m_page->rowsSpinBox->hide();
    m_page->columnsLabel->hide();
    m_page->columnsSpinBox->hide();
    m_page->gridLabel->hide();
    m_page->gridRowsSpinBox->hide();
    m_page->gridColumnsSpinBox->hide();
    m_page->rowsColumnsXLabel->hide();
    m_page->svgTemplatePathLabel->hide();
    m_page->svgTemplatePathFileRequester->hide();
 
    switch (state) {
    case ExportLayout::COLUMNS:
        m_page->columnsLabel->show();
        m_page->columnsSpinBox->show();
        break;
    case ExportLayout::ROWS:
        m_page->rowsLabel->show();
        m_page->rowsSpinBox->show();
        break;
    case ExportLayout::GRID:
        m_page->gridLabel->show();
        m_page->gridRowsSpinBox->show();
        m_page->rowsColumnsXLabel->show();
        m_page->gridColumnsSpinBox->show();
        break;
    case ExportLayout::SVG_TEMPLATE:
        m_page->svgTemplatePathLabel->show();
        m_page->svgTemplatePathFileRequester->show();
        break;
    }
}

References COLUMNS, GRID, m_page, ROWS, and SVG_TEMPLATE.

slotPageSettingsChanged

void DlgExportStoryboard::slotPageSettingsChanged ( int )

privateslot

Definition at line 285 of file DlgExportStoryboard.cpp.

{
    setUsableMaximums(pageSize(), pageOrientation(), exportLayout());
}

References exportLayout(), pageOrientation(), pageSize(), and setUsableMaximums().

Member Data Documentation

m_exportFileName

QString DlgExportStoryboard::m_exportFileName

private

Definition at line 74 of file DlgExportStoryboard.h.

m_format

ExportFormat DlgExportStoryboard::m_format

private

Definition at line 75 of file DlgExportStoryboard.h.

m_model

QSharedPointer<StoryboardModel> DlgExportStoryboard::m_model

private

Definition at line 76 of file DlgExportStoryboard.h.

m_page

WdgExportStoryboard* DlgExportStoryboard::m_page {0}

private

Definition at line 73 of file DlgExportStoryboard.h.

{0};

---

The documentation for this class was generated from the following files:

• plugins/dockers/storyboarddocker/DlgExportStoryboard.h
• plugins/dockers/storyboarddocker/DlgExportStoryboard.cpp