#include <KisResourceItemListWidget.h>

Inheritance diagram for KisResourceItemListWidget:

Public Slots
void	slotScrollerStateChange (QScroller::State state)

Signals
void	contextMenuRequested (const QPoint &)

void	currentResourceChanged (const QModelIndex &)

void	currentResourceClicked (const QModelIndex &)

void	sigSizeChanged ()

Public Member Functions
	KisResourceItemListWidget (QWidget *parent=nullptr)

void	setFixedToolTipThumbnailSize (const QSize &size)

void	setItemSize (QSize size)
	setItemSize convenience function which sets both the icon and the grid size to the same value.

void	setListViewMode (ListViewMode layout)

void	setStrictSelectionMode (bool enable)
	setStrictSelectionMode sets additional restrictions on the selection.

void	setToolTipShouldRenderCheckers (bool value)

	~KisResourceItemListWidget () override

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

Public Attributes
QString	prev_scrollbar_style

QScroller *	scroller {0}

bool	strictSelectionMode {false}

KisIconToolTip	tip

ListViewMode	viewMode = ListViewMode::IconGrid

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Protected Slots
void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end) override

void	selectionChanged (const QItemSelection &selected, const QItemSelection &deselected) override

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *event) override

QItemSelectionModel::SelectionFlags	selectionCommand (const QModelIndex &index, const QEvent *event=nullptr) const override

bool	viewportEvent (QEvent *event) override

Private Member Functions
void	resizeEvent (QResizeEvent *event) override

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 20 of file KisResourceItemListWidget.cpp.

Constructor & Destructor Documentation

◆ KisResourceItemListWidget()

KisResourceItemListWidget::KisResourceItemListWidget ( QWidget * parent = nullptr )

Definition at line 30 of file KisResourceItemListWidget.cpp.

    : QListWidget(parent)
    , m_d(new Private)
{
    setSelectionMode(QAbstractItemView::ExtendedSelection);
    setContextMenuPolicy(Qt::DefaultContextMenu);
    setViewMode(QListView::IconMode);
    setGridSize(QSize(56, 56));
    setIconSize(QSize(56, 56));
    setResizeMode(QListWidget::Adjust);
    setUniformItemSizes(true);
 
    m_d->scroller = KisKineticScroller::createPreconfiguredScroller(this);
    if (m_d->scroller) {
        connect(m_d->scroller, SIGNAL(stateChanged(QScroller::State)), this, SLOT(slotScrollerStateChange(QScroller::State)));
    }
 
    connect(this, SIGNAL(clicked(QModelIndex)), SIGNAL(currentResourceClicked(const QModelIndex &)));
 
     m_d->prev_scrollbar_style = horizontalScrollBar()->styleSheet();
}

References connect(), KisKineticScroller::createPreconfiguredScroller(), currentResourceClicked(), m_d, and slotScrollerStateChange().

◆ ~KisResourceItemListWidget()

KisResourceItemListWidget::~KisResourceItemListWidget ( )

override

Definition at line 52 of file KisResourceItemListWidget.cpp.

53{

54}

Member Function Documentation

◆ contextMenuEvent()

void KisResourceItemListWidget::contextMenuEvent ( QContextMenuEvent * event )

overrideprotected

Definition at line 173 of file KisResourceItemListWidget.cpp.

{
    QListWidget::contextMenuEvent(event);
    Q_EMIT contextMenuRequested(event->globalPos());
}

References contextMenuRequested().

◆ contextMenuRequested

void KisResourceItemListWidget::contextMenuRequested ( const QPoint & )

signal

◆ currentResourceChanged

void KisResourceItemListWidget::currentResourceChanged ( const QModelIndex & )

signal

◆ currentResourceClicked

void KisResourceItemListWidget::currentResourceClicked ( const QModelIndex & )

signal

◆ resizeEvent()

void KisResourceItemListWidget::resizeEvent ( QResizeEvent * event )

overrideprivate

Definition at line 184 of file KisResourceItemListWidget.cpp.

{
    if (m_d->viewMode == ListViewMode::IconStripHorizontal) {
        const int height = event->size().height();
        setGridSize(QSize(height, height));
        setIconSize(QSize(height, height));
    }
    // trigger relaying the items, internally here not externally
    // by calling setItemSize
    else {
        setGridSize(gridSize());
    }
}

