#include <KisResourceItemChooser.h>

Inheritance diagram for KisResourceItemChooser:

Public Types
enum	Buttons { Button_Import , Button_Remove }

enum class	Layout { NotSet , Vertical , Horizontal2Rows , Horizontal1Row }

Public Slots
void	slotButtonClicked (int button)

void	slotScrollerStateChanged (QScroller::State state)

void	updateView ()

Signals
void	listViewModeChanged (ListViewMode newViewMode)
	Emitted when the view mode for the internal KisResourceItemListView changes.

void	resourceClicked (KoResourceSP resource)

void	resourceSelected (KoResourceSP resource)
	Emitted when a resource was selected.

Public Member Functions
KoResourceSP	currentResource (bool includeHidden=false) const
	Gets the currently selected resource.

bool	eventFilter (QObject object, QEvent event) override
	Allows zooming with Ctrl + Mouse Wheel.

KisResourceItemListView *	itemView () const

	KisResourceItemChooser (const QString &resourceType, bool usePreview=false, QWidget *parent=0)

	Private (QString _resourceType)

bool	restoreSplitterState (Layout layout)

void	setColumnWidth (int columnWidth)
	Sets the width of the view columns.

void	setCurrentItem (int row)

void	setCurrentResource (KoResourceSP resource)
	Sets the item representing the resource as selected.

void	setCurrentResource (QString resourceName)

void	setGrayscalePreview (bool grayscale)
	shows the preview converted to grayscale

void	setItemDelegate (QAbstractItemDelegate *delegate)
	Sets a custom delegate for the view.

void	setListViewMode (ListViewMode viewMode)

void	setPreviewOrientation (Qt::Orientation orientation)
	determines whether the preview right or below the splitter

void	setPreviewTiled (bool tiled)
	determines whether the preview should tile the resource's image or not

void	setResponsiveness (bool isResponsive)

void	setRowHeight (int rowHeight)
	Sets the height of the view rows.

void	setSynced (bool sync)

void	showImportExportBtns (bool show)

void	showStorageBtn (bool visible)

void	showTaggingBar (bool show)

void	showViewModeBtn (bool visible)

KisTagFilterResourceProxyModel *	tagFilterModel () const

KisPopupButton *	viewModeButton () const

QSize	viewSize () const
	View size for the resources view.

	~KisResourceItemChooser () override

Public Attributes
QHBoxLayout *	bot {0}

QButtonGroup *	buttonGroup {0}

KoResourceSP	currentResource

QList< QAbstractButton * >	customButtons

QToolButton *	deleteButton {0}

bool	grayscalePreview {false}

QSplitter *	horzSplitter {0}

QToolButton *	importButton {0}

QFrame *	importExportBtns {0}

bool	isResponsive = false

Layout	layout = Layout::NotSet

QFrame *	left {0}

QLabel *	previewLabel {0}

QScrollArea *	previewScroller {0}

ListViewMode	requestedViewMode = ListViewMode::IconGrid

QSplitter *	resourcesSplitter {0}

QString	resourceType

QFrame *	right {0}

QFrame *	right2Rows {0}

QToolButton *	scroll_left {0}

QToolButton *	scroll_right {0}

bool	showStoragePopupBtn = true

bool	showViewModeBtn = true

KisStorageChooserWidget *	storagePopupButton {0}

bool	synced {false}

KisTagFilterResourceProxyModel *	tagFilterProxyModel {0}

KisResourceTaggingManager *	tagManager {0}

bool	tiledPreview {false}

QHBoxLayout *	top {0}

bool	updatesBlocked {false}

bool	usePreview {false}

KisResourceItemListView *	view {0}

KisPopupButton *	viewModeButton {0}

Protected Member Functions
void	resizeEvent (QResizeEvent *event) override

void	showEvent (QShowEvent *event) override

Private Slots
void	activate (const QModelIndex &index)

void	afterFilterChanged ()

void	baseLengthChanged (int length)

void	clicked (const QModelIndex &index)

void	contextMenuRequested (const QPoint &pos)

void	scrollBackwards ()

void	scrollForwards ()

void	slotSaveSplitterState ()

Private Member Functions
void	applyVerticalLayout ()

void	changeLayoutBasedOnSize ()

void	hideEverything ()

KoResourceSP	resourceFromModelIndex (const QModelIndex &index) const

void	updateButtonState ()

void	updatePreview (const QModelIndex &idx)

Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

A widget that contains a KisResourceItemListView with filters for resource and tags.

Definition at line 56 of file KisResourceItemChooser.cpp.

Member Enumeration Documentation

◆ Buttons

enum KisResourceItemChooser::Buttons

Enumerator
Button_Import
Button_Remove

Definition at line 45 of file KisResourceItemChooser.h.

45{ Button_Import, Button_Remove };

KisResourceItemChooser::Button_Import

@ Button_Import

Definition KisResourceItemChooser.h:45

KisResourceItemChooser::Button_Remove

@ Button_Remove

Definition KisResourceItemChooser.h:45

◆ Layout

enum class KisResourceItemChooser::Layout

strong

Enumerator
NotSet
Vertical
Horizontal2Rows
Horizontal1Row

Definition at line 46 of file KisResourceItemChooser.h.

                      {
        NotSet,
        Vertical,
        Horizontal2Rows,
        Horizontal1Row
    };

Constructor & Destructor Documentation

◆ KisResourceItemChooser()

KisResourceItemChooser::KisResourceItemChooser	(	const QString &	resourceType,
		bool	usePreview = false,
		QWidget *	parent = 0 )

explicit

Parameters

resourceType	Type of resource to choose from.
usePreview	Displays the selected resource icon to the right side of the resources view. It looks bad, should be deleted.

