KoItemToolTip Class Reference

#include <KoItemToolTip.h>

Inheritance diagram for KoItemToolTip:

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

Public Attributes
std::unique_ptr< QTextDocument >	document
QPersistentModelIndex	index
QPoint	pos
QTimer	timer

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

Private Member Functions
void	updatePosition (const QPoint &pos, const QStyleOptionViewItem &option)
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
std::unique_ptr< Private > const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

Base class for tooltips that can show extensive information about the contents of the data pointed to by something that contains a QModelIndex. Subclasses need to use this data to create a QTextDocument that is formatted to provide the complete tooltip.

Definition at line 33 of file KoItemToolTip.cpp.

Constructor & Destructor Documentation

KoItemToolTip()

KoItemToolTip::KoItemToolTip

(

QWidget *

parent

)

Definition at line 42 of file KoItemToolTip.cpp.

    : QFrame(parent, Qt::FramelessWindowHint | Qt::ToolTip | Qt::WindowStaysOnTopHint | Qt::X11BypassWindowManagerHint)
    , d(new Private)
{
    Q_ASSERT(parent);
 
    d->timer.setSingleShot(true);
    d->timer.setInterval(10000);
    connect(&d->timer, &QTimer::timeout, this, &KoItemToolTip::hide);
 
    d->document.reset(new QTextDocument(this));
 
    parent->installEventFilter(this);
}

References d.

~KoItemToolTip()

KoItemToolTip::~KoItemToolTip ( )

override

Definition at line 57 of file KoItemToolTip.cpp.

{
}

Member Function Documentation

createDocument()

virtual QTextDocument * KoItemToolTip::createDocument ( const QModelIndex & index )

protectedpure virtual

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;

Implemented in KisIconToolTip, and NodeToolTip.

eventFilter()

bool KoItemToolTip::eventFilter ( QObject * object, QEvent * event )

overrideprotected

Definition at line 165 of file KoItemToolTip.cpp.

{
    switch(event->type())
    {
        case QEvent::Leave:
            hide();
        default: break;
    }
 
    return QFrame::eventFilter(object, event);
}

paintEvent()

void KoItemToolTip::paintEvent ( QPaintEvent * e )

overrideprotected

Definition at line 158 of file KoItemToolTip.cpp.

{
    QPainter p(this);
    d->document->drawContents(&p, rect());
    p.drawRect(0, 0, width() - 1, height() - 1);
}

References d, and p.

showTip()

void KoItemToolTip::showTip	(	const QPoint &	pos,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index )

Definition at line 61 of file KoItemToolTip.cpp.

{
    std::unique_ptr<QTextDocument> doc(createDocument(index));
 
    QPoint p = (isVisible() && index == d->index) ? d->pos : pos;
 
    if (!isVisible() || index != d->index || doc->toHtml() != d->document->toHtml()) {
        d->pos = p;
        d->index = index;
        d->document.swap(doc);
        updatePosition(p, option);
        if (!isVisible())
            show();
        else
            update();
    }
 
    d->timer.start();
}

References createDocument(), d, index, p, pos, and updatePosition().

sizeHint()

QSize KoItemToolTip::sizeHint ( ) const

override

Definition at line 153 of file KoItemToolTip.cpp.

{
    return d->document->size().toSize();
}

References d.

updatePosition()

void KoItemToolTip::updatePosition ( const QPoint & pos, const QStyleOptionViewItem & option )

private

Definition at line 81 of file KoItemToolTip.cpp.

{
    QWidget *widget = parentWidget();
    KIS_SAFE_ASSERT_RECOVER_RETURN(widget);
 
    const QPoint gpos = widget->mapToGlobal(pos);
    const QSize size = sizeHint();
 
    // resize **must** come before `setParentControlGeometry()`, otherwise
    // compositor will place the window incorrectly!
    resize(size);
 
    // make sure that all the platform-specific structures for the window
    // are created (i.e. QWaylandWindow) before trying to request them
    // via `windowHandle()->handle()`
    create();
 
#ifdef HAVE_QT_PRIVATE_TOOLTIP_POSITION_API
 
    if (auto waylandWindow = dynamic_cast<QNativeInterface::Private::QWaylandWindow *>(windowHandle()->handle())) {
 
        const QPoint parentPos = widget->window()->mapFromGlobal(gpos);
        const QRect gravityRect(parentPos.x() - 20, parentPos.y() - 20, 40, 40);
        waylandWindow->setParentControlGeometry(gravityRect);
        waylandWindow->setExtendedWindowType(QNativeInterface::Private::QWaylandWindow::ToolTip);
    } else
#endif /* HAVE_QT_PRIVATE_TOOLTIP_POSITION_API */
 
    {
        QScreen *screen = widget->screen();
        const QRect availableRect = screen->availableGeometry();
        const int width = size.width(), height = size.height();
        const QRect itemRect(widget->mapToGlobal(option.rect.topLeft()), option.rect.size());
 
        int y = gpos.y() + 20;
        if (y + height > availableRect.bottom()) {
            y = itemRect.bottom();
 
            if (y + height > availableRect.bottom()) {
                y = gpos.y() - 20 - height;
 
                if (y < availableRect.top()) {
                    y = itemRect.top() - height;
 
                    if (y < availableRect.top()) {
                        y = availableRect.top();
                    }
                }
            }
        }
 
        int x = gpos.x() + 20;
        if (x + width > availableRect.right()) {
            x = itemRect.right();
 
            if (x + width > availableRect.right()) {
                x = gpos.x() - 20 - width;
 
                if (x < availableRect.left()) {
                    x = itemRect.left() - width;
 
                    if (x < availableRect.left()) {
                        x = availableRect.left();
                    }
                }
            }
        }
 
        move(QPoint(x, y));
    }
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, pos, and sizeHint().

Member Data Documentation

d

std::unique_ptr<Private> const KoItemToolTip::d

private

Definition at line 58 of file KoItemToolTip.h.

document

std::unique_ptr<QTextDocument> KoItemToolTip::document

Definition at line 36 of file KoItemToolTip.cpp.

index

QPersistentModelIndex KoItemToolTip::index

Definition at line 37 of file KoItemToolTip.cpp.

pos

QPoint KoItemToolTip::pos

Definition at line 38 of file KoItemToolTip.cpp.

timer

QTimer KoItemToolTip::timer

Definition at line 39 of file KoItemToolTip.cpp.

---

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

• libs/widgetutils/KoItemToolTip.cpp
• libs/widgetutils/KoItemToolTip.h