The QGraphicsEffectSource class represents the source on which a QGraphicsEffect is installed on. More...

#include <qgraphicseffect_p.h>

Inheritance diagram for QGraphicsEffectSource:

Collaboration diagram for QGraphicsEffectSource:

Public Member Functions
	~QGraphicsEffectSource ()
	Destroys the effect source.

const QGraphicsItem *	graphicsItem () const
	Returns a pointer to the item if this source is a QGraphicsItem; otherwise returns \nullptr.

const QWidget *	widget () const
	Returns a pointer to the widget if this source is a QWidget; otherwise returns \nullptr.

const QStyleOption *	styleOption () const
	Returns a pointer to the style options (used when drawing the source) if available; otherwise returns \nullptr.

bool	isPixmap () const
	Returns `true` if the source effectively is a pixmap, e.g., a QGraphicsPixmapItem.

void	draw (QPainter *painter)
	Draws the source using the given painter.

void	update ()
	Schedules a redraw of the source.

QRectF	boundingRect (Qt::CoordinateSystem coordinateSystem=Qt::LogicalCoordinates) const
	Returns the bounding rectangle of the source mapped to the given system.

QRect	deviceRect () const

QPixmap	pixmap (Qt::CoordinateSystem system=Qt::LogicalCoordinates, QPoint *offset=nullptr, QGraphicsEffect::PixmapPadMode mode=QGraphicsEffect::PadToEffectiveBoundingRect) const
	Returns a pixmap with the source painted into it.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
	QGraphicsEffectSource (QGraphicsEffectSourcePrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Friends
class	QGraphicsEffect

class	QGraphicsEffectPrivate

class	QGraphicsScenePrivate

class	QGraphicsItem

class	QGraphicsItemPrivate

class	QWidget

class	QWidgetPrivate

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QGraphicsEffectSource class represents the source on which a QGraphicsEffect is installed on.

When a QGraphicsEffect is installed on a QGraphicsItem, for example, this class will act as a wrapper around QGraphicsItem. Then, calling update() is effectively the same as calling QGraphicsItem::update().

QGraphicsEffectSource also provides a pixmap() function which creates a pixmap with the source painted into it.

See also: QGraphicsItem::setGraphicsEffect(), QWidget::setGraphicsEffect()

Definition at line 31 of file qgraphicseffect_p.h.

Constructor & Destructor Documentation

◆ ~QGraphicsEffectSource()

QGraphicsEffectSource::~QGraphicsEffectSource ( )

Destroys the effect source.

Definition at line 113 of file qgraphicseffect.cpp.

◆ QGraphicsEffectSource()

QGraphicsEffectSource::QGraphicsEffectSource	(	QGraphicsEffectSourcePrivate &	dd,
		QObject *	parent = nullptr )

protected

Definition at line 106 of file qgraphicseffect.cpp.

Member Function Documentation

◆ boundingRect()

QRectF QGraphicsEffectSource::boundingRect ( Qt::CoordinateSystem system = Qt::LogicalCoordinates ) const

Returns the bounding rectangle of the source mapped to the given system.

See also: draw()

Definition at line 121 of file qgraphicseffect.cpp.

◆ deviceRect()

QRect QGraphicsEffectSource::deviceRect ( ) const

◆ draw()

void QGraphicsEffectSource::draw ( QPainter * painter )

Draws the source using the given painter.

This function should only be called from QGraphicsEffect::draw().

See also: QGraphicsEffect::draw()

Definition at line 183 of file qgraphicseffect.cpp.

◆ graphicsItem()

const QGraphicsItem * QGraphicsEffectSource::graphicsItem ( ) const

Returns a pointer to the item if this source is a QGraphicsItem; otherwise returns \nullptr.

See also: widget()

Definition at line 149 of file qgraphicseffect.cpp.

◆ isPixmap()

bool QGraphicsEffectSource::isPixmap ( ) const

Returns true if the source effectively is a pixmap, e.g., a QGraphicsPixmapItem.

This function is useful for optimization purposes. For instance, there's no point in drawing the source in device coordinates to avoid pixmap scaling if this function returns true - the source pixmap will be scaled anyways.

Definition at line 242 of file qgraphicseffect.cpp.

◆ pixmap()

QPixmap QGraphicsEffectSource::pixmap	(	Qt::CoordinateSystem	system = Qt::LogicalCoordinates,
		QPoint *	offset = nullptr,
		QGraphicsEffect::PixmapPadMode	mode = QGraphicsEffect::PadToEffectiveBoundingRect ) const

Returns a pixmap with the source painted into it.

The system specifies which coordinate system to be used for the source. The optional offset parameter returns the offset where the pixmap should be painted at using the current painter.

The mode determines how much of the effect the pixmap will contain. By default, the pixmap will contain the whole effect.

The returned pixmap is bound to the current painter's device rectangle when system is Qt::DeviceCoordinates.

See also: QGraphicsEffect::draw(), boundingRect()

Definition at line 275 of file qgraphicseffect.cpp.

◆ styleOption()

const QStyleOption * QGraphicsEffectSource::styleOption ( ) const

Returns a pointer to the style options (used when drawing the source) if available; otherwise returns \nullptr.

See also: graphicsItem(), widget()

Definition at line 171 of file qgraphicseffect.cpp.

◆ update()

void QGraphicsEffectSource::update ( )

Schedules a redraw of the source.

Call this function whenever the source needs to be redrawn.

See also: QGraphicsEffect::updateBoundingRect(), QWidget::update(), QGraphicsItem::update(),

Definition at line 229 of file qgraphicseffect.cpp.

◆ widget()

const QWidget * QGraphicsEffectSource::widget ( ) const

Returns a pointer to the widget if this source is a QWidget; otherwise returns \nullptr.

See also: graphicsItem()

Definition at line 160 of file qgraphicseffect.cpp.

Friends And Related Symbol Documentation

◆ QGraphicsEffect

friend class QGraphicsEffect

friend

Definition at line 56 of file qgraphicseffect_p.h.

◆ QGraphicsEffectPrivate

friend class QGraphicsEffectPrivate

friend

Definition at line 57 of file qgraphicseffect_p.h.

◆ QGraphicsItem

friend class QGraphicsItem

friend

Definition at line 59 of file qgraphicseffect_p.h.

◆ QGraphicsItemPrivate

friend class QGraphicsItemPrivate

friend

Definition at line 60 of file qgraphicseffect_p.h.

◆ QGraphicsScenePrivate

friend class QGraphicsScenePrivate

friend

Definition at line 58 of file qgraphicseffect_p.h.

◆ QWidget

friend class QWidget

friend

Definition at line 61 of file qgraphicseffect_p.h.

◆ QWidgetPrivate

friend class QWidgetPrivate

friend

Definition at line 62 of file qgraphicseffect_p.h.

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

qtbase/src/widgets/effects/qgraphicseffect_p.h (2946447f50bc03ae5c9b5b9668d43ca7223a53c1)
qtbase/src/widgets/effects/qgraphicseffect.cpp (05fc3aef53348fb58be6308076e000825b704e58)

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~QGraphicsEffectSource()

◆ QGraphicsEffectSource()

Member Function Documentation

◆ boundingRect()

◆ deviceRect()

◆ draw()

◆ graphicsItem()

◆ isPixmap()

◆ pixmap()

◆ styleOption()

◆ update()

◆ widget()

Friends And Related Symbol Documentation

◆ QGraphicsEffect

◆ QGraphicsEffectPrivate

◆ QGraphicsItem

◆ QGraphicsItemPrivate

◆ QGraphicsScenePrivate

◆ QWidget

◆ QWidgetPrivate