Definition at line 115 of file KisResourceItemChooser.cpp.

    : QWidget(parent)
    , d(new Private(resourceType))
{
    // Tag manager
    d->tagFilterProxyModel = new KisTagFilterResourceProxyModel(resourceType, this);
    d->tagFilterProxyModel->sort(Qt::DisplayRole);
    d->tagManager = new KisResourceTaggingManager(resourceType, d->tagFilterProxyModel, this);
 
    // Viewmode button
    d->viewModeButton = new KisPopupButton(this);
    d->viewModeButton->setToolTip(i18n("Display settings"));
    d->viewModeButton->setVisible(false);
    d->viewModeButton->setArrowVisible(false);
    d->viewModeButton->setAutoRaise(true);
 
    // Storage button
    d->storagePopupButton = new KisStorageChooserWidget(resourceType, this);
    d->storagePopupButton->setToolTip(i18n("Storage Resources"));
    d->storagePopupButton->setAutoRaise(true);
    d->storagePopupButton->setArrowVisible(false);
 
    // Resource List View
    d->view = new KisResourceItemListView(this);
    d->view->setObjectName("ResourceItemview");
    d->view->setStrictSelectionMode(true);
 
    if (d->resourceType == ResourceType::Gradients) {
        d->view->setFixedToolTipThumbnailSize(QSize(256, 64));
        d->view->setToolTipShouldRenderCheckers(true);
    }
    else if (d->resourceType == ResourceType::PaintOpPresets) {
        d->view->setFixedToolTipThumbnailSize(QSize(128, 128));
    }
    else if (d->resourceType == ResourceType::Patterns || d->resourceType == ResourceType::Palettes) {
        d->view->setToolTipShouldRenderCheckers(false);
        d->view->setFixedToolTipThumbnailSize(QSize(256, 256));
    }
 
    d->view->setItemDelegate(new KisResourceItemDelegate(this));
    d->view->setSelectionMode(QAbstractItemView::SingleSelection);
    d->view->viewport()->installEventFilter(this);
    d->view->setModel(d->tagFilterProxyModel);
 
    connect(d->tagFilterProxyModel, SIGNAL(afterFilterChanged()), this, SLOT(afterFilterChanged()));
 
    connect(d->view, SIGNAL(currentResourceChanged(QModelIndex)), this, SLOT(activate(QModelIndex)));
    connect(d->view, SIGNAL(currentResourceClicked(QModelIndex)), this, SLOT(clicked(QModelIndex)));
    connect(d->view, SIGNAL(contextMenuRequested(QPoint)), this, SLOT(contextMenuRequested(QPoint)));
    connect(d->view, SIGNAL(sigSizeChanged()), this, SLOT(updateView()));
 
    // Splitter with resource views and preview scroller
    d->resourcesSplitter = new QSplitter(this);
    d->resourcesSplitter->addWidget(d->view);
    d->resourcesSplitter->setStretchFactor(0, 1);
 
    d->usePreview = usePreview;
    if (d->usePreview) {
        d->previewScroller = new QScrollArea(this);
        d->previewScroller->setWidgetResizable(true);
        d->previewScroller->setBackgroundRole(QPalette::Dark);
        d->previewScroller->setVisible(true);
        d->previewScroller->setAlignment(Qt::AlignCenter);
        d->previewLabel = new QLabel(this);
        d->previewScroller->setWidget(d->previewLabel);
        d->resourcesSplitter->addWidget(d->previewScroller);
 
        if (d->resourcesSplitter->count() == 2) {
            d->resourcesSplitter->setSizes(QList<int>() << 280 << 160);
        }
 
        QScroller* scroller = KisKineticScroller::createPreconfiguredScroller(d->previewScroller);
        if (scroller) {
            connect(scroller, SIGNAL(stateChanged(QScroller::State)), this, SLOT(slotScrollerStateChanged(QScroller::State)));
        }
    }
 
    // Import and Export buttons
    d->importButton = new QToolButton(this);
    d->importButton->setToolTip(i18nc("@info:tooltip", "Import resource"));
    d->importButton->setAutoRaise(true);
    d->importButton->setEnabled(true);
 
    d->deleteButton = new QToolButton(this);
    d->deleteButton->setToolTip(i18nc("@info:tooltip", "Delete resource"));
    d->deleteButton->setEnabled(false);
    d->deleteButton->setAutoRaise(true);
 
    d->buttonGroup = new QButtonGroup(this);
    d->buttonGroup->setExclusive(false);
    d->buttonGroup->addButton(d->importButton, Button_Import);
    d->buttonGroup->addButton(d->deleteButton, Button_Remove);
    connect(d->buttonGroup, SIGNAL(idClicked(int)), this, SLOT(slotButtonClicked(int)));
 
    d->importExportBtns = new QFrame(this);  
    QHBoxLayout* importExportLayout = new QHBoxLayout(d->importExportBtns);
    importExportLayout->setAlignment(Qt::AlignmentFlag::AlignLeft);
    importExportLayout->setContentsMargins(0, 0, 0, 0);
    importExportLayout->addWidget(d->importButton);
    importExportLayout->addWidget(d->deleteButton);
 
    auto removePadding = [](QLayout* layout) {
        layout->setContentsMargins(0, 0, 0, 0);
        layout->setSpacing(0);
    };
 
    // Layout
    QGridLayout* thisLayout = new QGridLayout(this);
    thisLayout->setObjectName("ResourceChooser this");
    removePadding(thisLayout);
 
    // Horizontal Layout
    {
        // Splitter
        d->horzSplitter = new QSplitter(this);
        d->horzSplitter->setOrientation(Qt::Orientation::Horizontal);
        connect(d->horzSplitter, SIGNAL(splitterMoved(int, int)), this, SLOT(slotSaveSplitterState()));
 
        // Horizontal 1 row
        d->left = new QFrame(this);
        QSizePolicy newPolicy = d->left->sizePolicy();
        newPolicy.setHorizontalStretch(2);
        d->left->setSizePolicy(newPolicy);
        QHBoxLayout* leftLayout = new QHBoxLayout(d->left);
        leftLayout->setObjectName("ResourceChooser left");
 
        d->right = new QFrame(this);
        newPolicy = d->right->sizePolicy();
        newPolicy.setHorizontalStretch(0);
        d->right->setSizePolicy(newPolicy);
        QHBoxLayout* rightLayout = new QHBoxLayout(d->right);
        rightLayout->setObjectName("ResourceChooser right");
 
        // Horizontal 2 rows
        d->right2Rows = new QFrame(this);
        newPolicy = d->right2Rows->sizePolicy();
        newPolicy.setHorizontalStretch(0);
        d->right2Rows->setSizePolicy(newPolicy);
        QVBoxLayout* rightLayout2 = new QVBoxLayout(d->right2Rows);
        rightLayout2->setObjectName("ResourceChooser right 2 rows");
 
        d->top = new QHBoxLayout();
        d->bot = new QHBoxLayout();
        rightLayout2->addLayout(d->top);
        rightLayout2->addLayout(d->bot);
 
        // Common style
        removePadding(leftLayout);
        removePadding(rightLayout);
        removePadding(rightLayout2);
        removePadding(d->top);
        removePadding(d->bot);
 
        // Scroll buttons
        d->scroll_left = new QToolButton(this);
        d->scroll_left->setIcon(KisIconUtils::loadIcon("draw-arrow-back"));
        connect(d->scroll_left, &QToolButton::clicked, this, &KisResourceItemChooser::scrollBackwards);
        d->scroll_right = new QToolButton(this);
        d->scroll_right->setIcon(KisIconUtils::loadIcon("draw-arrow-forward"));
        connect(d->scroll_right, &QToolButton::clicked, this, &KisResourceItemChooser::scrollForwards);
 
        // Hide
        d->scroll_left->hide();
        d->scroll_right->hide();
        d->left->hide();
        d->right->hide();
        d->right2Rows->hide();
        d->horzSplitter->hide();
    }
 
    // Other
    updateView();
 
    // Default Configuration
    updateButtonState();
    showViewModeBtn(false);
    showTaggingBar(false);
    showImportExportBtns(true);
    applyVerticalLayout();
}

