KisCategorizedListView Class Reference

#include <kis_categorized_list_view.h>

Inheritance diagram for KisCategorizedListView:

Signals
void	lockAreaTriggered (const QModelIndex &index)
void	rightClickedMenuDropSettingsTriggered ()
void	rightClickedMenuSaveSettingsTriggered ()
void	sigCategoryToggled (const QModelIndex &index, bool toggled)
void	sigEntryChecked (const QModelIndex &index)

Public Member Functions
	KisCategorizedListView (QWidget *parent=0)
void	setCompositeBoxControl (bool value)
void	setModel (QAbstractItemModel *model) override
QSize	sizeHint () const override
	~KisCategorizedListView () override

Protected Slots
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles=QVector< int >()) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end) override
void	rowsInserted (const QModelIndex &parent, int start, int end) override
void	slotIndexChanged (const QModelIndex &index)
void	slotScrollerStateChange (QScroller::State state)

Private Member Functions
void	updateRows (int begin, int end)

Private Attributes
bool	isCompositeBoxControl = false

Detailed Description

Definition at line 15 of file kis_categorized_list_view.h.

Constructor & Destructor Documentation

KisCategorizedListView()

KisCategorizedListView::KisCategorizedListView

(

QWidget *

parent = 0

)

Definition at line 19 of file kis_categorized_list_view.cpp.

                                                             :
    QListView(parent)
{
    connect(this, SIGNAL(clicked(QModelIndex)), this, SLOT(slotIndexChanged(QModelIndex)));
 
    // Because this widget has a darker background, the checkbox borders get hidden with default palette
    // This palette update makes the checkboxes easier to see by starting with the text color
    QPalette newPall = palette();
    newPall.setColor(QPalette::Active, QPalette::Window, palette().text().color() );
    setPalette(newPall);
 
    {
        QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(this);
        if (scroller) {
            connect(scroller, SIGNAL(stateChanged(QScroller::State)), this, SLOT(slotScrollerStateChange(QScroller::State)));
        }
    }
}

References connect(), KisKineticScroller::createPreconfiguredScroller(), palette, slotIndexChanged(), and slotScrollerStateChange().

~KisCategorizedListView()

KisCategorizedListView::~KisCategorizedListView ( )

override

Definition at line 38 of file kis_categorized_list_view.cpp.

{
}

Member Function Documentation

dataChanged

void KisCategorizedListView::dataChanged ( const QModelIndex & topLeft, const QModelIndex & bottomRight, const QVector< int > & roles = QVector<int>() )

overrideprotectedslot

Definition at line 81 of file kis_categorized_list_view.cpp.

{
    QListView::dataChanged(topLeft, bottomRight);
    updateRows(topLeft.row(), bottomRight.row()+1);
 
    // check to see if the data changed was a check box
    // if it is a checkbox tell the brush editor that the preset is now "dirty"
    int i = 0;
    for (QVector<int>::const_iterator iterator = roles.begin(); iterator != roles.end(); ++iterator) {
 
        if (Qt::CheckStateRole == roles.at(i) ) {
            int row = topLeft.row();
            int column = topLeft.column();
 
            Q_EMIT sigEntryChecked(model()->index(row, column));
        } else if (__CategorizedListModelBase::ExpandCategoryRole == roles.at(i)) {
           // logic to target the expand/contract menus if needed
        }
 
        i++;
    }
}

References __CategorizedListModelBase::ExpandCategoryRole, sigEntryChecked(), and updateRows().

lockAreaTriggered

void KisCategorizedListView::lockAreaTriggered ( const QModelIndex & index )

signal

mousePressEvent

void KisCategorizedListView::mousePressEvent ( QMouseEvent * event )

overrideprotectedslot

Definition at line 117 of file kis_categorized_list_view.cpp.

{
    QListView::mousePressEvent(event);
 
    QModelIndex index = QListView::indexAt(event->pos());
 
 
    // hack: the custom compositeop combo box has issues with events being sent
    // those widgets will run this extra code to help them know if a checkbox is clicked
    if (isCompositeBoxControl) {
 
        if (index.isValid() && (event->pos().x() < 25) && (model()->flags(index) & Qt::ItemIsUserCheckable)) {
            QListView::mousePressEvent(event);
            QMouseEvent releaseEvent(QEvent::MouseButtonRelease,
                            event->pos(),
                            event->globalPos(),
                            event->button(),
                            event->button() | event->buttons(),
                            event->modifiers());
 
            QListView::mouseReleaseEvent(&releaseEvent);
            Q_EMIT sigEntryChecked(index);
 
            return; // don't worry about running the 'right' click logic below. that is not relevant with composite ops
        }
    }
 
 
 
    if (event->button() == Qt::RightButton){
 
        QMenu menu(this);
 
        if(index.data(__CategorizedListModelBase::isLockableRole).toBool() && index.isValid()) {
 
            bool locked = index.data(__CategorizedListModelBase::isLockedRole).toBool();
 
            QIcon icon = locked ? KisIconUtils::loadIcon("unlocked") : KisIconUtils::loadIcon("locked");
 
            // Add an empty section so there's a bit more space before users accidentally press lock
            // See https://bugs.kde.org/show_bug.cgi?id=447367
            menu.addSection("     ");
 
            QAction* action1 = menu.addAction(icon, locked ? i18n("Unlock (restore settings from preset)")
                                                           : i18n("Lock"));
 
            connect(action1, SIGNAL(triggered()), this, SIGNAL(rightClickedMenuDropSettingsTriggered()));
 
            if (locked){
                QAction* action2 = menu.addAction(icon, i18n("Unlock (keep current settings)"));
                connect(action2, SIGNAL(triggered()), this, SIGNAL(rightClickedMenuSaveSettingsTriggered()));
            }
            menu.exec(event->globalPos());
        }
    }
}

