The QPixmapDropShadowFilter class is a convenience class for drawing pixmaps with drop shadows. More...

#include <qpixmapfilter_p.h>

Inheritance diagram for QPixmapDropShadowFilter:

Collaboration diagram for QPixmapDropShadowFilter:

Public Member Functions
	QPixmapDropShadowFilter (QObject *parent=nullptr)
	Constructs drop shadow filter.

	~QPixmapDropShadowFilter ()
	Destroys drop shadow filter.

QRectF	boundingRectFor (const QRectF &rect) const override

void	draw (QPainter *p, const QPointF &pos, const QPixmap &px, const QRectF &src=QRectF()) const override

qreal	blurRadius () const
	Returns the radius in pixels of the blur on the drop shadow.

void	setBlurRadius (qreal radius)
	Sets the radius in pixels of the blur on the drop shadow to the radius specified.

QColor	color () const
	Returns the color of the drop shadow.

void	setColor (const QColor &color)
	Sets the color of the drop shadow to the color specified.

QPointF	offset () const
	Returns the shadow offset in pixels.

void	setOffset (const QPointF &offset)
	Sets the shadow offset in pixels to the offset specified.

void	setOffset (qreal dx, qreal dy)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the shadow offset in pixels to be the displacement specified by the horizontal dx and vertical dy coordinates.

Public Member Functions inherited from QPixmapFilter
virtual	~QPixmapFilter ()=0
	Destroys the pixmap filter.

FilterType	type () const
	Returns the type of the filter.

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`.

Additional Inherited Members
Public Types inherited from QPixmapFilter
enum	FilterType { ConvolutionFilter , ColorizeFilter , DropShadowFilter , BlurFilter , UserFilter = 1024 }

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 Member Functions inherited from QPixmapFilter
	QPixmapFilter (QPixmapFilterPrivate &d, FilterType type, QObject *parent)

	QPixmapFilter (FilterType type, QObject *parent)
	Constructs a default QPixmapFilter with the given type.

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)

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 QPixmapDropShadowFilter class is a convenience class for drawing pixmaps with drop shadows.

Since: 4.5

The drop shadow is produced by taking a copy of the source pixmap and applying a color to the copy using a QPainter::CompositionMode_DestinationIn operation. This produces a homogeneously-colored pixmap which is then drawn using a QPixmapConvolutionFilter at an offset. The original pixmap is drawn on top.

The QPixmapDropShadowFilter class provides some customization options to specify how the drop shadow should appear. The color of the drop shadow can be modified using the setColor() function, the drop shadow offset can be modified using the setOffset() function, and the blur radius of the drop shadow can be changed through the setBlurRadius() function.

By default, the drop shadow is a dark gray shadow, blurred with a radius of 1 at an offset of 8 pixels towards the lower right.

Example:

QPixmapDropShadowFilter *myFilter = new QPixmapDropShadowFilter;

myFilter->draw(painter, QPoint(0, 0), originalPixmap);

See also: QPixmapColorizeFilter, QPixmapConvolutionFilter

Definition at line 125 of file qpixmapfilter_p.h.

Constructor & Destructor Documentation

◆ QPixmapDropShadowFilter()

QPixmapDropShadowFilter::QPixmapDropShadowFilter ( QObject * parent = nullptr )

Constructs drop shadow filter.

Definition at line 854 of file qpixmapfilter.cpp.

◆ ~QPixmapDropShadowFilter()

QPixmapDropShadowFilter::~QPixmapDropShadowFilter ( )

Destroys drop shadow filter.

Definition at line 864 of file qpixmapfilter.cpp.

Member Function Documentation

◆ blurRadius()

qreal QPixmapDropShadowFilter::blurRadius ( ) const

Returns the radius in pixels of the blur on the drop shadow.

A smaller radius results in a sharper shadow.

See also: color(), offset()

Definition at line 877 of file qpixmapfilter.cpp.

References d.

◆ boundingRectFor()

QRectF QPixmapDropShadowFilter::boundingRectFor ( const QRectF & rect ) const

overridevirtual

Reimplemented from QPixmapFilter.

Definition at line 965 of file qpixmapfilter.cpp.

References d, and rect.

◆ color()

QColor QPixmapDropShadowFilter::color ( ) const

Returns the color of the drop shadow.

See also: blurRadius(), offset()

Definition at line 905 of file qpixmapfilter.cpp.

References d.

Referenced by setColor().

Here is the caller graph for this function:

◆ draw()

void QPixmapDropShadowFilter::draw	(	QPainter *	p,
		const QPointF &	pos,
		const QPixmap &	px,
		const QRectF &	src = QRectF() ) const

overridevirtual

Implements QPixmapFilter.

Definition at line 974 of file qpixmapfilter.cpp.

References QPainter::CompositionMode_Source, QPainter::CompositionMode_SourceIn, d, QImage::fill(), QImage::Format_ARGB32_Premultiplied, pos, qt_blurImage(), QImage::rect(), QImage::setDevicePixelRatio(), and QImage::size().

Here is the call graph for this function:

◆ offset()

QPointF QPixmapDropShadowFilter::offset ( ) const

Returns the shadow offset in pixels.

See also: blurRadius(), color()

Definition at line 931 of file qpixmapfilter.cpp.

References d.

Referenced by setOffset().

Here is the caller graph for this function:

◆ setBlurRadius()

void QPixmapDropShadowFilter::setBlurRadius ( qreal radius )

Sets the radius in pixels of the blur on the drop shadow to the radius specified.

Using a smaller radius results in a sharper shadow.

See also: setColor(), setOffset()

Definition at line 892 of file qpixmapfilter.cpp.

References d.

◆ setColor()

void QPixmapDropShadowFilter::setColor ( const QColor & color )

Sets the color of the drop shadow to the color specified.

See also: setBlurRadius(), setOffset()

Definition at line 918 of file qpixmapfilter.cpp.

References color(), and d.

Here is the call graph for this function:

◆ setOffset() [1/2]

void QPixmapDropShadowFilter::setOffset ( const QPointF & offset )

Sets the shadow offset in pixels to the offset specified.

See also: setBlurRadius(), setColor()

Definition at line 944 of file qpixmapfilter.cpp.

References d, and offset().

Here is the call graph for this function:

◆ setOffset() [2/2]

void QPixmapDropShadowFilter::setOffset	(	qreal	dx,
		qreal	dy )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the shadow offset in pixels to be the displacement specified by the horizontal dx and vertical dy coordinates.

See also: setBlurRadius(), setColor()

Definition at line 145 of file qpixmapfilter_p.h.

References setOffset().

Referenced by setOffset().

Here is the call graph for this function:

Here is the caller graph for this function:

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

qtbase/src/widgets/effects/qpixmapfilter_p.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/widgets/effects/qpixmapfilter.cpp (48124977865b76212ef719b19ff37d6bd82ad82d)

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QPixmapDropShadowFilter()

◆ ~QPixmapDropShadowFilter()

Member Function Documentation

◆ blurRadius()

◆ boundingRectFor()

◆ color()

◆ draw()

◆ offset()

◆ setBlurRadius()

◆ setColor()

◆ setOffset() [1/2]

◆ setOffset() [2/2]