KisTemplatesPane Class Reference

#include <KisTemplatesPane.h>

Inheritance diagram for KisTemplatesPane:

Signals
void	alwaysUseChanged (KisTemplatesPane *sender, const QString &alwaysUse)
	Emitted when the always use checkbox is selected.
Signals inherited from KisDetailsPane
void	openUrl (const QUrl &)
	Emitted when a file is requested to be opened.
void	splitterResized (KisDetailsPane *sender, const QList< int > &sizes)
	This is used to keep all splitters in different details panes synced.

Public Member Functions
bool	isSelected ()
	Returns true if a template in this group was the last one selected.
	KisTemplatesPane (QWidget *parent, const QString &header, KisTemplateGroup *group, KisTemplate *defaultTemplate)
	~KisTemplatesPane () override
Public Member Functions inherited from KisDetailsPane
bool	eventFilter (QObject *watched, QEvent *e) override
	KisDetailsPane (QWidget *parent, const QString &header)
QStandardItemModel *	model () const
	~KisDetailsPane () override

Protected Slots
void	alwaysUseClicked ()
void	changeAlwaysUseTemplate (KisTemplatesPane *sender, const QString &alwaysUse)
void	openFile () override
void	openFile (const QModelIndex &index) override
void	selectionChanged (const QModelIndex &index) override
Protected Slots inherited from KisDetailsPane
void	changePalette ()
virtual void	openFile ()
virtual void	openFile (const QModelIndex &index)=0
virtual void	selectionChanged (const QModelIndex &index)=0
	This is called when the selection in the listview changed.

Private Attributes
KisTemplatesPanePrivate *const	d

Additional Inherited Members
Public Slots inherited from KisDetailsPane
void	resizeSplitter (KisDetailsPane *sender, const QList< int > &sizes)
	This is used to keep all splitters in different details panes synced.
Protected Types inherited from KisDetailsPane
enum	Extents { IconExtent = 64 , PreviewExtent = 128 }

Detailed Description

This widget is the right-side part of the template opening widget. This widget shows a list of templates and can show their details or open it.

Definition at line 20 of file KisTemplatesPane.h.

Constructor & Destructor Documentation

KisTemplatesPane()

KisTemplatesPane::KisTemplatesPane	(	QWidget *	parent,
		const QString &	header,
		KisTemplateGroup *	group,
		KisTemplate *	defaultTemplate )

Constructor.

Parameters

parent	the parent widget
header	string used as header text in the listview
group	the group of templates this widget will show.
defaultTemplate	pointer to the default template. Used to select a template when none has been selected before.

Definition at line 32 of file KisTemplatesPane.cpp.

    : KisDetailsPane(parent,header)
    , d(new KisTemplatesPanePrivate)
{
    setFocusProxy(m_documentList);
 
    KGuiItem openGItem(i18n("Use This Template"));
    KGuiItem::assign(m_openButton, openGItem);
    KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
    QString fullTemplateName = cfgGrp.readPathEntry("FullTemplateName", QString());
 
 
    d->m_alwaysUseTemplate = cfgGrp.readPathEntry("AlwaysUseTemplate", QString());
    m_alwaysUseCheckBox->setVisible(false);
    connect(m_alwaysUseCheckBox, SIGNAL(clicked()), this, SLOT(alwaysUseClicked()));
 
    QStandardItem* selectItem = 0;
    QStandardItem* rootItem = model()->invisibleRootItem();
    QStandardItem* defaultItem = 0;
 
    QFileInfo templateFileInfo(fullTemplateName);
 
    Q_FOREACH (KisTemplate* t, group->templates()) {
        if (t->isHidden())
            continue;
 
        QPixmap preview = t->loadPicture();
        QImage icon = preview.toImage();
        icon = icon.scaled(IconExtent, IconExtent, Qt::KeepAspectRatio, Qt::SmoothTransformation);
        icon.convertTo(QImage::Format_ARGB32);
        icon = icon.copy((icon.width() - IconExtent) / 2, (icon.height() - IconExtent) / 2, IconExtent, IconExtent);
        QStandardItem* item = new QStandardItem(QPixmap::fromImage(icon), t->name());
        item->setEditable(false);
        item->setData(t->description(), Qt::UserRole);
        item->setData(t->file(), Qt::UserRole + 1);
        item->setData(preview, Qt::UserRole + 2);
        rootItem->appendRow(item);
 
        if (templateFileInfo.exists()) {
            if (!selectItem && (t->file() == fullTemplateName)) {
                selectItem = item;
            }
        }
        else {
            if (!selectItem && QFileInfo(t->file()).fileName() == templateFileInfo.fileName()) {
                selectItem = item;
            }
        }
 
        if (defaultTemplate && (t->file() == defaultTemplate->file())) {
            defaultItem = item;
        }
    }
 
    QModelIndex selectedIndex;
 
    if (selectItem) {
        selectedIndex = model()->indexFromItem(selectItem);
        d->m_selected = true;
    } else if (defaultItem) {
        selectedIndex = model()->indexFromItem(defaultItem);
    } else {
        selectedIndex = model()->indexFromItem(model()->item(0));
    }
 
    m_documentList->selectionModel()->select(selectedIndex, QItemSelectionModel::Select);
    m_documentList->selectionModel()->setCurrentIndex(selectedIndex, QItemSelectionModel::Select);
}

