KateFadeEffect

Search for usage in LXR

#include <katefadeeffect.h>

Inheritance diagram for KateFadeEffect:

Signals

void hideAnimationFinished ()
 
void showAnimationFinished ()
 

Public Slots

void fadeIn ()
 
void fadeOut ()
 

Public Member Functions

 KateFadeEffect (QWidget *widget=nullptr)
 
bool isHideAnimationRunning () const
 
bool isShowAnimationRunning () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

void animationFinished ()
 
void opacityChanged (qreal value)
 

Additional Inherited Members

- Public Types inherited from QObject
typedef  QObjectList
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This class provides a fade in/out effect for arbitrary QWidgets.

Example:

KateFadeEffect* fadeEffect = new KateFadeEffect(someWidget);
fadeEffect->fadeIn();
//...
fadeEffect->fadeOut();
This class provides a fade in/out effect for arbitrary QWidgets.
void fadeOut()
Call to fade out and hide the widget.
void fadeIn()
Call to show and fade in the widget.
KateFadeEffect(QWidget *widget=nullptr)
Constructor.

Definition at line 26 of file katefadeeffect.h.

Constructor & Destructor Documentation

◆ KateFadeEffect()

KateFadeEffect::KateFadeEffect ( QWidget * widget = nullptr)
explicit

Constructor.

By default, the widget is fully opaque (opacity = 1.0).

Definition at line 13 of file katefadeeffect.cpp.

Member Function Documentation

◆ animationFinished

void KateFadeEffect::animationFinished ( )
protectedslot

When the animation is finished, hide the widget if fading out.

Definition at line 86 of file katefadeeffect.cpp.

◆ fadeIn

void KateFadeEffect::fadeIn ( )
slot

Call to show and fade in the widget.

Definition at line 35 of file katefadeeffect.cpp.

◆ fadeOut

void KateFadeEffect::fadeOut ( )
slot

Call to fade out and hide the widget.

Definition at line 58 of file katefadeeffect.cpp.

◆ hideAnimationFinished

void KateFadeEffect::hideAnimationFinished ( )
signal

This signal is emitted when the fadeOut animation is finished, started by calling fadeOut().

If animations are disabled, this signal is emitted immediately.

◆ isHideAnimationRunning()

bool KateFadeEffect::isHideAnimationRunning ( ) const

Check whether the hide animation started by calling fadeOut() is still running.

If animations are disabled, this function always returns false.

Definition at line 25 of file katefadeeffect.cpp.

◆ isShowAnimationRunning()

bool KateFadeEffect::isShowAnimationRunning ( ) const

Check whether the show animation started by calling fadeIn() is still running.

If animations are disabled, this function always returns false.

Definition at line 30 of file katefadeeffect.cpp.

◆ opacityChanged

void KateFadeEffect::opacityChanged ( qreal value)
protectedslot

Helper to update opacity value.

Definition at line 80 of file katefadeeffect.cpp.

◆ showAnimationFinished

void KateFadeEffect::showAnimationFinished ( )
signal

This signal is emitted when the fadeIn animation is finished, started by calling fadeIn().

If animations are disabled, this signal is emitted immediately.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:05:19 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.