References activate(), afterFilterChanged(), applyVerticalLayout(), Button_Import, Button_Remove, clicked(), contextMenuRequested(), KisKineticScroller::createPreconfiguredScroller(), d, ResourceType::Gradients, layout, KisIconUtils::loadIcon(), ResourceType::PaintOpPresets, ResourceType::Palettes, ResourceType::Patterns, resourceType, scrollBackwards(), scrollForwards(), showImportExportBtns(), showTaggingBar(), showViewModeBtn, slotButtonClicked(), slotSaveSplitterState(), slotScrollerStateChanged(), updateButtonState(), updateView(), and usePreview.

◆ ~KisResourceItemChooser()

KisResourceItemChooser::~KisResourceItemChooser ( )

override

Definition at line 296 of file KisResourceItemChooser.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ activate

void KisResourceItemChooser::activate ( const QModelIndex & index )

privateslot

Definition at line 499 of file KisResourceItemChooser.cpp.

{
    if (!index.isValid())
    {
        updateButtonState();
        return;
    }
 
    KoResourceSP resource = resourceFromModelIndex(index);
 
    if (resource && resource->valid()) {
        if (resource != d->currentResource) {
            d->currentResource = resource;
            d->updatesBlocked = true;
            Q_EMIT resourceSelected(resource);
            d->updatesBlocked = false;
        }
        updatePreview(index);
        updateButtonState();
    }
}

References d, resourceFromModelIndex(), resourceSelected(), updateButtonState(), and updatePreview().

◆ afterFilterChanged

void KisResourceItemChooser::afterFilterChanged ( )

privateslot

Definition at line 656 of file KisResourceItemChooser.cpp.

{
    // Note: Item model reset events silently reset the view's selection model too.
    // This currently only covers models resets as part of filter changes.
    QModelIndex idx = d->tagFilterProxyModel->indexForResource(d->currentResource);
 
    if (idx.isValid()) {
        d->view->setCurrentIndex(idx);
    }
 
    updateButtonState();
}

References d, and updateButtonState().

◆ applyVerticalLayout()

void KisResourceItemChooser::applyVerticalLayout ( )

private

Definition at line 713 of file KisResourceItemChooser.cpp.

{
    if (d->layout == Layout::Vertical) {
        return;
    }
 
    hideEverything();
 
    d->view->setListViewMode(d->requestedViewMode);
    Q_EMIT listViewModeChanged(d->requestedViewMode);
 
    // The horizontal layouts size the items based widget height not user configured base length
    // so it needs to be restored when switching back to vertical layout
    KisResourceItemChooserSync *chooserSync = KisResourceItemChooserSync::instance();
    d->view->setItemSize(QSize(chooserSync->baseLength(), chooserSync->baseLength()));
 
    QGridLayout* thisLayout = dynamic_cast<QGridLayout*>(layout());
    thisLayout->addWidget(d->tagManager->tagChooserWidget(), 0, 0);
    thisLayout->addWidget(d->viewModeButton, 0, 1);
    thisLayout->addWidget(d->storagePopupButton, 0, 2);
    thisLayout->addWidget(d->resourcesSplitter, 1, 0, 1, 3);
    thisLayout->setRowStretch(1, 1);
    thisLayout->addWidget(d->tagManager->tagFilterWidget(), 2, 0, 1, 3);
    thisLayout->addWidget(d->importExportBtns, 3, 0, 1, 3);
 
    d->viewModeButton->setVisible(d->showViewModeBtn);
    d->storagePopupButton->setVisible(d->showStoragePopupBtn);
 
    d->viewModeButton->setVisible(d->showViewModeBtn);
    d->layout = Layout::Vertical;
}

References KisResourceItemChooserSync::baseLength, d, hideEverything(), KisResourceItemChooserSync::instance(), layout, listViewModeChanged(), and Vertical.

◆ baseLengthChanged

void KisResourceItemChooser::baseLengthChanged ( int length )

privateslot

Definition at line 649 of file KisResourceItemChooser.cpp.

{
    if (d->synced) {
        d->view->setItemSize(QSize(length, length));
    }
}

References d, and length().

◆ changeLayoutBasedOnSize()

void KisResourceItemChooser::changeLayoutBasedOnSize ( )

private

Definition at line 745 of file KisResourceItemChooser.cpp.

