tooltipcontent.h

Go to the documentation of this file.

/*
 * Copyright 2008 by Aaron Seigo <aseigo@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

#ifndef PLASMA_TOOLTIPCONTENT_H
#define PLASMA_TOOLTIPCONTENT_H

#include <QtCore/QString>
#include <QtCore/QUrl>
#include <QtCore/QVariant>
#include <QtCore/QList>
#include <QtGui/QPixmap>
#include <QtGui/QIcon>

#include <plasma/plasma_export.h>

class QTextDocument;
class QGraphicsWidget;

namespace Plasma
{

class ToolTipContentPrivate;

class PLASMA_EXPORT ToolTipContent
{
public:
    enum ResourceType { ImageResource = 0, HtmlResource, CssResource };

    ToolTipContent();

    ~ToolTipContent();

    ToolTipContent(const ToolTipContent &other);

    ToolTipContent(const QString &mainText,
                   const QString &subText,
                   const QPixmap &image = QPixmap());

    ToolTipContent(const QString &mainText,
                   const QString &subText,
                   const QIcon &icon);

    ToolTipContent &operator=(const ToolTipContent &other);

    bool isEmpty() const;

    void setMainText(const QString &text);

    QString mainText() const;

    void setSubText(const QString &text) ;

    QString subText() const;

    void setImage(const QPixmap &image);

    void setImage(const QIcon &icon);

    QPixmap image() const;

    KDE_DEPRECATED void setWindowToPreview(WId id);

    KDE_DEPRECATED WId windowToPreview() const;

    void setWindowsToPreview(const QList<WId> &ids);

    QList<WId> windowsToPreview() const;

    void setHighlightWindows(bool highlight);

    bool highlightWindows() const;

    void setAutohide(bool autohide);

    bool autohide() const;

    void setInstantPopup(bool enabled);

    bool isInstantPopup() const;

    void addResource(ResourceType type, const QUrl &path, const QVariant &resource);

    void registerResources(QTextDocument *document) const;

    void setClickable(bool clickable);

    bool isClickable() const;

    void setGraphicsWidget(QGraphicsWidget *widget);

    QGraphicsWidget *graphicsWidget() const;

private:
    ToolTipContentPrivate * const d;
};

} // namespace Plasma

#endif