KPixmapSequenceOverlayPainter Class Reference

#include <KPixmapSequenceOverlayPainter>

Inheritance diagram for KPixmapSequenceOverlayPainter:

Public Slots
void	setAlignment (Qt::Alignment align)
void	setInterval (int msecs)
void	setOffset (const QPoint &offset)
void	setRect (const QRect &rect)
void	setSequence (const KPixmapSequence &seq)
void	setWidget (QWidget *w)
void	start ()
void	stop ()

Public Member Functions
	KPixmapSequenceOverlayPainter (const KPixmapSequence &seq, QObject *parent=nullptr)
	KPixmapSequenceOverlayPainter (QObject *parent=nullptr)
	~KPixmapSequenceOverlayPainter () override
Qt::Alignment	alignment () const
int	interval () const
QPoint	offset () const
QRect	rect () const
KPixmapSequence	sequence () 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)
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

Protected Member Functions
bool	eventFilter (QObject *obj, QEvent *event) override
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)

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)

Detailed Description

Paints a KPixmapSequence on top of any widget at any position.

The KPixmapSequenceOverlayPainter paints an overlay on top of an arbitrary QWidget using a KPixmapSequence. This is typically used for spinners indicating that a process is not finished yet.

Author

Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org

Since

4.4

Definition at line 34 of file kpixmapsequenceoverlaypainter.h.

Constructor & Destructor Documentation

KPixmapSequenceOverlayPainter() [1/2]

KPixmapSequenceOverlayPainter::KPixmapSequenceOverlayPainter ( QObject * parent = nullptr )

explicit

Constructor.

Definition at line 106 of file kpixmapsequenceoverlaypainter.cpp.

KPixmapSequenceOverlayPainter() [2/2]

KPixmapSequenceOverlayPainter::KPixmapSequenceOverlayPainter	(	const KPixmapSequence &	seq,
		QObject *	parent = nullptr )

Definition at line 113 of file kpixmapsequenceoverlaypainter.cpp.

~KPixmapSequenceOverlayPainter()

KPixmapSequenceOverlayPainter::~KPixmapSequenceOverlayPainter ( )

override

Destructor.

Definition at line 121 of file kpixmapsequenceoverlaypainter.cpp.

Member Function Documentation

alignment()

Qt::Alignment KPixmapSequenceOverlayPainter::alignment

(

)

const

The alignment of the pixmaps in the rect.

See also

setAlignment

Definition at line 147 of file kpixmapsequenceoverlaypainter.cpp.

eventFilter()

bool KPixmapSequenceOverlayPainter::eventFilter ( QObject * obj, QEvent * event )

overrideprotectedvirtual

Reimplemented from QObject.

Definition at line 233 of file kpixmapsequenceoverlaypainter.cpp.

interval()

int KPixmapSequenceOverlayPainter::interval

(

)

const

The interval between frames.

See also

setInterval

Definition at line 131 of file kpixmapsequenceoverlaypainter.cpp.

offset()

QPoint KPixmapSequenceOverlayPainter::offset

(

)

const

The optional offset within the rect.

See also

setOffset

Definition at line 152 of file kpixmapsequenceoverlaypainter.cpp.

rect()

QRect KPixmapSequenceOverlayPainter::rect

(

)

const

The optional rect to draw the pixmaps in.

See also

setRect

Definition at line 136 of file kpixmapsequenceoverlaypainter.cpp.

sequence()

KPixmapSequence KPixmapSequenceOverlayPainter::sequence

(

)

const

The sequence used to draw the overlay.

See also

setSequence

Definition at line 126 of file kpixmapsequenceoverlaypainter.cpp.

setAlignment

void KPixmapSequenceOverlayPainter::setAlignment ( Qt::Alignment align )

slot

Set the alignment of the sequence in rect.

Parameters

align

alignment of the overlay. Qt::AlignJustify does not make sense here. Defaults to Qt::Center.

Definition at line 188 of file kpixmapsequenceoverlaypainter.cpp.

setInterval

void KPixmapSequenceOverlayPainter::setInterval ( int msecs )

slot

Set the interval between frames.

The default is 200.

Definition at line 167 of file kpixmapsequenceoverlaypainter.cpp.

setOffset

void KPixmapSequenceOverlayPainter::setOffset ( const QPoint & offset )

slot

Set the offset relative to the placement determined by alignment and rect.

Parameters

offset

An optional offset which allows an absolute placement.

Defaults to an empty point.

Definition at line 198 of file kpixmapsequenceoverlaypainter.cpp.

setRect

void KPixmapSequenceOverlayPainter::setRect ( const QRect & rect )

slot

Set the rect in which to place the sequence.

Be aware that this optional property does not scale the pixmaps (except if it is smaller) but allows to change the placement.

Parameters

rect	The rect in which to draw the pixmap using alignment and offset. Be aware that setting a rect bigger than the widget can lead to weird painting errors.

Defaults to the widget's rect.

Definition at line 178 of file kpixmapsequenceoverlaypainter.cpp.

setSequence

void KPixmapSequenceOverlayPainter::setSequence ( const KPixmapSequence & seq )

slot

Set the sequence to be used.

By default the KDE busy sequence is used.

Definition at line 157 of file kpixmapsequenceoverlaypainter.cpp.

setWidget

void KPixmapSequenceOverlayPainter::setWidget ( QWidget * w )

slot

Set the widget to draw the overlay on.

Definition at line 172 of file kpixmapsequenceoverlaypainter.cpp.

start

void KPixmapSequenceOverlayPainter::start ( )

slot

Start drawing the sequence.

The overlay will be drawn until a call to stop()

Definition at line 208 of file kpixmapsequenceoverlaypainter.cpp.

stop

void KPixmapSequenceOverlayPainter::stop ( )

slot

Stop drawing the overlay.

Definition at line 223 of file kpixmapsequenceoverlaypainter.cpp.

---

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

• kpixmapsequenceoverlaypainter.h
• kpixmapsequenceoverlaypainter.cpp