KateAnimation Class Reference

#include <kateanimation.h>

Inheritance diagram for KateAnimation:

Public Types
enum	EffectType { FadeEffect = 0 , GrowEffect }
Public Types inherited from QObject
typedef	QObjectList

Signals
void	widgetHidden ()
void	widgetShown ()

Public Slots
void	hide ()
void	show ()

Public Member Functions
	KateAnimation (KMessageWidget *widget, EffectType effect)
bool	isHideAnimationRunning () const
bool	isShowAnimationRunning () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	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 QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () 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
T	qobject_cast (const QObject *object)
T	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)
QThread *	thread () const const

Additional Inherited Members
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

This class provides a fade in/out effect for KMessageWidgets.

Example:

KateAnimation* animation = new KateAnimation(someMessageWidget);
animation->show();
//...
animation->hide();

Definition at line 27 of file kateanimation.h.

Member Enumeration Documentation

EffectType

enum KateAnimation::EffectType

The type of supported animation effects.

Enumerator
FadeEffect	fade in/out
GrowEffect	grow / shrink

Definition at line 35 of file kateanimation.h.

Constructor & Destructor Documentation

KateAnimation()

KateAnimation::KateAnimation	(	KMessageWidget *	widget,
		EffectType	effect )

Constructor.

Definition at line 17 of file kateanimation.cpp.

Member Function Documentation

hide

void KateAnimation::hide ( )

slot

Call to hide the widget.

Definition at line 65 of file kateanimation.cpp.

isHideAnimationRunning()

bool KateAnimation::isHideAnimationRunning

(

)

const

Returns true, if the hide animation is running, otherwise false.

Definition at line 36 of file kateanimation.cpp.

isShowAnimationRunning()

bool KateAnimation::isShowAnimationRunning

(

)

const

Returns true, if the how animation is running, otherwise false.

Definition at line 41 of file kateanimation.cpp.

show

void KateAnimation::show ( )

slot

Call to show and fade in the widget.

Definition at line 46 of file kateanimation.cpp.

widgetHidden

void KateAnimation::widgetHidden ( )

signal

This signal is emitted when the hiding animation is finished.

At this point, the associated widget is hidden.

widgetShown

void KateAnimation::widgetShown ( )

signal

This signal is emitted when the showing animation is finished.

At this point, the associated widget is hidden.

---

The documentation for this class was generated from the following files:

• kateanimation.h
• kateanimation.cpp