KisOpenPane Class Reference

#include <KisOpenPane.h>

Inheritance diagram for KisOpenPane:

Signals
void	alwaysUseChanged (KisTemplatesPane *sender, const QString &alwaysUse)
	Emitted when the always use template has changed.
void	cancelButton ()
void	documentSelected (KisDocument *)
	this signal is emitted (as defined by KisDocument) the moment the document is 'ready'
void	openExistingFile (const QUrl &)
void	openTemplate (const QUrl &)
void	splitterResized (KisDetailsPane *sender, const QList< int > &sizes)
	Emitted when one of the detail panes have changed it's splitter.

Public Member Functions
void	addCustomDocumentWidget (QWidget *widget, const QString &title, const QString &untranslatedName, const QString &icon=QString())
QTreeWidgetItem *	addPane (const QString &title, const QString &untranslatedName, const QPixmap &icon, QWidget *widget, int sortWeight)
QTreeWidgetItem *	addPane (const QString &title, const QString &untranslatedName, const QString &iconName, QWidget *widget, int sortWeight)
	KisOpenPane (QWidget *parent, const QStringList &mimeFilter, const QString &templatesResourcePath=QString())
bool	selectItem (const QString &name)
	Selects an option out of the dialog based on its untranslated name.
	~KisOpenPane () override

Protected Slots
void	itemClicked (QTreeWidgetItem *item)
void	saveSplitterSizes (KisDetailsPane *sender, const QList< int > &sizes)
	Saves the splitter sizes for KisDetailsPaneBase based panes.
void	updateSelectedWidget ()

Protected Member Functions
void	dragEnterEvent (QDragEnterEvent *event) override
void	dropEvent (QDropEvent *event) override
void	initTemplates (const QString &templatesResourcePath)

Private Slots
void	openFileDialog ()
	when clicked "Open Existing Document" button
void	slotOpenTemplate (const QUrl &url)

Private Attributes
KisOpenPanePrivate *const	d
QStringList	m_mimeFilter

Detailed Description

Definition at line 25 of file KisOpenPane.h.

Constructor & Destructor Documentation

KisOpenPane()

KisOpenPane::KisOpenPane	(	QWidget *	parent,
		const QStringList &	mimeFilter,
		const QString &	templatesResourcePath = QString() )

Constructor

Parameters

parent	the parent widget.
mimeFilter	the template-type (group) that should be selected on creation.
templatesResourcePath	the path to the templates.

Definition at line 111 of file KisOpenPane.cpp.

    : QDialog(parent)
    , d(new KisOpenPanePrivate)
{
    d->setupUi(this);
 
    m_mimeFilter = mimeFilter;
 
    QStyledItemDelegate* delegate = new QStyledItemDelegate(d->m_sectionList);
    d->m_sectionList->setItemDelegate(delegate);
    QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(d->m_sectionList);
    if (scroller) {
        connect(scroller, &QScroller::stateChanged, this, [&](QScroller::State state) {
            KisKineticScroller::updateCursor(this, state);
        });
    }
 
    connect(d->m_sectionList, SIGNAL(itemSelectionChanged()),
            this, SLOT(updateSelectedWidget()));
    connect(d->m_sectionList, SIGNAL(itemClicked(QTreeWidgetItem*,int)),
            this, SLOT(itemClicked(QTreeWidgetItem*)));
    connect(d->m_sectionList, SIGNAL(itemActivated(QTreeWidgetItem*,int)),
            this, SLOT(itemClicked(QTreeWidgetItem*)));
 
    initTemplates(templatesResourcePath);
 
    d->m_freeCustomWidgetIndex = 4;
 
    if (!d->m_sectionList->selectedItems().isEmpty())
    {
        KoSectionListItem* selectedItem = static_cast<KoSectionListItem*>(d->m_sectionList->selectedItems().first());
 
        if (selectedItem) {
            d->m_widgetStack->widget(selectedItem->widgetIndex())->setFocus();
        }
    }
 
    QList<int> sizes;
 
    // Set the sizes of the details pane splitters
    KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog"); sizes = cfgGrp.readEntry("DetailsPaneSplitterSizes", sizes);
 
    if (!sizes.isEmpty())
        Q_EMIT splitterResized(0, sizes);
 
    connect(this, SIGNAL(splitterResized(KisDetailsPane*,QList<int>)),
            this, SLOT(saveSplitterSizes(KisDetailsPane*,QList<int>)));
 
    setAcceptDrops(true);
}