{
    if (d->isResponsive == false) {
        return;
    }
    // Responsive Layout
    else {
        // Vertical
        if (height() > 100) {
            applyVerticalLayout();
        }
        // Horizontal 2 rows
        else if (height() > 60) {
 
            if (d->layout == Layout::Horizontal2Rows) {
                return;
            }
 
            hideEverything();
 
            d->view->setListViewMode(ListViewMode::IconStripHorizontal);
            Q_EMIT listViewModeChanged(ListViewMode::IconStripHorizontal);
 
            // Left
            QLayout* leftLayout = d->left->layout();
            leftLayout->addWidget(d->resourcesSplitter);
 
            // Right Top
            d->top->addWidget(d->scroll_left);
            d->top->addWidget(d->scroll_right);
            d->top->addWidget(d->tagManager->tagChooserWidget());
            d->top->addWidget(d->importExportBtns);
 
            // Right Bot
            d->bot->addWidget(d->viewModeButton);
            d->bot->addWidget(d->storagePopupButton);
            d->bot->addWidget(d->tagManager->tagFilterWidget());
 
            d->horzSplitter->addWidget(d->left);
            d->horzSplitter->addWidget(d->right2Rows);
 
            QGridLayout* thisLayout = dynamic_cast<QGridLayout*>(layout());
            thisLayout->addWidget(d->horzSplitter, 0, 0);
            thisLayout->setRowStretch(0, 2);
            thisLayout->setColumnStretch(0, 2);
            thisLayout->setRowStretch(1, 0);
 
            d->viewModeButton->setVisible(false);
            d->storagePopupButton->setVisible(d->showStoragePopupBtn);
 
            const bool splitterRestored = d->restoreSplitterState(Layout::Horizontal2Rows);
 
            d->horzSplitter->show();
            d->left->show();
            d->scroll_left->show();
            d->scroll_right->show();
            d->right2Rows->show();
 
            d->layout = Layout::Horizontal2Rows;
 
            if (!splitterRestored) {
                slotSaveSplitterState();
            }
        }
        // Horizontal 1 row
        else {
            if (d->layout == Layout::Horizontal1Row) {
                return;
            }
 
            hideEverything();
 
            d->view->setListViewMode(ListViewMode::IconStripHorizontal);
            Q_EMIT listViewModeChanged(ListViewMode::IconStripHorizontal);
 
            QLayout* leftLayout = d->left->layout();
            leftLayout->addWidget(d->resourcesSplitter);
            leftLayout->addWidget(d->scroll_left);
            leftLayout->addWidget(d->scroll_right);
 
            QLayout* rightLayout = d->right->layout();
            rightLayout->addWidget(d->tagManager->tagChooserWidget());
            rightLayout->addWidget(d->viewModeButton);
            rightLayout->addWidget(d->storagePopupButton);
            rightLayout->addWidget(d->tagManager->tagFilterWidget());
            rightLayout->addWidget(d->importExportBtns);
 
            d->horzSplitter->addWidget(d->left);
            d->horzSplitter->addWidget(d->right);
 
            QGridLayout* thisLayout = dynamic_cast<QGridLayout*>(layout());
            thisLayout->addWidget(d->horzSplitter, 0, 0);
            thisLayout->setRowStretch(0, 2);
            thisLayout->setColumnStretch(0, 2);
            thisLayout->setRowStretch(1, 0);
 
            d->viewModeButton->setVisible(false);
            d->storagePopupButton->setVisible(d->showStoragePopupBtn);
 
            const bool splitterRestored = d->restoreSplitterState(Layout::Horizontal1Row);
 
            d->horzSplitter->show();
            d->left->show();
            d->scroll_left->show();
            d->scroll_right->show();
            d->right->show();
 
            d->layout = Layout::Horizontal1Row;
 
            if (!splitterRestored) {
                slotSaveSplitterState();
            }
        }
    }
}

References applyVerticalLayout(), d, hideEverything(), Horizontal1Row, Horizontal2Rows, IconStripHorizontal, layout, listViewModeChanged(), and slotSaveSplitterState().

◆ clicked

void KisResourceItemChooser::clicked ( const QModelIndex & index )

privateslot

Definition at line 521 of file KisResourceItemChooser.cpp.

{
    Q_UNUSED(index);
 
    KoResourceSP resource = currentResource();
    if (resource) {
        Q_EMIT resourceClicked(resource);
    }
}

References currentResource, and resourceClicked().

◆ contextMenuRequested

void KisResourceItemChooser::contextMenuRequested ( const QPoint & pos )

privateslot

Definition at line 612 of file KisResourceItemChooser.cpp.

{
    d->tagManager->contextMenuRequested(currentResource(), pos);
}

References currentResource, and d.

◆ currentResource()

KoResourceSP KisResourceItemChooser::currentResource ( bool includeHidden = false ) const

Gets the currently selected resource.

Parameters

includeHidden If true, return the remembered resource even if it is currently not visible in the item view

Returns: The selected resource, 0 is no resource is selected

◆ eventFilter()

bool KisResourceItemChooser::eventFilter	(	QObject *	object,
		QEvent *	event )

override

Allows zooming with Ctrl + Mouse Wheel.

Definition at line 669 of file KisResourceItemChooser.cpp.

{
    if (d->synced && event->type() == QEvent::Wheel) {
        KisResourceItemChooserSync *chooserSync = KisResourceItemChooserSync::instance();
        QWheelEvent *qwheel = static_cast<QWheelEvent *>(event);
        if (qwheel->modifiers() & Qt::ControlModifier) {
 
            int degrees = qwheel->angleDelta().y() / 8;
            int newBaseLength = chooserSync->baseLength() + degrees / 15 * 10;
            chooserSync->setBaseLength(newBaseLength);
            return true;
        }
    }
    return QObject::eventFilter(object, event);
}

References KisResourceItemChooserSync::baseLength, d, KisResourceItemChooserSync::instance(), and KisResourceItemChooserSync::setBaseLength().

◆ hideEverything()

void KisResourceItemChooser::hideEverything ( )

private

Definition at line 701 of file KisResourceItemChooser.cpp.

{
    d->horzSplitter->hide();
    d->left->hide();
    d->right->hide();
    d->right2Rows->hide();
    d->scroll_left->hide();
    d->scroll_right->hide();
 
    d->viewModeButton->hide();
}

References d.

◆ itemView()