References connect(), isCompositeBoxControl, __CategorizedListModelBase::isLockableRole, __CategorizedListModelBase::isLockedRole, KisIconUtils::loadIcon(), rightClickedMenuDropSettingsTriggered(), rightClickedMenuSaveSettingsTriggered(), and sigEntryChecked().

mouseReleaseEvent

void KisCategorizedListView::mouseReleaseEvent ( QMouseEvent * event )

overrideprotectedslot

Definition at line 174 of file kis_categorized_list_view.cpp.

{
    QListView::mouseReleaseEvent(event);
}

rightClickedMenuDropSettingsTriggered

void KisCategorizedListView::rightClickedMenuDropSettingsTriggered ( )

signal

rightClickedMenuSaveSettingsTriggered

void KisCategorizedListView::rightClickedMenuSaveSettingsTriggered ( )

signal

rowsAboutToBeRemoved

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

overrideprotectedslot

Definition at line 111 of file kis_categorized_list_view.cpp.

{
    QListView::rowsAboutToBeRemoved(parent, start, end);
    model()->sort(0);
}

rowsInserted

void KisCategorizedListView::rowsInserted ( const QModelIndex & parent, int start, int end )

overrideprotectedslot

Definition at line 104 of file kis_categorized_list_view.cpp.

{
    QListView::rowsInserted(parent, start, end);
    updateRows(0, model()->rowCount());
    model()->sort(0);
}

References updateRows().

setCompositeBoxControl()

void KisCategorizedListView::setCompositeBoxControl

(

bool

value

)

Definition at line 57 of file kis_categorized_list_view.cpp.

{
    isCompositeBoxControl = value;
}

References isCompositeBoxControl, and value().

setModel()

void KisCategorizedListView::setModel ( QAbstractItemModel * model )

override

Definition at line 42 of file kis_categorized_list_view.cpp.

{
    QListView::setModel(model);
    updateRows(0, model->rowCount());
    model->sort(0);
}

References updateRows().

sigCategoryToggled

void KisCategorizedListView::sigCategoryToggled ( const QModelIndex & index, bool toggled )

signal

sigEntryChecked

void KisCategorizedListView::sigEntryChecked ( const QModelIndex & index )

signal

sizeHint()

QSize KisCategorizedListView::sizeHint ( ) const

override

Definition at line 49 of file kis_categorized_list_view.cpp.

{
    const QSize sh = QListView::sizeHint();
    const int width = sizeHintForColumn(0);
 
    return QSize(width, sh.height());
}

slotIndexChanged

void KisCategorizedListView::slotIndexChanged ( const QModelIndex & index )

protectedslot

Definition at line 72 of file kis_categorized_list_view.cpp.

{
    if(model()->data(index, __CategorizedListModelBase::IsHeaderRole).toBool()) {
        bool expanded = model()->data(index, __CategorizedListModelBase::ExpandCategoryRole).toBool();
        model()->setData(index, !expanded, __CategorizedListModelBase::ExpandCategoryRole);
        Q_EMIT sigCategoryToggled(index, !expanded);
    }
}

References __CategorizedListModelBase::ExpandCategoryRole, __CategorizedListModelBase::IsHeaderRole, and sigCategoryToggled().

slotScrollerStateChange

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

protectedslot

Definition at line 179 of file kis_categorized_list_view.cpp.

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

References KisKineticScroller::updateCursor().

updateRows()

void KisCategorizedListView::updateRows ( int begin, int end )

private

Definition at line 62 of file kis_categorized_list_view.cpp.

{
    for(; begin!=end; ++begin) {
        QModelIndex index    = model()->index(begin, 0);
        bool        isHeader = model()->data(index, __CategorizedListModelBase::IsHeaderRole).toBool();
        bool        expanded = model()->data(index, __CategorizedListModelBase::ExpandCategoryRole).toBool();
        setRowHidden(begin, !expanded && !isHeader);
    }
}

References __CategorizedListModelBase::ExpandCategoryRole, and __CategorizedListModelBase::IsHeaderRole.

Member Data Documentation

isCompositeBoxControl

bool KisCategorizedListView::isCompositeBoxControl = false

private

Definition at line 44 of file kis_categorized_list_view.h.

---

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

• libs/ui/widgets/kis_categorized_list_view.h
• libs/ui/widgets/kis_categorized_list_view.cpp