References KisKineticScroller::createPreconfiguredScroller(), d, initTemplates(), itemClicked(), KisOpenPanePrivate::m_freeCustomWidgetIndex, m_mimeFilter, saveSplitterSizes(), splitterResized(), KisKineticScroller::updateCursor(), updateSelectedWidget(), and KoSectionListItem::widgetIndex().

~KisOpenPane()

KisOpenPane::~KisOpenPane ( )

override

Definition at line 162 of file KisOpenPane.cpp.

{
    if (!d->m_sectionList->selectedItems().isEmpty()) {
        KoSectionListItem* item = dynamic_cast<KoSectionListItem*>(d->m_sectionList->selectedItems().first());
 
        if (item) {
            if (!qobject_cast<KisDetailsPane*>(d->m_widgetStack->widget(item->widgetIndex()))) {
                KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
                cfgGrp.writeEntry("LastReturnType", item->untranslatedName());
            }
        }
    }
 
    delete d;
}

References d, KoSectionListItem::untranslatedName(), and KoSectionListItem::widgetIndex().

Member Function Documentation

addCustomDocumentWidget()

void KisOpenPane::addCustomDocumentWidget	(	QWidget *	widget,
		const QString &	title,
		const QString &	untranslatedName,
		const QString &	icon = QString() )

If the application has a way to create a document not based on a template, but on user provided settings, the widget showing these gets set here.

See also

KisDocument::createCustomDocumentWidget()

Parameters

widget	the widget.
title	the title shown in the sidebar
icon	the icon shown in the sidebar

Definition at line 276 of file KisOpenPane.cpp.

{
    Q_ASSERT(widget);
 
    QTreeWidgetItem* item = addPane(title, untranslatedName, icon, widget, d->m_freeCustomWidgetIndex);
    ++d->m_freeCustomWidgetIndex;
    KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
 
    QString lastActiveItem = cfgGrp.readEntry("LastReturnType");
    bool showCustomItemByDefault = cfgGrp.readEntry("ShowCustomDocumentWidgetByDefault", false);
    if (lastActiveItem == untranslatedName || (lastActiveItem.isEmpty() && showCustomItemByDefault)) {
        d->m_sectionList->setCurrentItem(item, 0, QItemSelectionModel::ClearAndSelect);
        KoSectionListItem* selectedItem = static_cast<KoSectionListItem*>(item);
        d->m_widgetStack->widget(selectedItem->widgetIndex())->setFocus();
    }
}

References addPane(), d, KisOpenPanePrivate::m_freeCustomWidgetIndex, and KoSectionListItem::widgetIndex().

addPane() [1/2]

QTreeWidgetItem * KisOpenPane::addPane	(	const QString &	title,
		const QString &	untranslatedName,
		const QPixmap &	icon,
		QWidget *	widget,
		int	sortWeight )

Definition at line 324 of file KisOpenPane.cpp.

{
    if (!widget) {
        return 0;
    }
 
    int id = d->m_widgetStack->addWidget(widget);
 
    int iconSize = 32;
 
    KoSectionListItem* listItem = new KoSectionListItem(d->m_sectionList, title, untranslatedName, sortWeight, id);
 
    d->m_itemMap->insert(untranslatedName,  listItem);
 
    if (!icon.isNull()) {
        QImage image = icon.toImage();
 
        if (!image.isNull() && ((image.width() > iconSize) || (image.height() > iconSize))) {
            image = image.scaled(iconSize, iconSize, Qt::KeepAspectRatio, Qt::SmoothTransformation);
        }
 
        image.convertTo(QImage::Format_ARGB32);
        image = image.copy((image.width() - iconSize) / 2, (image.height() - iconSize) / 2, iconSize, iconSize);
        listItem->setIcon(0, QIcon(QPixmap::fromImage(image)));
    }
 
    return listItem;
}

References d, iconSize(), and KisOpenPanePrivate::m_itemMap.

addPane() [2/2]

QTreeWidgetItem * KisOpenPane::addPane	(	const QString &	title,
		const QString &	untranslatedName,
		const QString &	iconName,
		QWidget *	widget,
		int	sortWeight )

Definition at line 303 of file KisOpenPane.cpp.