KisResourceItemListView * KisResourceItemChooser::itemView ( ) const

Do not use this to change the view mode and flow directly. Use the requestViewMode() and requestFlow() methods so as to not intervene in the responsive design layout.

Definition at line 607 of file KisResourceItemChooser.cpp.

{
    return d->view;
}

References d.

◆ listViewModeChanged

void KisResourceItemChooser::listViewModeChanged ( ListViewMode newViewMode )

signal

Emitted when the view mode for the internal KisResourceItemListView changes.

◆ Private()

KisResourceItemChooser::Private ( QString _resourceType )

inline

Definition at line 59 of file KisResourceItemChooser.cpp.

60 : resourceType(_resourceType)

61 {}

◆ resizeEvent()

void KisResourceItemChooser::resizeEvent ( QResizeEvent * event )

overrideprotected

Definition at line 686 of file KisResourceItemChooser.cpp.

{
    QWidget::resizeEvent(event);
    changeLayoutBasedOnSize();
    updateView();
    updatePreview(d->view->currentIndex());
}

References changeLayoutBasedOnSize(), d, updatePreview(), and updateView().

◆ resourceClicked

void KisResourceItemChooser::resourceClicked ( KoResourceSP resource )

signal

Emitted when an already selected resource is clicked again

◆ resourceFromModelIndex()

KoResourceSP KisResourceItemChooser::resourceFromModelIndex ( const QModelIndex & index ) const

private

Resource for a given model index

Returns: the resource pointer, 0 is index not valid

Definition at line 593 of file KisResourceItemChooser.cpp.

{
    if (!index.isValid()) {
        return 0;
    }
    KoResourceSP r = d->tagFilterProxyModel->resourceForIndex(index);
    return r;
}

References d.

◆ resourceSelected

void KisResourceItemChooser::resourceSelected ( KoResourceSP resource )

signal

Emitted when a resource was selected.

◆ restoreSplitterState()

bool KisResourceItemChooser::restoreSplitterState ( Layout layout )

◆ scrollBackwards

void KisResourceItemChooser::scrollBackwards ( )

privateslot

Definition at line 487 of file KisResourceItemChooser.cpp.

{
    QScrollBar* bar = d->view->horizontalScrollBar();
    bar->setValue(bar->value() - d->view->gridSize().width());
}

References d.

◆ scrollForwards

void KisResourceItemChooser::scrollForwards ( )

privateslot

Definition at line 493 of file KisResourceItemChooser.cpp.

{
    QScrollBar* bar = d->view->horizontalScrollBar();
    bar->setValue(bar->value() + d->view->gridSize().width());
}

References d.

◆ setColumnWidth()

void KisResourceItemChooser::setColumnWidth ( int columnWidth )

Sets the width of the view columns.

Definition at line 396 of file KisResourceItemChooser.cpp.

{
    d->view->setItemSize(QSize(columnWidth, d->view->gridSize().height()));
}

References d.

◆ setCurrentItem()

void KisResourceItemChooser::setCurrentItem ( int row )

Sets the selected resource, does nothing if there is no valid item

Parameters

row	row of the item
column	column of the item

Definition at line 475 of file KisResourceItemChooser.cpp.

{
    QModelIndex index = d->view->model()->index(row, 0);
    if (!index.isValid())
        return;
 
    d->view->setCurrentIndex(index);
    if (index.isValid()) {
        updatePreview(index);
    }
}

References d, and updatePreview().

◆ setCurrentResource() [1/2]

void KisResourceItemChooser::setCurrentResource ( KoResourceSP resource )

Sets the item representing the resource as selected.

Definition at line 415 of file KisResourceItemChooser.cpp.

{
    // don't update if the change came from the same chooser
    if (d->updatesBlocked) {
        return;
    }
    QModelIndex index = d->tagFilterProxyModel->indexForResource(resource);
    d->view->setCurrentIndex(index);
 
    // The resource may currently be filtered out, but we want to be able
    // to select it if the filter changes and includes the resource.
    // Otherwise, activate() already took care of setting the current resource.
    if (!index.isValid()) {
        d->currentResource = resource;
    }
    updatePreview(index);
}

References d, and updatePreview().

◆ setCurrentResource() [2/2]

void KisResourceItemChooser::setCurrentResource ( QString resourceName )

Definition at line 433 of file KisResourceItemChooser.cpp.

{
    // don't update if the change came from the same chooser
    if (d->updatesBlocked) {
        return;
    }
 
    for (int row = 0; row < d->tagFilterProxyModel->rowCount(); row++) {
        for (int col = 0; col < d->tagFilterProxyModel->columnCount(); col++) {
            QModelIndex index = d->tagFilterProxyModel->index(row, col);
            KoResourceSP resource = d->tagFilterProxyModel->resourceForIndex(index);
 
            if (resource->name() == resourceName) {
                d->view->setCurrentIndex(index);
 
                // The resource may currently be filtered out, but we want to be able
                // to select it if the filter changes and includes the resource.
                // Otherwise, activate() already took care of setting the current resource.
                if (!index.isValid()) {
                    d->currentResource = resource;
                }
                updatePreview(index);
            }
        }
    }
}

References d, and updatePreview().

◆ setGrayscalePreview()

void KisResourceItemChooser::setGrayscalePreview ( bool grayscale )

shows the preview converted to grayscale

Definition at line 470 of file KisResourceItemChooser.cpp.

{
    d->grayscalePreview = grayscale;
}

References d.

◆ setItemDelegate()

void KisResourceItemChooser::setItemDelegate ( QAbstractItemDelegate * delegate )

Sets a custom delegate for the view.

Definition at line 401 of file KisResourceItemChooser.cpp.

{
    d->view->setItemDelegate(delegate);
}

References d.

◆ setListViewMode()

void KisResourceItemChooser::setListViewMode ( ListViewMode viewMode )

Set's the desired view mode for the resource list. Caller should use this instead of directly tampering with the KisResourceItemListView.

Definition at line 318 of file KisResourceItemChooser.cpp.

{
    d->requestedViewMode = newViewMode;
    if (d->layout == Layout::NotSet || d->layout == Layout::Vertical) {
        d->view->setListViewMode(newViewMode);
    }
}

