KisResourceItemListView Class Reference

#include <KisResourceItemListView.h>

Inheritance diagram for KisResourceItemListView:

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
	KisResourceItemListView (QWidget *parent=nullptr)
	Private (KisResourceItemListView *_q)
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)
	~KisResourceItemListView () override
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
QString	prev_scrollbar_style
QSize	requestedItemSize = QSize(56, 56)
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 17 of file KisResourceItemListView.cpp.

Constructor & Destructor Documentation

KisResourceItemListView()

KisResourceItemListView::KisResourceItemListView

(

QWidget *

parent = nullptr

)

Definition at line 31 of file KisResourceItemListView.cpp.

    : QListView(parent)
    , m_d(new Private(this))
{
    setSelectionMode(QAbstractItemView::SingleSelection);
    setContextMenuPolicy(Qt::DefaultContextMenu);   
    setResizeMode(QListView::Adjust);
    setUniformItemSizes(true);
 
    // Default configuration
    setViewMode(QListView::IconMode);
    setGridSize(QSize(56, 56));
    setIconSize(QSize(56, 56));
    setResizeMode(QListView::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 KisKineticScroller::createPreconfiguredScroller(), currentResourceClicked(), m_d, and slotScrollerStateChange().

~KisResourceItemListView()

KisResourceItemListView::~KisResourceItemListView ( )

override

Definition at line 57 of file KisResourceItemListView.cpp.

{
}

Member Function Documentation

contextMenuEvent()

void KisResourceItemListView::contextMenuEvent ( QContextMenuEvent * event )

overrideprotected

Definition at line 188 of file KisResourceItemListView.cpp.

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

References contextMenuRequested().

contextMenuRequested

void KisResourceItemListView::contextMenuRequested ( const QPoint & )

signal

currentResourceChanged

void KisResourceItemListView::currentResourceChanged ( const QModelIndex & )

signal

currentResourceClicked

void KisResourceItemListView::currentResourceClicked ( const QModelIndex & )

signal

Private()

KisResourceItemListView::Private ( KisResourceItemListView * _q )

inline

Definition at line 19 of file KisResourceItemListView.cpp.

: tip(_q) {}

resizeEvent()

void KisResourceItemListView::resizeEvent ( QResizeEvent * event )

overrideprivate

Definition at line 218 of file KisResourceItemListView.cpp.

{
    QListView::resizeEvent(event);
 
    switch (m_d->viewMode) {
    case ListViewMode::IconStripHorizontal: {
        const int height = event->size().height();
        setGridSize(QSize(height, height));
        setIconSize(QSize(height, height));
        break;
    }
    case ListViewMode::Detail: {
        setItemSize(m_d->requestedItemSize);
        break;
    }
    case ListViewMode::IconGrid: {
        break;
    }
    }
    scrollTo(currentIndex(), QAbstractItemView::PositionAtCenter);
}

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

rowsAboutToBeRemoved

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

overrideprotectedslot

Definition at line 145 of file KisResourceItemListView.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();
    }
    QListView::rowsAboutToBeRemoved(parent, start, end);
}

References m_d.

selectionChanged

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

overrideprotectedslot

Definition at line 161 of file KisResourceItemListView.cpp.

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

References currentResourceChanged().

selectionCommand()

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

overrideprotected

Definition at line 174 of file KisResourceItemListView.cpp.

{
    QItemSelectionModel::SelectionFlags cmd = QListView::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 KisResourceItemListView::setFixedToolTipThumbnailSize

(

const QSize &

size

)

Definition at line 135 of file KisResourceItemListView.cpp.

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

References m_d.

setItemSize()

void KisResourceItemListView::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 106 of file KisResourceItemListView.cpp.

{
    m_d->requestedItemSize = size;
 
    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() - horizontalScrollBar()->width();
        setGridSize(QSize(w, size.height()));
        setIconSize(QSize(size));
        break;
    }
    }
}

References Detail, IconGrid, IconStripHorizontal, and m_d.

setListViewMode()

void KisResourceItemListView::setListViewMode

(

ListViewMode

layout

)

Definition at line 61 of file KisResourceItemListView.cpp.

{
    m_d->viewMode = viewMode;
 
    auto restoreScrollbar = [&, this] () {
        horizontalScrollBar()->setStyleSheet(m_d->prev_scrollbar_style);
        setVerticalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAsNeeded);
    };
 
    switch (viewMode) {
    case ListViewMode::IconGrid: {
        setViewMode(ViewMode::IconMode);
        setFlow(Flow::LeftToRight);
        setWrapping(true);
        restoreScrollbar();
 
        setItemSize(m_d->requestedItemSize);
        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);
 
        setItemSize(m_d->requestedItemSize);
        break;
    }
    case ListViewMode::Detail: {
        setViewMode(ViewMode::ListMode);
        setFlow(Flow::TopToBottom);
        setWrapping(false);
        restoreScrollbar();
        setItemSize(m_d->requestedItemSize);
        // horizontalScrollBar()->setStyleSheet(m_d->prev_scrollbar_style);
        setVerticalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAsNeeded);
        setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy::ScrollBarAsNeeded);
        break;
    }
    }
}

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

setStrictSelectionMode()

void KisResourceItemListView::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 130 of file KisResourceItemListView.cpp.

{
    m_d->strictSelectionMode = enable;
}

References m_d.

setToolTipShouldRenderCheckers()

void KisResourceItemListView::setToolTipShouldRenderCheckers

(

bool

value

)

Definition at line 140 of file KisResourceItemListView.cpp.

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

References m_d, and value().

sigSizeChanged

void KisResourceItemListView::sigSizeChanged ( )

signal

slotScrollerStateChange

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

inlineslot

Definition at line 53 of file KisResourceItemListView.h.

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

References KisKineticScroller::updateCursor().

viewportEvent()

bool KisResourceItemListView::viewportEvent ( QEvent * event )

overrideprotected

Definition at line 194 of file KisResourceItemListView.cpp.

{
    if (!model()) return true;
 
    if (event->type() == QEvent::ToolTip) {
        QHelpEvent *he = static_cast<QHelpEvent *>(event);
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
        QStyleOptionViewItem option = viewOptions();
#else
        QStyleOptionViewItem option;
        initViewItemOption(&option);
#endif
        QModelIndex index = model()->buddy(indexAt(he->pos()));
        if (index.isValid()) {
            option.rect = visualRect(index);
            m_d->tip.showTip(he->pos(), option, index);
            return true;
        }
        m_d->tip.hide();
    }
 
    return QListView::viewportEvent(event);
}

References m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisResourceItemListView::m_d

private

Definition at line 79 of file KisResourceItemListView.h.

prev_scrollbar_style

QString KisResourceItemListView::prev_scrollbar_style

Definition at line 26 of file KisResourceItemListView.cpp.

requestedItemSize

QSize KisResourceItemListView::requestedItemSize = QSize(56, 56)

Definition at line 28 of file KisResourceItemListView.cpp.

scroller

QScroller* KisResourceItemListView::scroller {0}

Definition at line 25 of file KisResourceItemListView.cpp.

{0};

strictSelectionMode

bool KisResourceItemListView::strictSelectionMode {false}

Definition at line 22 of file KisResourceItemListView.cpp.

{false};

tip

KisIconToolTip KisResourceItemListView::tip

Definition at line 23 of file KisResourceItemListView.cpp.

viewMode

ListViewMode KisResourceItemListView::viewMode = ListViewMode::IconGrid

Definition at line 21 of file KisResourceItemListView.cpp.

---

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

• libs/resourcewidgets/KisResourceItemListView.cpp
• libs/resourcewidgets/KisResourceItemListView.h