NodeToolTip Class Reference

#include <NodeToolTip.h>

Inheritance diagram for NodeToolTip:

Public Member Functions
	NodeToolTip (QWidget *widget)
	~NodeToolTip () override
Public Member Functions inherited from KoItemToolTip
	KoItemToolTip (QWidget *parent)
void	showTip (const QPoint &pos, const QStyleOptionViewItem &option, const QModelIndex &index)
QSize	sizeHint () const override
	~KoItemToolTip () override

Protected Member Functions
QTextDocument *	createDocument (const QModelIndex &index) override
Protected Member Functions inherited from KoItemToolTip
bool	eventFilter (QObject *object, QEvent *event) override
void	paintEvent (QPaintEvent *e) override

Private Types
typedef KisNodeModel	Model

Additional Inherited Members
Public Attributes inherited from KoItemToolTip
std::unique_ptr< QTextDocument >	document
QPersistentModelIndex	index
QPoint	pos
QTimer	timer

Detailed Description

A default tooltip for a NodeView that shows a thumbnail image and the list of properties associated with a node.

Definition at line 18 of file NodeToolTip.h.

Member Typedef Documentation

Model

typedef KisNodeModel NodeToolTip::Model

private

Definition at line 30 of file NodeToolTip.h.

Constructor & Destructor Documentation

NodeToolTip()

NodeToolTip::NodeToolTip

(

QWidget *

widget

)

Definition at line 18 of file NodeToolTip.cpp.

    : KoItemToolTip(widget)
{
}

~NodeToolTip()

NodeToolTip::~NodeToolTip ( )

override

Definition at line 23 of file NodeToolTip.cpp.

{
}

Member Function Documentation

createDocument()

QTextDocument * NodeToolTip::createDocument ( const QModelIndex & index )

overrideprotectedvirtual

Re-implement this to provide the actual tooltip contents. For instance:

QTextDocument *doc = new QTextDocument(this);
 
 QImage thumb = index.data(Qt::UserRole + KisAbstractResourceModel::LargeThumbnail).value<QImage>();
 doc->addResource(QTextDocument::ImageResource, QUrl("data:thumbnail"), thumb);
 
 QString name = index.data(Qt::DisplayRole).toString();
 
 const QString image = QString("<img src=\"data:thumbnail\">");
 const QString body = QString("<h3 align=\"center\">%1</h3>").arg(name) + image;
 const QString html = QString("<html><body>%1</body></html>").arg(body);
 
 doc->setHtml(html);
 doc->setTextWidth(qMin(doc->size().width(), 500.0));
 
 return doc;

Implements KoItemToolTip.

Definition at line 27 of file NodeToolTip.cpp.

{
    QTextDocument *doc = new QTextDocument(this);
 
    int size = 250*devicePixelRatioF();
    QImage thumb = index.data(int(KisNodeModel::BeginThumbnailRole) + size).value<QImage>();
    thumb.setDevicePixelRatio(devicePixelRatioF());
    doc->addResource(QTextDocument::ImageResource, QUrl("data:thumbnail"), thumb);
 
    QString name = index.data(Qt::DisplayRole).toString();
    KisBaseNode::PropertyList properties = index.data(KisNodeModel::PropertiesRole).value<KisBaseNode::PropertyList>();
    QString rows;
    // Note: Can't use <nobr> due to https://bugreports.qt.io/browse/QTBUG-1135
    // It breaks randomly with CJK. Works fine with `white-space:pre` though.
    const QString row = QString("<tr><td align=\"right\"><p style=\"white-space:pre\">%1:</p></td><td align=\"left\">%2</td></tr>");
    QString value;
    for(int i = 0, n = properties.count(); i < n; ++i) {
        if (properties[i].id == KisLayerPropertiesIcons::layerError.id() ||
                properties[i].id == KisLayerPropertiesIcons::layerColorSpaceMismatch.id()) continue;
 
        if (properties[i].isMutable)
            value = properties[i].state.toBool() ? i18n("Yes") : i18n("No");
        else
            value = properties[i].state.toString();
 
        rows.append(row.arg(properties[i].name).arg(value));
    }
 
    QString dropReason = index.data(KisNodeModel::DropReasonRole).toString();
 
    if (!dropReason.isEmpty()) {
        dropReason = QString("<p align=\"center\"><b>%1</b></p>").arg(dropReason);
    }
 
    QString errorMessage;
    {
        auto addWarningProperty = [&] (const QString &propertyId) {
            auto it = std::find_if(properties.begin(), properties.end(),
                                   kismpl::mem_equal_to(&KisBaseNode::Property::id,
                                                        propertyId));
 
            if (it != properties.end()) {
                doc->addResource(QTextDocument::ImageResource, QUrl(QString("data:symbol_%1").arg(it->id)), it->onIcon.pixmap(QSize(32,32)).toImage());
                errorMessage += QString("<table align=\"center\" border=\"0\"><tr valign=\"middle\"><td align=\"right\"><img src=\"data:symbol_%2\"></td><td align=\"left\"><b>%1</b></td></tr></table>").arg(it->state.toString(), it->id);
            }
        };
 
        addWarningProperty(KisLayerPropertiesIcons::layerError.id());
        addWarningProperty(KisLayerPropertiesIcons::layerColorSpaceMismatch.id());
    }
 
    rows = QString("<table>%1</table>").arg(rows);
 
    const QString image = QString("<table border=\"1\"><tr><td><img src=\"data:thumbnail\"></td></tr></table>");
    const QString body = QString("<h3 align=\"center\">%1</h3>").arg(name)
                       + errorMessage
                       + dropReason
                       + QString("<p><table><tr><td>%1</td><td>%2</td></tr></table></p>").arg(image).arg(rows);
    const QString html = QString("<html><body>%1</body></html>").arg(body);
 
    doc->setHtml(html);
 
    const int margin = 16;
    doc->setTextWidth(qMin(doc->size().width() + 2 * margin, qreal(600.0)));
 
    doc->setDocumentMargin(margin);
    doc->setUseDesignMetrics(true);
 
    return doc;
}

References KisNodeModel::BeginThumbnailRole, KisNodeModel::DropReasonRole, KoID::id(), KisBaseNode::Property::id, KoItemToolTip::index, KisLayerPropertiesIcons::layerColorSpaceMismatch, KisLayerPropertiesIcons::layerError, kismpl::mem_equal_to(), KisNodeModel::PropertiesRole, and value().

---

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

• plugins/dockers/layerdocker/NodeToolTip.h
• plugins/dockers/layerdocker/NodeToolTip.cpp