{
    if (!widget) {
        return 0;
    }
 
    int id = d->m_widgetStack->addWidget(widget);
    KoSectionListItem* listItem = new KoSectionListItem(d->m_sectionList, title, untranslatedName, sortWeight, id);
 
    d->m_itemMap->insert(untranslatedName,  (QTreeWidgetItem*)listItem);
 
    // resizes icons so they are a bit smaller
    QIcon icon = KisIconUtils::loadIcon(iconName);
    QPixmap iconPixmap = icon.pixmap(32, 32);
 
    QIcon finalIcon(iconPixmap);
    listItem->setIcon(0, finalIcon);
 
    return listItem;
}

References d, KisIconUtils::loadIcon(), and KisOpenPanePrivate::m_itemMap.

alwaysUseChanged

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

signal

Emitted when the always use template has changed.

cancelButton

void KisOpenPane::cancelButton ( )

signal

documentSelected

void KisOpenPane::documentSelected ( KisDocument * )

signal

this signal is emitted (as defined by KisDocument) the moment the document is 'ready'

dragEnterEvent()

void KisOpenPane::dragEnterEvent ( QDragEnterEvent * event )

overrideprotected

Definition at line 258 of file KisOpenPane.cpp.

{
    if (event->mimeData()->hasUrls()) {
        event->accept();
    }
}

dropEvent()

void KisOpenPane::dropEvent ( QDropEvent * event )

overrideprotected

Definition at line 265 of file KisOpenPane.cpp.

{
    if (event->mimeData()->hasUrls() && event->mimeData()->urls().size() > 0) {
        // XXX: when the MVC refactoring is done, this can open a bunch of
        //      urls, but since the part/document combination is still 1:1
        //      that won't work for now.
        Q_EMIT openExistingFile(event->mimeData()->urls().first());
 
    }
}

References openExistingFile().

initTemplates()

void KisOpenPane::initTemplates ( const QString & templatesResourcePath )

protected

Populate the list with all templates the user can choose.

Parameters

templatesResourcePath

the template-type (group) that should be selected on creation.

Definition at line 198 of file KisOpenPane.cpp.

{
    QTreeWidgetItem* selectItem = 0;
    QTreeWidgetItem* firstItem = 0;
    const int templateOffset = 1000;
 
    if (!templatesResourcePath.isEmpty()) {
        KisTemplateTree templateTree(templatesResourcePath, true);
 
        Q_FOREACH (KisTemplateGroup *group, templateTree.groups()) {
            if (group->isHidden()) {
                continue;
            }
 
            if (!d->m_templatesSeparator) {
                d->m_templatesSeparator = new KoSectionListItem(d->m_sectionList, "", "", 999);
            }
 
            KisTemplatesPane* pane = new KisTemplatesPane(this, group->name(),
                                                          group, templateTree.defaultTemplate());
            connect(pane, SIGNAL(openUrl(QUrl)), this, SLOT(slotOpenTemplate(QUrl)));
            connect(pane, SIGNAL(alwaysUseChanged(KisTemplatesPane*,QString)),
                    this, SIGNAL(alwaysUseChanged(KisTemplatesPane*,QString)));
            connect(this, SIGNAL(alwaysUseChanged(KisTemplatesPane*,QString)),
                    pane, SLOT(changeAlwaysUseTemplate(KisTemplatesPane*,QString)));
            connect(pane, SIGNAL(splitterResized(KisDetailsPane*,QList<int>)),
                    this, SIGNAL(splitterResized(KisDetailsPane*,QList<int>)));
            connect(this, SIGNAL(splitterResized(KisDetailsPane*,QList<int>)),
                    pane, SLOT(resizeSplitter(KisDetailsPane*,QList<int>)));
            QTreeWidgetItem* item = addPane(group->name(), "Template", group->templates().first()->loadPicture(),
                                            pane, group->sortingWeight() + templateOffset);
 
 
 
            if (!firstItem) {
                firstItem = item;
            }
 
            if (group == templateTree.defaultGroup()) {
                firstItem = item;
            }
 
            if (pane->isSelected()) {
                selectItem = item;
            }
        }
    } else {
        firstItem = d->m_sectionList->topLevelItem(0);
    }
 
    KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
 
    if (selectItem && (cfgGrp.readEntry("LastReturnType") == "Template")) {
        d->m_sectionList->setCurrentItem(selectItem, 0, QItemSelectionModel::ClearAndSelect);
    }
    else if (d->m_sectionList->selectedItems().isEmpty() && firstItem) {
        d->m_sectionList->setCurrentItem(firstItem, 0, QItemSelectionModel::ClearAndSelect);
    }
}

