kde-workspace/kate/part/view/katefadeeffect.h
Ivailo Monev f68295ea28 generic: move sub-projects from kde-baseapps [ci reset]
Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
2022-05-14 21:56:54 +03:00

86 lines
2.3 KiB
C++

/* This file is part of the KDE and the Kate project
*
* Copyright (C) 2013 Dominik Haumann <dhaumann@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KATE_FADE_EFFECT_H
#define KATE_FADE_EFFECT_H
#include <QObject>
#include <QPointer>
#include <QWidget>
#include <QTimeLine>
#include <QGraphicsOpacityEffect>
/**
* This class provides a fade in/out effect for arbitrary QWidget%s.
* Example:
* \code
* KateFadeEffect* fadeEffect = new KateFadeEffect(someWidget);
* fadeEffect->fadeIn();
* //...
* fadeEffect->fadeOut();
* \endcode
*/
class KateFadeEffect : public QObject
{
Q_OBJECT
public:
/**
* Constructor.
* By default, the widget is fully opaque (opacity = 1.0).
*/
KateFadeEffect(QWidget* widget = 0);
public Q_SLOTS:
/**
* Call to fade out and hide the widget.
*/
void fadeOut();
/**
* Call to show and fade in the widget
*/
void fadeIn();
Q_SIGNALS:
/**
* This signal is emitted when the hiding animation is finished.
* At this point, the associated widget is hidden.
*/
void widgetHidden();
protected Q_SLOTS:
/**
* Helper to update opacity value
*/
void opacityChanged(qreal value);
/**
* When the animation is finished, hide the widget if fading out.
*/
void animationFinished();
private:
QPointer<QWidget> m_widget; ///< the fading widget
QTimeLine* m_timeLine; ///< update time line
QPointer<QGraphicsOpacityEffect> m_effect; ///< graphics opacity effect
};
#endif
// kate: space-indent on; indent-width 2; replace-tabs on;