plasma-framework/src/declarativeimports/core/tooltip.h
Sebastian Kügler 3859dbdd07 Improve API docs
2013-04-09 04:02:19 +02:00

81 lines
2.9 KiB
C++

/***************************************************************************
* Copyright 2011 Marco Martin <mart@kde.org> *
* Copyright 2011 Artur Duque de Souza <asouza@kde.org> *
* Copyright 2013 Sebastian Kügler <sebas@kde.org> *
* *
* 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 of the License, 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. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA . *
***************************************************************************/
#ifndef TOOLTIPOBJECT_H
#define TOOLTIPOBJECT_H
#include <QQuickItem>
#include <QWeakPointer>
#include <QtCore/QVariant>
class QQuickItem;
class QGraphicsWidget;
/**
* Exposed as `ToolTipProxy` in QML. This is used only internally for WIndow handling
*
* DO NOT USE THIS API, PlasmaCore.ToolTip is what you should use.
*/
class ToolTip : public QObject
{
Q_OBJECT
/**
* The item shown inside the tooltip.
*/
Q_PROPERTY(QQuickItem *mainItem READ mainItem WRITE setMainItem NOTIFY mainItemChanged)
/**
* The main QML item that will be displayed in the Dialog
*/
Q_PROPERTY(QQuickItem *visualParent READ visualParent WRITE setVisualParent NOTIFY visualParentChanged)
/**
* Visibility of the Dialog window. Doesn't have anything to do with the visibility of the mainItem.
*/
Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged)
public:
ToolTip(QObject *parent = 0);
~ToolTip();
QQuickItem *mainItem() const;
void setMainItem(QQuickItem *mainItem);
QQuickItem *visualParent() const;
void setVisualParent(QQuickItem *visualParent);
bool isVisible() const;
void setVisible(const bool visible);
Q_SIGNALS:
void mainItemChanged();
void visualParentChanged();
void visibleChanged();
private:
QWeakPointer<QQuickItem> m_mainItem;
QWeakPointer<QQuickItem> m_visualParent;
};
#endif