KPixmapSequenceOverlayPainter

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 (QObject *parent=nullptr)
 
 KPixmapSequenceOverlayPainter (const KPixmapSequence &seq, 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)
 
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
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_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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[email protected]@kde[email protected].org
Since
4.4

Definition at line 46 of file kpixmapsequenceoverlaypainter.h.

Constructor & Destructor Documentation

KPixmapSequenceOverlayPainter::KPixmapSequenceOverlayPainter ( QObject parent = nullptr)
explicit

Constructor.

Definition at line 118 of file kpixmapsequenceoverlaypainter.cpp.

KPixmapSequenceOverlayPainter::~KPixmapSequenceOverlayPainter ( )
override

Destructor.

Definition at line 133 of file kpixmapsequenceoverlaypainter.cpp.

Member Function Documentation

Qt::Alignment KPixmapSequenceOverlayPainter::alignment ( ) const

The alignment of the pixmaps in the rect.

See also
setAlignment

Definition at line 160 of file kpixmapsequenceoverlaypainter.cpp.

int KPixmapSequenceOverlayPainter::interval ( ) const

The interval between frames.

See also
setInterval

Definition at line 144 of file kpixmapsequenceoverlaypainter.cpp.

QPoint KPixmapSequenceOverlayPainter::offset ( ) const

The optional offset within the rect.

See also
setOffset

Definition at line 165 of file kpixmapsequenceoverlaypainter.cpp.

QRect KPixmapSequenceOverlayPainter::rect ( ) const

The optional rect to draw the pixmaps in.

See also
setRect

Definition at line 149 of file kpixmapsequenceoverlaypainter.cpp.

KPixmapSequence KPixmapSequenceOverlayPainter::sequence ( ) const

The sequence used to draw the overlay.

See also
setSequence

Definition at line 139 of file kpixmapsequenceoverlaypainter.cpp.

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

Set the alignment of the sequence in rect.

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

Definition at line 201 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setInterval ( int  msecs)
slot

Set the interval between frames.

The default is 200.

Definition at line 180 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setOffset ( const QPoint offset)
slot

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

Parameters
offsetAn optional offset which allows an absolute placement.

Defaults to an empty point.

Definition at line 211 of file kpixmapsequenceoverlaypainter.cpp.

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
rectThe 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 191 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setSequence ( const KPixmapSequence seq)
slot

Set the sequence to be used.

By default the KDE busy sequence is used.

Definition at line 170 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setWidget ( QWidget w)
slot

Set the widget to draw the overlay on.

Definition at line 185 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::start ( )
slot

Start drawing the sequence.

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

Definition at line 221 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::stop ( )
slot

Stop drawing the overlay.

Definition at line 236 of file kpixmapsequenceoverlaypainter.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun May 31 2020 22:51:57 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.