KisIconToolTip Class Reference

#include <KisIconToolTip.h>

Inheritance diagram for KisIconToolTip:

Public Member Functions
	KisIconToolTip (QWidget *parent)
void	setFixedToolTipThumbnailSize (const QSize &size)
void	setToolTipShouldRenderCheckers (bool value)
	~KisIconToolTip () 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 Attributes
QScopedPointer< KoCheckerBoardPainter >	m_checkersPainter
QSize	m_fixedToolTipThumbnailSize

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

Detailed Description

Definition at line 18 of file KisIconToolTip.h.

Constructor & Destructor Documentation

KisIconToolTip()

KisIconToolTip::KisIconToolTip

(

QWidget *

parent

)

Definition at line 22 of file KisIconToolTip.cpp.

    : KoItemToolTip(parent)
{
}

~KisIconToolTip()

KisIconToolTip::~KisIconToolTip ( )

override

Definition at line 27 of file KisIconToolTip.cpp.

{
}

Member Function Documentation

createDocument()

QTextDocument * KisIconToolTip::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 45 of file KisIconToolTip.cpp.

{
    QTextDocument *doc = new QTextDocument(this);
 
    QImage thumb = index.data(Qt::DecorationRole).value<QImage>();
    if (thumb.isNull()) {
        thumb = index.data(Qt::UserRole + KisAbstractResourceModel::Thumbnail).value<QImage>();
    }
 
    if (!m_fixedToolTipThumbnailSize.isEmpty() && !thumb.isNull()) {
        int pixelSize = 48; //  // let's say, 48x48?
        if (!thumb.isNull()) {
            // affects mostly gradients, which are very long but only 1px tall
            Qt::AspectRatioMode aspectRatioMode = thumb.height() == 1 ? Qt::IgnoreAspectRatio : Qt::KeepAspectRatio;
            // this allows the pixel patterns to be displayed correctly,
            // while the presets (which have 200x200 thumbnails) will still be pretty
            // Fast Transformation == Nearest Neighbour
            Qt::TransformationMode transformationMode = (thumb.width() < pixelSize || thumb.height() < pixelSize) ? Qt::FastTransformation : Qt::SmoothTransformation;
 
                thumb = KisResourceThumbnailCache::instance()->getImage(index,
                                                                        m_fixedToolTipThumbnailSize
                                                                            * devicePixelRatioF(),
                                                                        aspectRatioMode,
                                                                        transformationMode);
        }
    }
 
    if (m_checkersPainter) {
        QImage image(thumb.size(), QImage::Format_ARGB32);
 
        {
            QPainter gc(&image);
            m_checkersPainter->paint(gc, thumb.rect());
            gc.drawImage(QPoint(), thumb);
        }
 
        thumb = image;
    }
 
    thumb.setDevicePixelRatio(devicePixelRatioF());
    doc->addResource(QTextDocument::ImageResource, QUrl("data:thumbnail"), thumb);
 
    QString name = index.data(Qt::DisplayRole).toString();
    QString presetDisplayName = index.data(Qt::UserRole + KisAbstractResourceModel::Name).toString().replace("_", " ");
    //This is to ensure that the other uses of this class don't get an empty string, while resource management should get a nice string.
    if (!presetDisplayName.isEmpty()) {
        name = presetDisplayName;
    }
 
    QString translatedName = index.data(Qt::UserRole + KisAbstractResourceModel::Tooltip).toString().replace("_", " ");
 
    QString tagsRow;
    QString tagsData = index.data(Qt::UserRole + KisAbstractResourceModel::Tags).toStringList().join(", ");
    if (!tagsData.isEmpty()) {
        const QString list = QString("<ul style=\"list-style-type: none; margin: 0px;\">%1</ul> ").arg(tagsData);
        tagsRow = QString("<tr><td>%1:</td><td style=\"text-align: right;\">%2</td></tr>").arg(i18n("Tags"), list);
    }
 
    const QString brokenReason = index.data(Qt::UserRole + KisAbstractResourceModel::BrokenStatusMessage).toString();
    const QString brokenRow = 
        !brokenReason.isEmpty() 
        ? QString("<tr><td colspan=\"2\"><b>%1</b></td></tr>"
                  "<tr><td colspan=\"2\">%2</td></tr>")
                  .arg(i18n("Resource is broken!"), brokenReason)
        : QString();
 
    QString location = index.data(Qt::UserRole + KisAbstractResourceModel::Location).toString();
    if (location.isEmpty()) {
        location = i18nc("a placeholder name for the default storage of resources", "resource folder");
    }
 
    const QString locationRow = QString("<tr><td>%1:</td><td style=\"text-align: right;\">%2</td></tr>").arg(i18n("Location"), location);
 
    const QString footerTable = QString("<p><table>%1%2%3</table></p>").arg(brokenRow).arg(tagsRow).arg(locationRow);
 
    const QString image = QString("<center><img src=\"data:thumbnail\"></center>");
    QString body = QString("<h3 align=\"center\">%1</h3>%2%3").arg(name, image, footerTable);
    if (translatedName != name) {
        body = QString("<h3 align=\"center\">%1</h3><h4 align=\"center\">%2</h4>%3%4").arg(name, translatedName, image, footerTable);
    }
    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(500.0)));
    doc->setDocumentMargin(margin);
    doc->setUseDesignMetrics(true);
 
    return doc;
}

References KisAbstractResourceModel::BrokenStatusMessage, KisResourceThumbnailCache::getImage(), KoItemToolTip::index, KisResourceThumbnailCache::instance(), KisAbstractResourceModel::Location, m_checkersPainter, m_fixedToolTipThumbnailSize, KisAbstractResourceModel::Name, KisAbstractResourceModel::Tags, KisAbstractResourceModel::Thumbnail, and KisAbstractResourceModel::Tooltip.

setFixedToolTipThumbnailSize()

void KisIconToolTip::setFixedToolTipThumbnailSize

(

const QSize &

size

)

Definition at line 31 of file KisIconToolTip.cpp.

{
    m_fixedToolTipThumbnailSize = size;
}

References m_fixedToolTipThumbnailSize.

setToolTipShouldRenderCheckers()

void KisIconToolTip::setToolTipShouldRenderCheckers

(

bool

value

)

Definition at line 36 of file KisIconToolTip.cpp.

{
    if (value) {
        m_checkersPainter.reset(new KoCheckerBoardPainter(4));
    } else {
        m_checkersPainter.reset();
    }
}

References m_checkersPainter, and value().

Member Data Documentation

m_checkersPainter

QScopedPointer<KoCheckerBoardPainter> KisIconToolTip::m_checkersPainter

private

Definition at line 33 of file KisIconToolTip.h.

m_fixedToolTipThumbnailSize

QSize KisIconToolTip::m_fixedToolTipThumbnailSize

private

Definition at line 32 of file KisIconToolTip.h.

---

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

• libs/resourcewidgets/KisIconToolTip.h
• libs/resourcewidgets/KisIconToolTip.cpp