File indexing completed on 2024-04-28 04:33:57

 /********************************************************************************
  * Copyright (C) 2012-2015 by Stephen Allewell                                  *
  * steve.allewell@gmail.com                                                     *
  *                                                                              *
  * This program is free software; you can redistribute it and/or modify         *
  * it under the terms of the GNU General Public License as published by         *
  * the Free Software Foundation; either version 2 of the License, or            *
  * (at your option) any later version.                                          *
  ********************************************************************************/
 
 
 /**
  * @file
  * Implement the SymbolListWidget class
  */
 
 
 /**
  * @page library_list_widget SymbolListWidget
  * This class implements an extension to the QListWidget class that provides population of the widget
  * with the contents of a SymbolLibrary. For each Symbol in the library a QListWidgetItem is created
  * with a data item representing the Symbol identifier in the library and an icon at a given size that
  * is generated from the Symbol path.
  *
  * The widget is intended to be used in a dialog or main window and allows selection of a symbol to be
  * used for some purpose in the application.
  *
  * @image html ui-main-library.png "The user interface showing the library tab"
  */
 
 
 #include "SymbolListWidget.h"
 
 #include <QApplication>
 #include <QMimeData>
 #include <QPainter>
 #include <QPalette>
 #include <QPen>
 
 #include "Commands.h"
 #include "Symbol.h"
 #include "SymbolLibrary.h"
 
 
 /**
  * Constructor.
  */
 SymbolListWidget::SymbolListWidget(QWidget *parent)
     :   QListWidget(parent),
         m_library(nullptr),
         m_lastIndex(0)
 {
     setResizeMode(QListView::Adjust);
     setViewMode(QListView::IconMode);
     setIconSize(48);
 }
 
 
 /**
  * Set the size of the icons to be used.
  * The base QListWidget has the icon size and grid size set to this value.
  * If there are existing items in the QListWidget, they are updated with new icons.
  *
  * @param size the size in pixels
  */
 void SymbolListWidget::setIconSize(int size)
 {
     m_size = size;
     QListWidget::setIconSize(QSize(m_size, m_size));
     setGridSize(QSize(m_size, m_size));
     updateIcons();
 }
 
 
 /**
  * Populate the QListWidget with the QListWidgetItems for each Symbol in the SymbolLibrary.
  * An icon is created for each Symbol.
  *
  * @param library a pointer to the SymbolLibrary containing the Symbols
  */
 void SymbolListWidget::loadFromLibrary(SymbolLibrary *library)
 {
     if (!library) {
         return;
     }
 
     m_library = library;
 
     foreach (qint16 index, library->indexes()) {
         addSymbol(index, library->symbol(index));
     }
 }
 
 
 /**
  * Add an individual Symbol to the view.
  *
  * @param index the index of the Symbol
  * @param symbol a const reference to the Symbol to add
  */
 void SymbolListWidget::addSymbol(qint16 index, const Symbol &symbol)
 {
     QListWidgetItem *item = createItem(index);
     item->setIcon(createIcon(symbol, m_size));
 }
 
 
 /**
  * Remove a symbol item from the view.
  *
  * @param index the index of the item to remove
  */
 void SymbolListWidget::removeSymbol(qint16 index)
 {
     if (m_items.contains(index)) {
         removeItemWidget(m_items.value(index));
         delete m_items.take(index);
     }
 }
 
 
 /**
  * If an item for the index currently exists return it otherwise create
  * an item to be inserted into the QListWidget.
  * The item created has a data entry added representing the index.
  * The items are inserted so that the Symbols are sorted by their index.
  *
  * @param index an index in the SymbolLibrary
  *
  * @return a pointer to the QListWidgetItem created
  */
 QListWidgetItem *SymbolListWidget::createItem(qint16 index)
 {
     if (m_items.contains(index)) {
         return m_items.value(index);
     }
 
     QListWidgetItem *item = new QListWidgetItem;
     item->setData(Qt::UserRole, index);
     m_items.insert(index, item);
     int i = index;
 
     while (++i < m_lastIndex)
         if (m_items.contains(i)) {
             break;
         }
 
     if (i >= m_lastIndex) {
         addItem(item);
         m_lastIndex = index;
     } else {
         insertItem(row(m_items[i]), item);
     }
 
     return item;
 }
 
 
 /**
  * Create a QIcon for the supplied Symbol.
  *
  * @param symbol a const reference to a Symbol
  * @param size a size for the icon
  *
  * @return a QIcon
  */
 QIcon SymbolListWidget::createIcon(const Symbol &symbol, int size)
 {
     QPalette pal = QApplication::palette();
 
     QPixmap icon(size, size);
     icon.fill(Qt::transparent);
 
     QPainter p(&icon);
     p.setRenderHint(QPainter::Antialiasing, true);
     p.scale(size, size);
 
     QBrush brush = symbol.brush();
     QPen pen = symbol.pen();
 
     brush.setColor(pal.color(QPalette::WindowText));
     pen.setColor(pal.color(QPalette::WindowText));
 
     p.setBrush(brush);
     p.setPen(pen);
     p.drawPath(symbol.path());
     p.end();
 
     return QIcon(icon);
 }
 
 
 /**
  * Provide a list of mimetypes that this widget provides when dragging from it.
  *
  * @return a QStringList containing the mimetype strings
  */
 QStringList SymbolListWidget::mimeTypes() const
 {
     QStringList mimetypes;
     mimetypes.append(QStringLiteral("application/kxstitchsymbol"));
     return mimetypes;
 }
 
 
 Qt::DropActions SymbolListWidget::supportedDropActions() const
 {
     return Qt::CopyAction;
 }
 
 
 /**
  * Called when dragging items from one QListWidget to another to provide the serialised data.
  *
  * @param items a QList of pointers to the QListWidgetItems to provide data for
  *
  * @return a pointer to the QMimeData created
  */
 QMimeData *SymbolListWidget::mimeData(const QList<QListWidgetItem *> items) const
 {
     QMimeData *mimeData = new QMimeData;
 
     QByteArray data;
     QDataStream stream(&data, QIODevice::WriteOnly);
 
     foreach (QListWidgetItem * item, items) {
         qint16 index = static_cast<qint16>(item->data(Qt::UserRole).toInt());
         Symbol symbol = m_library->symbol(index);
         stream << symbol;
     }
 
     mimeData->setData(QStringLiteral("application/kxstitchsymbol"), data);
     return mimeData;
 }
 
 
 /**
  * Called when QListWidgetItems are dragged from one QListWidget to another.
  *
  * @param index the position index of the dropped item
  * @param mimeData a pointer to the serialised data from the source
  * @param action the requested drop action, only copying will be implemented
  *
  * @return @c true if the action is handled, @c false otherwise
  */
 bool SymbolListWidget::dropMimeData(int index, const QMimeData *mimeData, Qt::DropAction action)
 {
     Q_UNUSED(index);
     Q_UNUSED(action);
 
     if (mimeData->hasFormat(QStringLiteral("application/kxstitchsymbol"))) {
         m_library->undoStack()->push(new DragAndDropCommand(m_library, mimeData));
         return true;
     }
 
     return false;
 }
 
 
 /**
  * Intercept the events system to discover if the theme has changed, this should invoke
  * an update to the icons used to display the correct colors.
  *
  * @param e a pointer to the events
  *
  * @return @c true if the event was accepted, @c false otherwise
  */
 bool SymbolListWidget::event(QEvent *e)
 {
     bool accepted = QListWidget::event(e);
 
     if (e->type() == QEvent::PaletteChange) {
         updateIcons();
     }
 
     return accepted;
 }
 
 
 /**
  * Generate the icons for all the QListWidgetItems stored in m_items.
  */
 void SymbolListWidget::updateIcons()
 {
     QMapIterator<qint16, QListWidgetItem *> i(m_items);
 
     while (i.hasNext()) {
         i.next();
         i.value()->setIcon(createIcon(m_library->symbol(i.key()), m_size));
     }
 }