References d, NotSet, and Vertical.

◆ setPreviewOrientation()

void KisResourceItemChooser::setPreviewOrientation ( Qt::Orientation orientation )

determines whether the preview right or below the splitter

Definition at line 460 of file KisResourceItemChooser.cpp.

{
    d->resourcesSplitter->setOrientation(orientation);
}

References d.

◆ setPreviewTiled()

void KisResourceItemChooser::setPreviewTiled ( bool tiled )

determines whether the preview should tile the resource's image or not

Definition at line 465 of file KisResourceItemChooser.cpp.

{
    d->tiledPreview = tiled;
}

References d.

◆ setResponsiveness()

void KisResourceItemChooser::setResponsiveness ( bool isResponsive )

Enable or disable changing the layout based on size. Default is false no responsiveness, layout is vertical.

Definition at line 301 of file KisResourceItemChooser.cpp.

{
    if (isResponsive) {
 
        if (d->isResponsive == false) {
            d->isResponsive = true;
            changeLayoutBasedOnSize();
        }
        else {
            d->isResponsive = true;
        }
    }
    else {
        d->isResponsive = false;
    }
}

References changeLayoutBasedOnSize(), d, and isResponsive.

◆ setRowHeight()

void KisResourceItemChooser::setRowHeight ( int rowHeight )

Sets the height of the view rows.

Definition at line 391 of file KisResourceItemChooser.cpp.

{
    d->view->setItemSize(QSize(d->view->gridSize().width(), rowHeight));
}

References d.

◆ setSynced()

void KisResourceItemChooser::setSynced ( bool sync )

Definition at line 634 of file KisResourceItemChooser.cpp.

{
    if (d->synced == sync)
        return;
 
    d->synced = sync;
    KisResourceItemChooserSync *chooserSync = KisResourceItemChooserSync::instance();
    if (sync) {
        connect(chooserSync, SIGNAL(baseLengthChanged(int)), SLOT(baseLengthChanged(int)));
        baseLengthChanged(chooserSync->baseLength());
    } else {
        chooserSync->disconnect(this);
    }
}

References KisResourceItemChooserSync::baseLength, baseLengthChanged(), d, and KisResourceItemChooserSync::instance().

◆ showEvent()

void KisResourceItemChooser::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 694 of file KisResourceItemChooser.cpp.

{
    QWidget::showEvent(event);
    updateView();
    updatePreview(d->view->currentIndex());
}

References d, updatePreview(), and updateView().

◆ showImportExportBtns()

void KisResourceItemChooser::showImportExportBtns ( bool show )

Shows the import and export buttons for the resource. Default is true.

Definition at line 375 of file KisResourceItemChooser.cpp.

{
    // assert(show == false);
    if (show) {
        d->importExportBtns->show();
    }
    else {
        d->importExportBtns->hide();
    }
}

References d.

◆ showStorageBtn()

void KisResourceItemChooser::showStorageBtn ( bool visible )

Shows or hides the storage button. Default is true.

Definition at line 617 of file KisResourceItemChooser.cpp.

{
    d->storagePopupButton->setVisible(visible);
    d->showStoragePopupBtn = visible;
}

References d.

◆ showTaggingBar()

void KisResourceItemChooser::showTaggingBar ( bool show )

Sets the visibility of tagging KlineEdits. Default is false.

Definition at line 386 of file KisResourceItemChooser.cpp.

{
    d->tagManager->showTaggingBar(show);
}

References d.

◆ showViewModeBtn()

void KisResourceItemChooser::showViewModeBtn ( bool visible )

Show the button for changing the view mode. Default is false.

◆ slotButtonClicked

void KisResourceItemChooser::slotButtonClicked ( int button )

slot

We have overridden the currently selected resource and nothing is selected now

We have overridden the currently selected resource and the model has managed to track the selection under it (that is not possible right now, but can theoretically happen under some circumstances)

Definition at line 331 of file KisResourceItemChooser.cpp.

{
    if (button == Button_Import) {
        QStringList mimeTypes = KisResourceLoaderRegistry::instance()->mimeTypes(d->resourceType);
        KoFileDialog dialog(0, KoFileDialog::OpenFiles, "OpenDocument");
        dialog.setMimeTypeFilters(mimeTypes);
        dialog.setDefaultDir(QStandardPaths::writableLocation(QStandardPaths::PicturesLocation));
        dialog.setCaption(i18nc("@title:window", "Choose File to Add"));
        Q_FOREACH(const QString &filename, dialog.filenames()) {
            if (QFileInfo(filename).exists() && QFileInfo(filename).isReadable()) {
 
                KoResourceSP previousResource = this->currentResource();
                KoResourceSP newResource = KisResourceUserOperations::importResourceFileWithUserInput(this, "", d->resourceType, filename);
 
                if (previousResource && newResource && !currentResource()) {
                    setCurrentResource(newResource);
                } else if (currentResource() == newResource) {
                    const QModelIndex index = d->tagFilterProxyModel->indexForResource(newResource);
                    updatePreview(index);
                }
            }
        }
        tagFilterModel()->sort(Qt::DisplayRole);
    }
    else if (button == Button_Remove) {
        QModelIndex index = d->view->currentIndex();
        if (index.isValid()) {
            d->tagFilterProxyModel->setResourceInactive(index);
        }
        int row = index.row();
        int rowMin = --row;
        row = qBound(0, rowMin, row);
        setCurrentItem(row);
        activate(d->tagFilterProxyModel->index(row, index.column()));
    }
    updateButtonState();
}

References activate(), button(), Button_Import, Button_Remove, currentResource, d, KisResourceUserOperations::importResourceFileWithUserInput(), KisResourceLoaderRegistry::instance(), KisResourceLoaderRegistry::mimeTypes(), KoFileDialog::OpenFiles, setCurrentItem(), setCurrentResource(), tagFilterModel(), updateButtonState(), and updatePreview().

◆ slotSaveSplitterState

void KisResourceItemChooser::slotSaveSplitterState ( )

privateslot

Definition at line 880 of file KisResourceItemChooser.cpp.