References IconStripHorizontal, and m_d.

◆ rowsAboutToBeRemoved

void KisResourceItemListWidget::rowsAboutToBeRemoved	(	const QModelIndex &	parent,
		int	start,
		int	end )

overrideprotectedslot

Definition at line 130 of file KisResourceItemListWidget.cpp.

{
    // QAbstractItemView moves the current index if the row it points to is removed,
    // which we don't want for strict selections
    QModelIndex current = currentIndex();
    if (selectionMode() == SingleSelection
            && m_d->strictSelectionMode
            && current.isValid()
            && current.row() >= start
            && current.row() <= end) {
 
        selectionModel()->clear();
    }
    QListWidget::rowsAboutToBeRemoved(parent, start, end);
}

References m_d.

◆ selectionChanged

void KisResourceItemListWidget::selectionChanged	(	const QItemSelection &	selected,
		const QItemSelection &	deselected )

overrideprotectedslot

Definition at line 146 of file KisResourceItemListWidget.cpp.

{
    // base class takes care of viewport updates
    QListWidget::selectionChanged(selected, deselected);
 
    if (selected.isEmpty()) {
        Q_EMIT currentResourceChanged(QModelIndex());
    }
    else {
        Q_EMIT currentResourceChanged(selected.indexes().first());
    }
}

References currentResourceChanged().

◆ selectionCommand()

QItemSelectionModel::SelectionFlags KisResourceItemListWidget::selectionCommand	(	const QModelIndex &	index,
		const QEvent *	event = nullptr ) const

overrideprotected

Definition at line 159 of file KisResourceItemListWidget.cpp.

{
    QItemSelectionModel::SelectionFlags cmd = QListWidget::selectionCommand(index, event);
 
    // avoid deselecting the current item by Ctrl-clicking in single selection mode
    if (selectionMode() == SingleSelection
            && m_d->strictSelectionMode
            && cmd.testFlag(QItemSelectionModel::Deselect)) {
 
        cmd = QItemSelectionModel::NoUpdate;
    }
    return cmd;
}

References m_d.

◆ setFixedToolTipThumbnailSize()

void KisResourceItemListWidget::setFixedToolTipThumbnailSize ( const QSize & size )

Definition at line 120 of file KisResourceItemListWidget.cpp.

{
    m_d->tip.setFixedToolTipThumbnailSize(size);
}

References m_d.

◆ setItemSize()

void KisResourceItemListWidget::setItemSize ( QSize size )

setItemSize convenience function which sets both the icon and the grid size to the same value.

Parameters

size	- the size you wish either to be.

Definition at line 93 of file KisResourceItemListWidget.cpp.

{
    switch (m_d->viewMode) {
    case ListViewMode::IconGrid: {
        setGridSize(size);
        setIconSize(size);
        break;
    }
    case ListViewMode::IconStripHorizontal: {
        // you can not set the item size in strip mode
        // it is configured automatically based on size
        break;
    }
    case ListViewMode::Detail: {
        const int w = width();
        setGridSize(QSize(w, size.height()));
        setIconSize(QSize(size));
        break;
    }
    }
}

References Detail, IconGrid, IconStripHorizontal, and m_d.

◆ setListViewMode()

void KisResourceItemListWidget::setListViewMode ( ListViewMode layout )

Definition at line 56 of file KisResourceItemListWidget.cpp.

{
    m_d->viewMode = viewMode;
 
    switch (viewMode) {
    case ListViewMode::IconGrid: {
        setViewMode(ViewMode::IconMode);
        setFlow(Flow::LeftToRight);
        setWrapping(true);
        horizontalScrollBar()->setStyleSheet(m_d->prev_scrollbar_style);
        setVerticalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAsNeeded);
        break;
    }
    case ListViewMode::IconStripHorizontal: {
        setViewMode(ViewMode::IconMode);
        setFlow(Flow::LeftToRight);
        setWrapping(false);
 
        // this is the only way to hide it and not have it occupy space
        horizontalScrollBar()->setStyleSheet("QScrollBar::horizontal {height: 0px;}");
        setVerticalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAlwaysOff);
        break;
    }
    case ListViewMode::Detail: {
        setViewMode(ViewMode::ListMode);
        setFlow(Flow::TopToBottom);
        setWrapping(false);
        // horizontalScrollBar()->setStyleSheet(m_d->prev_scrollbar_style);
        setVerticalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAsNeeded);
        setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAsNeeded);
        break;
    }
    }
 
    setItemSize(iconSize());
}