References addPane(), alwaysUseChanged(), d, KisTemplateTree::defaultGroup(), KisTemplateTree::defaultTemplate(), KisTemplateTree::groups(), KisTemplateGroup::isHidden(), KisTemplatesPane::isSelected(), KisOpenPanePrivate::m_templatesSeparator, KisTemplateGroup::name(), selectItem(), slotOpenTemplate(), KisTemplateGroup::sortingWeight(), splitterResized(), and KisTemplateGroup::templates().

itemClicked

void KisOpenPane::itemClicked ( QTreeWidgetItem * item )

protectedslot

Definition at line 373 of file KisOpenPane.cpp.

{
    KoSectionListItem* selectedItem = static_cast<KoSectionListItem*>(item);
 
    if (selectedItem && selectedItem->widgetIndex() >= 0) {
        d->m_widgetStack->widget(selectedItem->widgetIndex())->setFocus();
    }
}

References d, and KoSectionListItem::widgetIndex().

openExistingFile

void KisOpenPane::openExistingFile ( const QUrl & )

signal

openFileDialog

void KisOpenPane::openFileDialog ( )

privateslot

when clicked "Open Existing Document" button

Definition at line 180 of file KisOpenPane.cpp.

{
 
    KoFileDialog dialog(this, KoFileDialog::OpenFiles, "OpenDocument");
    dialog.setCaption(i18n("Open Existing Document"));
    dialog.setDefaultDir(QStandardPaths::writableLocation(QStandardPaths::PicturesLocation));
    dialog.setMimeTypeFilters(m_mimeFilter);
    Q_FOREACH (const QString &filename, dialog.filenames()) {
        Q_EMIT openExistingFile(QUrl::fromUserInput(filename));
    }
}

References m_mimeFilter, openExistingFile(), and KoFileDialog::OpenFiles.

openTemplate

void KisOpenPane::openTemplate ( const QUrl & )

signal

saveSplitterSizes

void KisOpenPane::saveSplitterSizes ( KisDetailsPane * sender, const QList< int > & sizes )

protectedslot

Saves the splitter sizes for KisDetailsPaneBase based panes.

Definition at line 366 of file KisOpenPane.cpp.

{
    Q_UNUSED(sender);
    KConfigGroup cfgGrp( KSharedConfig::openConfig(), "TemplateChooserDialog");
    cfgGrp.writeEntry("DetailsPaneSplitterSizes", sizes);
}

selectItem()

bool KisOpenPane::selectItem

(

const QString &

name

)

Selects an option out of the dialog based on its untranslated name.

Definition at line 293 of file KisOpenPane.cpp.

{
    QTreeWidgetItem* item =  d->m_itemMap->value(name, nullptr);
    if (!item) return false;
 
    d->m_sectionList->setCurrentItem(item);
    return true;
}

References d, and KisOpenPanePrivate::m_itemMap.

slotOpenTemplate

void KisOpenPane::slotOpenTemplate ( const QUrl & url )

privateslot

Definition at line 192 of file KisOpenPane.cpp.

{
    Q_EMIT openTemplate(url);
    accept();
}

References openTemplate().

splitterResized

void KisOpenPane::splitterResized ( KisDetailsPane * sender, const QList< int > & sizes )

signal

Emitted when one of the detail panes have changed it's splitter.

updateSelectedWidget

void KisOpenPane::updateSelectedWidget ( )

protectedslot

Definition at line 353 of file KisOpenPane.cpp.

{
    if(!d->m_sectionList->selectedItems().isEmpty())
    {
        KoSectionListItem* section = dynamic_cast<KoSectionListItem*>(d->m_sectionList->selectedItems().first());
 
        if (!section)
            return;
 
        d->m_widgetStack->setCurrentIndex(section->widgetIndex());
    }
}

References d, and KoSectionListItem::widgetIndex().

Member Data Documentation

d

KisOpenPanePrivate* const KisOpenPane::d

private

Definition at line 97 of file KisOpenPane.h.

m_mimeFilter

QStringList KisOpenPane::m_mimeFilter

private

Definition at line 95 of file KisOpenPane.h.

---

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

• libs/ui/KisOpenPane.h
• libs/ui/KisOpenPane.cpp