{
    if (d->layout > Layout::Vertical) {
        KConfigGroup group = KSharedConfig::openConfig()->group(QString("KisResourceItemChooser_%1").arg(d->resourceType));
        const QByteArray state = d->horzSplitter->saveState();
 
        const QLatin1String key(
            d->layout == Layout::Horizontal1Row ? "splitterState_1row" : "splitterState_2row");
 
        group.writeEntry(key, state);
    }
}

References d, Horizontal1Row, and Vertical.

◆ slotScrollerStateChanged

void KisResourceItemChooser::slotScrollerStateChanged ( QScroller::State state )

inlineslot

Definition at line 152 of file KisResourceItemChooser.h.

152{ KisKineticScroller::updateCursor(this, state); }

KisKineticScroller::updateCursor

KRITAWIDGETUTILS_EXPORT void updateCursor(QWidget *source, QScroller::State state)

Definition KisKineticScroller.cpp:170

References KisKineticScroller::updateCursor().

◆ tagFilterModel()

KisTagFilterResourceProxyModel * KisResourceItemChooser::tagFilterModel ( ) const

Definition at line 326 of file KisResourceItemChooser.cpp.

{
    return d->tagFilterProxyModel;
}

References d.

◆ updateButtonState()

void KisResourceItemChooser::updateButtonState ( )

private

Definition at line 531 of file KisResourceItemChooser.cpp.

{
    QAbstractButton *removeButton = d->buttonGroup->button(Button_Remove);
    if (! removeButton)
        return;
 
    KoResourceSP resource = currentResource();
    if (resource) {
        removeButton->setEnabled(!resource->permanent());
        return;
    }
    removeButton->setEnabled(false);
}

References Button_Remove, currentResource, and d.

◆ updatePreview()

void KisResourceItemChooser::updatePreview ( const QModelIndex & idx )

private

Definition at line 545 of file KisResourceItemChooser.cpp.

{
    if (!d->usePreview) return;
 
    if (!idx.isValid()) {
        d->previewLabel->setPixmap(QPixmap());
        return;
    }
 
    QImage image = idx.data(Qt::UserRole + KisAbstractResourceModel::Thumbnail).value<QImage>();
 
    if (image.format() != QImage::Format_RGB32 &&
        image.format() != QImage::Format_ARGB32 &&
        image.format() != QImage::Format_ARGB32_Premultiplied) {
 
        image.convertTo(QImage::Format_ARGB32_Premultiplied);
    }
 
    if (d->tiledPreview) {
        int width = d->previewScroller->width() * 4 * devicePixelRatioF();
        int height = d->previewScroller->height() * 4 * devicePixelRatioF();
        QImage img(width, height, image.format());
        QPainter gc(&img);
        gc.fillRect(img.rect(), Qt::white);
        gc.setPen(Qt::NoPen);
        gc.setBrush(QBrush(image));
        gc.drawRect(img.rect());
        image = img;
    }
 
    // Only convert to grayscale if it is rgb. Otherwise, it's gray already.
    if (d->grayscalePreview && !image.isGrayscale()) {
        QRgb *pixel = reinterpret_cast<QRgb *>(image.bits());
        for (int row = 0; row < image.height(); ++row) {
            for (int col = 0; col < image.width(); ++col) {
                const QRgb currentPixel = pixel[row * image.width() + col];
                const int red = qRed(currentPixel);
                const int green = qGreen(currentPixel);
                const int blue = qBlue(currentPixel);
                const int grayValue = (red * 11 + green * 16 + blue * 5) / 32;
                pixel[row * image.width() + col] = qRgb(grayValue, grayValue, grayValue);
            }
        }
    }
    image.setDevicePixelRatio(devicePixelRatioF());
    d->previewLabel->setPixmap(QPixmap::fromImage(image));
}

References d, and KisAbstractResourceModel::Thumbnail.

◆ updateView

void KisResourceItemChooser::updateView ( )

slot

helps to set icons here in case the theme is changed

Definition at line 893 of file KisResourceItemChooser.cpp.

{
    d->viewModeButton->setIcon(KisIconUtils::loadIcon("view-choose"));
    d->importButton->setIcon(koIcon("document-import-16"));
    d->deleteButton->setIcon(koIcon("edit-delete"));
    d->storagePopupButton->setIcon(koIcon("bundle_archive"));
    d->tagManager->tagChooserWidget()->updateIcons();
}

References d, koIcon, and KisIconUtils::loadIcon().

◆ viewModeButton()

KisPopupButton * KisResourceItemChooser::viewModeButton ( ) const

◆ viewSize()

QSize KisResourceItemChooser::viewSize ( ) const

View size for the resources view.

Definition at line 602 of file KisResourceItemChooser.cpp.

{
    return d->view->size();
}

References d.

Member Data Documentation

◆ bot

QHBoxLayout* KisResourceItemChooser::bot {0}

Definition at line 107 of file KisResourceItemChooser.cpp.

107{0};

◆ buttonGroup

QButtonGroup* KisResourceItemChooser::buttonGroup {0}

Definition at line 82 of file KisResourceItemChooser.cpp.

82{0}; // does not seem to do much, maybe replace with std::array

◆ currentResource

KoResourceSP KisResourceItemChooser::currentResource

Definition at line 93 of file KisResourceItemChooser.cpp.

◆ customButtons

QList<QAbstractButton*> KisResourceItemChooser::customButtons

Definition at line 85 of file KisResourceItemChooser.cpp.

◆ d

Private* const KisResourceItemChooser::d

private

Definition at line 182 of file KisResourceItemChooser.h.

◆ deleteButton

QToolButton* KisResourceItemChooser::deleteButton {0}

Definition at line 81 of file KisResourceItemChooser.cpp.

81{0};

◆ grayscalePreview

bool KisResourceItemChooser::grayscalePreview {false}

Definition at line 89 of file KisResourceItemChooser.cpp.

89{false};

◆ horzSplitter

QSplitter* KisResourceItemChooser::horzSplitter {0}

Definition at line 101 of file KisResourceItemChooser.cpp.

101{0};

◆ importButton

QToolButton* KisResourceItemChooser::importButton {0}

Definition at line 80 of file KisResourceItemChooser.cpp.