References Detail, IconGrid, iconSize(), IconStripHorizontal, m_d, setItemSize(), and viewMode.

◆ setStrictSelectionMode()

void KisResourceItemListWidget::setStrictSelectionMode ( bool enable )

setStrictSelectionMode sets additional restrictions on the selection.

When in QAbstractItemView::SingleSelection mode, this ensures that the selection never gets transferred to another item. Instead, the selection is cleared if the current item gets removed (filtered) from the model. Furthermore, it prevents users from deselecting the current item with Ctrl+click. This behavior is important for resource selectors.

Parameters

enable Determines if strict mode is enabled.

Definition at line 115 of file KisResourceItemListWidget.cpp.

{
    m_d->strictSelectionMode = enable;
}

References m_d.

◆ setToolTipShouldRenderCheckers()

void KisResourceItemListWidget::setToolTipShouldRenderCheckers ( bool value )

Definition at line 125 of file KisResourceItemListWidget.cpp.

{
    m_d->tip.setToolTipShouldRenderCheckers(value);
}

References m_d, and value().

◆ sigSizeChanged

void KisResourceItemListWidget::sigSizeChanged ( )

signal

◆ slotScrollerStateChange

void KisResourceItemListWidget::slotScrollerStateChange ( QScroller::State state )

inlineslot

Definition at line 54 of file KisResourceItemListWidget.h.

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

KisKineticScroller::updateCursor

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

Definition KisKineticScroller.cpp:151

References KisKineticScroller::updateCursor().

◆ viewportEvent()

bool KisResourceItemListWidget::viewportEvent ( QEvent * event )

overrideprotected

Definition at line 179 of file KisResourceItemListWidget.cpp.

{
    return QListWidget::viewportEvent(event);
}

Member Data Documentation

◆ m_d

const QScopedPointer<Private> KisResourceItemListWidget::m_d

private

Definition at line 80 of file KisResourceItemListWidget.h.

◆ prev_scrollbar_style

QString KisResourceItemListWidget::prev_scrollbar_style

Definition at line 27 of file KisResourceItemListWidget.cpp.

◆ scroller

QScroller* KisResourceItemListWidget::scroller {0}

Definition at line 26 of file KisResourceItemListWidget.cpp.

26{0};

◆ strictSelectionMode

bool KisResourceItemListWidget::strictSelectionMode {false}

Definition at line 23 of file KisResourceItemListWidget.cpp.

23{false};

◆ tip

KisIconToolTip KisResourceItemListWidget::tip

Definition at line 24 of file KisResourceItemListWidget.cpp.

◆ viewMode

ListViewMode KisResourceItemListWidget::viewMode = ListViewMode::IconGrid

Definition at line 22 of file KisResourceItemListWidget.cpp.

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

libs/resourcewidgets/KisResourceItemListWidget.cpp
libs/resourcewidgets/KisResourceItemListWidget.h

Public Slots

Signals

Public Member Functions

Public Attributes

Protected Slots

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisResourceItemListWidget()

◆ ~KisResourceItemListWidget()

Member Function Documentation

◆ contextMenuEvent()

◆ contextMenuRequested

◆ currentResourceChanged

◆ currentResourceClicked

◆ resizeEvent()

◆ rowsAboutToBeRemoved

◆ selectionChanged

◆ selectionCommand()

◆ setFixedToolTipThumbnailSize()

◆ setItemSize()

◆ setListViewMode()

◆ setStrictSelectionMode()

◆ setToolTipShouldRenderCheckers()

◆ sigSizeChanged

◆ slotScrollerStateChange

◆ viewportEvent()

Member Data Documentation

◆ m_d

◆ prev_scrollbar_style

◆ scroller

◆ strictSelectionMode

◆ tip

◆ viewMode