References alwaysUseClicked(), connect(), d, KisTemplate::description(), KisTemplate::file(), KisDetailsPane::IconExtent, KisTemplate::isHidden(), KisTemplate::loadPicture(), KisTemplatesPanePrivate::m_alwaysUseTemplate, KisTemplatesPanePrivate::m_selected, KisDetailsPane::model(), KisTemplate::name(), and KisTemplateGroup::templates().

~KisTemplatesPane()

KisTemplatesPane::~KisTemplatesPane ( )

override

Definition at line 102 of file KisTemplatesPane.cpp.

{
    delete d;
}

References d.

Member Function Documentation

alwaysUseChanged

void KisTemplatesPane::alwaysUseChanged ( KisTemplatesPane * sender, const QString & alwaysUse )

signal

Emitted when the always use checkbox is selected.

alwaysUseClicked

void KisTemplatesPane::alwaysUseClicked ( )

protectedslot

Definition at line 146 of file KisTemplatesPane.cpp.

{
    QStandardItem* item = model()->itemFromIndex(m_documentList->selectionModel()->currentIndex());
 
    if (!m_alwaysUseCheckBox->isChecked()) {
        d->m_alwaysUseTemplate.clear();
    } else {
        d->m_alwaysUseTemplate = item->data(Qt::UserRole + 1).toString();
    }
 
    KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
    cfgGrp.writeEntry("AlwaysUseTemplate", d->m_alwaysUseTemplate);
    cfgGrp.sync();
    Q_EMIT alwaysUseChanged(this, d->m_alwaysUseTemplate);
}

References alwaysUseChanged(), d, KisTemplatesPanePrivate::m_alwaysUseTemplate, and KisDetailsPane::model().

changeAlwaysUseTemplate

void KisTemplatesPane::changeAlwaysUseTemplate ( KisTemplatesPane * sender, const QString & alwaysUse )

protectedslot

Definition at line 162 of file KisTemplatesPane.cpp.

{
    if (this == sender)
        return;
 
    QStandardItem* item = model()->itemFromIndex(m_documentList->selectionModel()->currentIndex());
 
    // If the old always use template is selected uncheck the checkbox
    if (item && (item->data(Qt::UserRole + 1).toString() == d->m_alwaysUseTemplate)) {
        m_alwaysUseCheckBox->setChecked(false);
    }
 
    d->m_alwaysUseTemplate = alwaysUse;
}

References d, KisTemplatesPanePrivate::m_alwaysUseTemplate, and KisDetailsPane::model().

isSelected()

bool KisTemplatesPane::isSelected

(

)

Returns true if a template in this group was the last one selected.

Definition at line 141 of file KisTemplatesPane.cpp.

{
    return d->m_selected;
}

References d, and KisTemplatesPanePrivate::m_selected.

openFile [1/2]

void KisTemplatesPane::openFile ( )

overrideprotectedslot

Definition at line 124 of file KisTemplatesPane.cpp.

{
    KisDetailsPane::openFile();
}

References KisDetailsPane::openFile().

openFile [2/2]

void KisTemplatesPane::openFile ( const QModelIndex & index )

overrideprotectedslot

Definition at line 129 of file KisTemplatesPane.cpp.

{
    if (index.isValid()) {
        QStandardItem* item = model()->itemFromIndex(index);
        KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
        cfgGrp.writePathEntry("FullTemplateName", item->data(Qt::UserRole + 1).toString());
        cfgGrp.writeEntry("LastReturnType", "Template");
        cfgGrp.writeEntry("AlwaysUseTemplate", d->m_alwaysUseTemplate);
        Q_EMIT openUrl(QUrl::fromLocalFile(item->data(Qt::UserRole + 1).toString()));
    }
}

References d, KisTemplatesPanePrivate::m_alwaysUseTemplate, KisDetailsPane::model(), and KisDetailsPane::openUrl().

selectionChanged

void KisTemplatesPane::selectionChanged ( const QModelIndex & index )

overrideprotectedslot

Definition at line 107 of file KisTemplatesPane.cpp.

{
    if (index.isValid()) {
        QStandardItem* item = model()->itemFromIndex(index);
        m_openButton->setEnabled(true);
        m_alwaysUseCheckBox->setEnabled(true);
 
        m_detailsLabel->setHtml(item->data(Qt::UserRole).toString());
        m_alwaysUseCheckBox->setChecked(item->data(Qt::UserRole + 1).toString() == d->m_alwaysUseTemplate);
    } else {
        m_openButton->setEnabled(false);
        m_alwaysUseCheckBox->setEnabled(false);
        m_alwaysUseCheckBox->setChecked(false);
        m_detailsLabel->clear();
    }
}

References d, KisTemplatesPanePrivate::m_alwaysUseTemplate, and KisDetailsPane::model().

Member Data Documentation

d

KisTemplatesPanePrivate* const KisTemplatesPane::d

private

Definition at line 53 of file KisTemplatesPane.h.

---

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

• libs/ui/KisTemplatesPane.h
• libs/ui/KisTemplatesPane.cpp