80{0};

◆ importExportBtns

QFrame* KisResourceItemChooser::importExportBtns {0}

Definition at line 79 of file KisResourceItemChooser.cpp.

79{0};

◆ isResponsive

bool KisResourceItemChooser::isResponsive = false

Definition at line 96 of file KisResourceItemChooser.cpp.

◆ layout

Layout KisResourceItemChooser::layout = Layout::NotSet

Definition at line 94 of file KisResourceItemChooser.cpp.

◆ left

QFrame* KisResourceItemChooser::left {0}

Definition at line 102 of file KisResourceItemChooser.cpp.

102{0};

◆ previewLabel

QLabel* KisResourceItemChooser::previewLabel {0}

Definition at line 76 of file KisResourceItemChooser.cpp.

76{0};

◆ previewScroller

QScrollArea* KisResourceItemChooser::previewScroller {0}

Definition at line 75 of file KisResourceItemChooser.cpp.

75{0};

◆ requestedViewMode

ListViewMode KisResourceItemChooser::requestedViewMode = ListViewMode::IconGrid

Definition at line 95 of file KisResourceItemChooser.cpp.

◆ resourcesSplitter

QSplitter* KisResourceItemChooser::resourcesSplitter {0}

Definition at line 73 of file KisResourceItemChooser.cpp.

73{0};

◆ resourceType

QString KisResourceItemChooser::resourceType

Definition at line 63 of file KisResourceItemChooser.cpp.

◆ right

QFrame* KisResourceItemChooser::right {0}

Definition at line 103 of file KisResourceItemChooser.cpp.

103{0};

◆ right2Rows

QFrame* KisResourceItemChooser::right2Rows {0}

Definition at line 105 of file KisResourceItemChooser.cpp.

105{0};

◆ scroll_left

QToolButton* KisResourceItemChooser::scroll_left {0}

Definition at line 109 of file KisResourceItemChooser.cpp.

109{0};

◆ scroll_right

QToolButton* KisResourceItemChooser::scroll_right {0}

Definition at line 110 of file KisResourceItemChooser.cpp.

110{0};

◆ showStoragePopupBtn

bool KisResourceItemChooser::showStoragePopupBtn = true

Definition at line 98 of file KisResourceItemChooser.cpp.

◆ showViewModeBtn

void KisResourceItemChooser::showViewModeBtn = true

Definition at line 97 of file KisResourceItemChooser.cpp.

◆ storagePopupButton

KisStorageChooserWidget* KisResourceItemChooser::storagePopupButton {0}

Definition at line 69 of file KisResourceItemChooser.cpp.

69{0};

◆ synced

bool KisResourceItemChooser::synced {false}

Definition at line 90 of file KisResourceItemChooser.cpp.

90{false};

◆ tagFilterProxyModel

KisTagFilterResourceProxyModel* KisResourceItemChooser::tagFilterProxyModel {0}

Definition at line 66 of file KisResourceItemChooser.cpp.

66{0};

◆ tagManager

KisResourceTaggingManager* KisResourceItemChooser::tagManager {0}

Definition at line 67 of file KisResourceItemChooser.cpp.

67{0};

◆ tiledPreview

bool KisResourceItemChooser::tiledPreview {false}

Definition at line 88 of file KisResourceItemChooser.cpp.

88{false};

◆ top

QHBoxLayout* KisResourceItemChooser::top {0}

Definition at line 106 of file KisResourceItemChooser.cpp.

106{0};

◆ updatesBlocked

bool KisResourceItemChooser::updatesBlocked {false}

Definition at line 91 of file KisResourceItemChooser.cpp.

91{false};

◆ usePreview

bool KisResourceItemChooser::usePreview {false}

Definition at line 87 of file KisResourceItemChooser.cpp.

87{false};

◆ view

KisResourceItemListView* KisResourceItemChooser::view {0}

Definition at line 72 of file KisResourceItemChooser.cpp.

72{0};

◆ viewModeButton

KisPopupButton * KisResourceItemChooser::viewModeButton {0}

Definition at line 68 of file KisResourceItemChooser.cpp.

68{0};

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

libs/resourcewidgets/KisResourceItemChooser.cpp
libs/resourcewidgets/KisResourceItemChooser.h

Public Types

Public Slots

Signals

Public Member Functions

Public Attributes

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Buttons

◆ Layout

Constructor & Destructor Documentation

◆ KisResourceItemChooser()

◆ ~KisResourceItemChooser()

Member Function Documentation

◆ activate

◆ afterFilterChanged

◆ applyVerticalLayout()

◆ baseLengthChanged

◆ changeLayoutBasedOnSize()

◆ clicked

◆ contextMenuRequested

◆ currentResource()

◆ eventFilter()

◆ hideEverything()

◆ itemView()

◆ listViewModeChanged

◆ Private()

◆ resizeEvent()

◆ resourceClicked

◆ resourceFromModelIndex()

◆ resourceSelected

◆ restoreSplitterState()

◆ scrollBackwards

◆ scrollForwards

◆ setColumnWidth()

◆ setCurrentItem()

◆ setCurrentResource() [1/2]

◆ setCurrentResource() [2/2]

◆ setGrayscalePreview()

◆ setItemDelegate()

◆ setListViewMode()

◆ setPreviewOrientation()

◆ setPreviewTiled()

◆ setResponsiveness()

◆ setRowHeight()

◆ setSynced()

◆ showEvent()

◆ showImportExportBtns()

◆ showStorageBtn()

◆ showTaggingBar()

◆ showViewModeBtn()

◆ slotButtonClicked

◆ slotSaveSplitterState

◆ slotScrollerStateChanged

◆ tagFilterModel()

◆ updateButtonState()

◆ updatePreview()

◆ updateView

◆ viewModeButton()

◆ viewSize()

Member Data Documentation

◆ bot

◆ buttonGroup

◆ currentResource

◆ customButtons

◆ d

◆ deleteButton

◆ grayscalePreview

◆ horzSplitter

◆ importButton

◆ importExportBtns

◆ isResponsive

◆ layout

◆ left

◆ previewLabel

◆ previewScroller

◆ requestedViewMode