KateAnimation Class Reference

#include <kateanimation.h>

Inheritance diagram for KateAnimation:

Public Types
enum	EffectType { FadeEffect = 0, GrowEffect }

Public Slots
void	hide ()
void	show ()

Signals
void	widgetHidden ()
void	widgetShown ()

Public Member Functions
	KateAnimation (KMessageWidget *widget, EffectType effect)
bool	hideAnimationActive () const
bool	showAnimationActive () const

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 41 of file kateanimation.h.

Member Enumeration Documentation

enum KateAnimation::EffectType

The type of supported animation effects.

Enumerator
FadeEffect	fade in/out
GrowEffect	grow / shrink

Definition at line 49 of file kateanimation.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 29 of file kateanimation.cpp.

Member Function Documentation

void KateAnimation::hide ( )

slot

Call to hide the widget.

Definition at line 92 of file kateanimation.cpp.

bool KateAnimation::hideAnimationActive

(

)

const

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

Definition at line 54 of file kateanimation.cpp.

void KateAnimation::show ( )

slot

Call to show and fade in the widget.

Definition at line 64 of file kateanimation.cpp.

bool KateAnimation::showAnimationActive

(

)

const

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

Definition at line 59 of file kateanimation.cpp.

void KateAnimation::widgetHidden ( )

signal

This signal is emitted when the hiding animation is finished.

At this point, the associated widget is hidden.

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