ditemtooltip.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-12-10
 * Description : tool tip widget for iconview, thumbbar, and folderview items
 *
 * Copyright (C) 2008-2022 by Gilles Caulier <caulier dot gilles at gmail dot 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, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DITEM_TOOL_TIP_H
#define DIGIKAM_DITEM_TOOL_TIP_H
 
// Qt includes
 
#include <QFont>
#include <QLabel>
#include <QResizeEvent>
#include <QString>
#include <QImage>
#include <QEvent>
#include <QFontDatabase>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DToolTipStyleSheet
{
 
public:
 
    explicit DToolTipStyleSheet(const QFont& font = QFontDatabase::systemFont(QFontDatabase::GeneralFont));
 
    QString breakString(const QString& input)                        const;
    QString elidedText(const QString& input, Qt::TextElideMode mode) const;
    QString imageAsBase64(const QImage& img)                         const;
 
public:
 
    const int maxStringLength;
 
    QString   unavailable;
    QString   tipHeader;
    QString   tipFooter;
    QString   headBeg;
    QString   headEnd;
    QString   cellBeg;
    QString   cellMid;
    QString   cellEnd;
    QString   cellSpecBeg;
    QString   cellSpecMid;
    QString   cellSpecEnd;
};
 
// --------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT DItemToolTip : public QLabel
{
    Q_OBJECT
 
public:
 
    explicit DItemToolTip(QWidget* const parent = nullptr);
    ~DItemToolTip() override;
 
protected:
 
    bool    event(QEvent*)                    override;
    void    resizeEvent(QResizeEvent*)        override;
    void    paintEvent(QPaintEvent*)          override;
    void    updateToolTip();
    bool    toolTipIsEmpty()            const;
    void    reposition();
    void    renderArrows();
 
protected:
 
    virtual QRect   repositionRect() = 0;
    virtual QString tipContents()    = 0;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DITEM_TOOL_TIP_H