Struct qt_widgets::QGraphicsBlurEffect

#[repr(C)]
pub struct QGraphicsBlurEffect { /* fields omitted */ }

The QGraphicsBlurEffect class provides a blur effect.

C++ class: QGraphicsBlurEffect.

C++ documentation:

The QGraphicsBlurEffect class provides a blur effect.

A blur effect blurs the source. This effect is useful for reducing details, such as when the source loses focus and you want to draw attention to other elements. The level of detail can be modified using the setBlurRadius() function. Use setBlurHints() to choose the blur hints.

By default, the blur radius is 5 pixels. The blur radius is specified in device coordinates.

Methods

impl QGraphicsBlurEffect

pub fn slot_set_blur_radius(&self) -> Receiver<(c_double,)>

This property holds the blur radius of the effect.

Returns a built-in Qt slot QGraphicsBlurEffect::setBlurRadius that can be passed to qt_core::Signal::connect.

C++ documentation:

This property holds the blur radius of the effect.

Using a smaller radius results in a sharper appearance, whereas a bigger radius results in a more blurred appearance.

By default, the blur radius is 5 pixels.

The radius is given in device coordinates, meaning it is unaffected by scale.

Access functions:

qreal	blurRadius() const
void	setBlurRadius(qreal blurRadius)

Notifier signal:

void	blurRadiusChanged(qreal radius)

pub fn slot_set_blur_hints(&self) -> Receiver<(c_int,)>

This property holds the blur hint of the effect.

Returns a built-in Qt slot QGraphicsBlurEffect::setBlurHints that can be passed to qt_core::Signal::connect.

C++ documentation:

This property holds the blur hint of the effect.

Use the PerformanceHint hint to say that you want a faster blur, the QualityHint hint to say that you prefer a higher quality blur, or the AnimationHint when you want to animate the blur radius.

By default, the blur hint is PerformanceHint.

Access functions:

BlurHints	blurHints() const
void	setBlurHints(BlurHints hints)

Notifier signal:

void	blurHintsChanged(BlurHints hints)

pub fn blur_radius_changed(&self) -> Signal<(c_double,)>

This signal is emitted whenever the effect's blur radius changes. The radius parameter holds the effect's new blur radius.

Returns a built-in Qt signal QGraphicsBlurEffect::blurRadiusChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted whenever the effect's blur radius changes. The radius parameter holds the effect's new blur radius.

Note: Notifier signal for property blurRadius.

pub fn blur_hints_changed(&self) -> Signal<(c_int,)>

This signal is emitted whenever the effect's blur hints changes. The hints parameter holds the effect's new blur hints.

Returns a built-in Qt signal QGraphicsBlurEffect::blurHintsChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted whenever the effect's blur hints changes. The hints parameter holds the effect's new blur hints.

Note: Notifier signal for property blurHints.

pub unsafe fn blur_hints(&self) -> QFlags<BlurHint>

This property holds the blur hint of the effect.

Calls C++ function: QFlags<QGraphicsBlurEffect::BlurHint> QGraphicsBlurEffect::blurHints() const.

C++ documentation:

This property holds the blur hint of the effect.

Use the PerformanceHint hint to say that you want a faster blur, the QualityHint hint to say that you prefer a higher quality blur, or the AnimationHint when you want to animate the blur radius.

By default, the blur hint is PerformanceHint.

Access functions:

BlurHints	blurHints() const
void	setBlurHints(BlurHints hints)

Notifier signal:

void	blurHintsChanged(BlurHints hints)

pub unsafe fn blur_radius(&self) -> c_double

This property holds the blur radius of the effect.

Calls C++ function: double QGraphicsBlurEffect::blurRadius() const.

C++ documentation:

This property holds the blur radius of the effect.

Using a smaller radius results in a sharper appearance, whereas a bigger radius results in a more blurred appearance.

By default, the blur radius is 5 pixels.

The radius is given in device coordinates, meaning it is unaffected by scale.

Access functions:

qreal	blurRadius() const
void	setBlurRadius(qreal blurRadius)

Notifier signal:

void	blurRadiusChanged(qreal radius)

pub unsafe fn bounding_rect_for(
    &self,
    rect: impl CastInto<Ref<QRectF>>
) -> CppBox<QRectF>

Reimplemented from QGraphicsEffect::boundingRectFor().

Calls C++ function: virtual QRectF QGraphicsBlurEffect::boundingRectFor(const QRectF& rect) const.

C++ documentation:

Reimplemented from QGraphicsEffect::boundingRectFor().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QGraphicsBlurEffect::metaObject() const.

pub unsafe fn new_1a(
    parent: impl CastInto<MutPtr<QObject>>
) -> CppBox<QGraphicsBlurEffect>

Constructs a new QGraphicsBlurEffect instance. The parent parameter is passed to QGraphicsEffect's constructor.

Calls C++ function: [constructor] void QGraphicsBlurEffect::QGraphicsBlurEffect(QObject* parent = …).

C++ documentation:

Constructs a new QGraphicsBlurEffect instance. The parent parameter is passed to QGraphicsEffect's constructor.

pub unsafe fn new_0a() -> CppBox<QGraphicsBlurEffect>

The QGraphicsBlurEffect class provides a blur effect.

Calls C++ function: [constructor] void QGraphicsBlurEffect::QGraphicsBlurEffect().

C++ documentation:

The QGraphicsBlurEffect class provides a blur effect.

A blur effect blurs the source. This effect is useful for reducing details, such as when the source loses focus and you want to draw attention to other elements. The level of detail can be modified using the setBlurRadius() function. Use setBlurHints() to choose the blur hints.

By default, the blur radius is 5 pixels. The blur radius is specified in device coordinates.

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int

Calls C++ function: virtual int QGraphicsBlurEffect::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>

Calls C++ function: virtual void* QGraphicsBlurEffect::qt_metacast(const char* arg1).

pub unsafe fn set_blur_hints(&mut self, hints: QFlags<BlurHint>)

This property holds the blur hint of the effect.

Calls C++ function: [slot] void QGraphicsBlurEffect::setBlurHints(QFlags<QGraphicsBlurEffect::BlurHint> hints).

C++ documentation:

This property holds the blur hint of the effect.

Use the PerformanceHint hint to say that you want a faster blur, the QualityHint hint to say that you prefer a higher quality blur, or the AnimationHint when you want to animate the blur radius.

By default, the blur hint is PerformanceHint.

Access functions:

BlurHints	blurHints() const
void	setBlurHints(BlurHints hints)

Notifier signal:

void	blurHintsChanged(BlurHints hints)

pub unsafe fn set_blur_radius(&mut self, blur_radius: c_double)

This property holds the blur radius of the effect.

Calls C++ function: [slot] void QGraphicsBlurEffect::setBlurRadius(double blurRadius).

C++ documentation:

This property holds the blur radius of the effect.

Using a smaller radius results in a sharper appearance, whereas a bigger radius results in a more blurred appearance.

By default, the blur radius is 5 pixels.

The radius is given in device coordinates, meaning it is unaffected by scale.

Access functions:

qreal	blurRadius() const
void	setBlurRadius(qreal blurRadius)

Notifier signal:

void	blurRadiusChanged(qreal radius)

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QGraphicsBlurEffect::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QGraphicsBlurEffect::trUtf8(const char* s, const char* c, int n).

Methods from Deref<Target = QGraphicsEffect>

pub fn slot_set_enabled(&self) -> Receiver<(bool,)>

This property holds whether the effect is enabled or not.

Returns a built-in Qt slot QGraphicsEffect::setEnabled that can be passed to qt_core::Signal::connect.

C++ documentation:

This property holds whether the effect is enabled or not.

If an effect is disabled, the source will be rendered with as normal, with no interference from the effect. If the effect is enabled, the source will be rendered with the effect applied.

This property is enabled by default.

Using this property, you can disable certain effects on slow platforms, in order to ensure that the user interface is responsive.

Access functions:

bool	isEnabled() const
void	setEnabled(bool enable)

Notifier signal:

void	enabledChanged(bool enabled)

pub fn slot_update(&self) -> Receiver<()>

Schedules a redraw of the effect. Call this function whenever the effect needs to be redrawn. This function does not trigger a redraw of the source.

Returns a built-in Qt slot QGraphicsEffect::update that can be passed to qt_core::Signal::connect.

C++ documentation:

Schedules a redraw of the effect. Call this function whenever the effect needs to be redrawn. This function does not trigger a redraw of the source.

See also updateBoundingRect().

pub fn enabled_changed(&self) -> Signal<(bool,)>

This signal is emitted whenever the effect is enabled or disabled. The enabled parameter holds the effects's new enabled state.

Returns a built-in Qt signal QGraphicsEffect::enabledChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted whenever the effect is enabled or disabled. The enabled parameter holds the effects's new enabled state.

Note: Notifier signal for property enabled.

See also isEnabled().

pub unsafe fn bounding_rect(&self) -> CppBox<QRectF>

Returns the effective bounding rectangle for this effect, i.e., the bounding rectangle of the source in device coordinates, adjusted by any margins applied by the effect itself.

Calls C++ function: QRectF QGraphicsEffect::boundingRect() const.

C++ documentation:

Returns the effective bounding rectangle for this effect, i.e., the bounding rectangle of the source in device coordinates, adjusted by any margins applied by the effect itself.

See also boundingRectFor() and updateBoundingRect().

pub unsafe fn bounding_rect_for(
    &self,
    source_rect: impl CastInto<Ref<QRectF>>
) -> CppBox<QRectF>

Returns the effective bounding rectangle for this effect, given the provided rect in the device coordinates. When writing you own custom effect, you must call updateBoundingRect() whenever any parameters are changed that may cause this this function to return a different value.

Calls C++ function: virtual QRectF QGraphicsEffect::boundingRectFor(const QRectF& sourceRect) const.

C++ documentation:

Returns the effective bounding rectangle for this effect, given the provided rect in the device coordinates. When writing you own custom effect, you must call updateBoundingRect() whenever any parameters are changed that may cause this this function to return a different value.

See also sourceBoundingRect().

pub unsafe fn is_enabled(&self) -> bool

This property holds whether the effect is enabled or not.

Calls C++ function: bool QGraphicsEffect::isEnabled() const.

C++ documentation:

This property holds whether the effect is enabled or not.

If an effect is disabled, the source will be rendered with as normal, with no interference from the effect. If the effect is enabled, the source will be rendered with the effect applied.

This property is enabled by default.

Using this property, you can disable certain effects on slow platforms, in order to ensure that the user interface is responsive.

Access functions:

bool	isEnabled() const
void	setEnabled(bool enable)

Notifier signal:

void	enabledChanged(bool enabled)

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QGraphicsEffect::metaObject() const.

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int

Calls C++ function: virtual int QGraphicsEffect::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>

Calls C++ function: virtual void* QGraphicsEffect::qt_metacast(const char* arg1).

pub unsafe fn set_enabled(&mut self, enable: bool)

This property holds whether the effect is enabled or not.

Calls C++ function: [slot] void QGraphicsEffect::setEnabled(bool enable).

C++ documentation:

This property holds whether the effect is enabled or not.

If an effect is disabled, the source will be rendered with as normal, with no interference from the effect. If the effect is enabled, the source will be rendered with the effect applied.

This property is enabled by default.

Using this property, you can disable certain effects on slow platforms, in order to ensure that the user interface is responsive.

Access functions:

bool	isEnabled() const
void	setEnabled(bool enable)

Notifier signal:

void	enabledChanged(bool enabled)

pub unsafe fn update(&mut self)

Schedules a redraw of the effect. Call this function whenever the effect needs to be redrawn. This function does not trigger a redraw of the source.

Calls C++ function: [slot] void QGraphicsEffect::update().

C++ documentation:

Schedules a redraw of the effect. Call this function whenever the effect needs to be redrawn. This function does not trigger a redraw of the source.

See also updateBoundingRect().

Trait Implementations

impl Deref for QGraphicsBlurEffect

type Target = QGraphicsEffect

The resulting type after dereferencing.

fn deref(&self) -> &QGraphicsEffect

Calls C++ function: QGraphicsEffect* static_cast<QGraphicsEffect*>(QGraphicsBlurEffect* ptr).

impl DerefMut for QGraphicsBlurEffect

fn deref_mut(&mut self) -> &mut QGraphicsEffect

Calls C++ function: QGraphicsEffect* static_cast<QGraphicsEffect*>(QGraphicsBlurEffect* ptr).

impl StaticUpcast<QGraphicsEffect> for QGraphicsBlurEffect

unsafe fn static_upcast(ptr: Ptr<QGraphicsBlurEffect>) -> Ptr<QGraphicsEffect>

Calls C++ function: QGraphicsEffect* static_cast<QGraphicsEffect*>(QGraphicsBlurEffect* ptr).

unsafe fn static_upcast_mut(
    ptr: MutPtr<QGraphicsBlurEffect>
) -> MutPtr<QGraphicsEffect>

Calls C++ function: QGraphicsEffect* static_cast<QGraphicsEffect*>(QGraphicsBlurEffect* ptr).

impl StaticUpcast<QObject> for QGraphicsBlurEffect

unsafe fn static_upcast(ptr: Ptr<QGraphicsBlurEffect>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QGraphicsBlurEffect* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QGraphicsBlurEffect>) -> MutPtr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QGraphicsBlurEffect* ptr).

impl StaticDowncast<QGraphicsBlurEffect> for QGraphicsEffect

unsafe fn static_downcast(ptr: Ptr<QGraphicsEffect>) -> Ptr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* static_cast<QGraphicsBlurEffect*>(QGraphicsEffect* ptr).

unsafe fn static_downcast_mut(
    ptr: MutPtr<QGraphicsEffect>
) -> MutPtr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* static_cast<QGraphicsBlurEffect*>(QGraphicsEffect* ptr).

impl StaticDowncast<QGraphicsBlurEffect> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* static_cast<QGraphicsBlurEffect*>(QObject* ptr).

unsafe fn static_downcast_mut(
    ptr: MutPtr<QObject>
) -> MutPtr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* static_cast<QGraphicsBlurEffect*>(QObject* ptr).

impl DynamicCast<QGraphicsBlurEffect> for QGraphicsEffect

unsafe fn dynamic_cast(ptr: Ptr<QGraphicsEffect>) -> Ptr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* dynamic_cast<QGraphicsBlurEffect*>(QGraphicsEffect* ptr).

unsafe fn dynamic_cast_mut(
    ptr: MutPtr<QGraphicsEffect>
) -> MutPtr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* dynamic_cast<QGraphicsBlurEffect*>(QGraphicsEffect* ptr).

impl DynamicCast<QGraphicsBlurEffect> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* dynamic_cast<QGraphicsBlurEffect*>(QObject* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QObject>) -> MutPtr<QGraphicsBlurEffect>

Calls C++ function: QGraphicsBlurEffect* dynamic_cast<QGraphicsBlurEffect*>(QObject* ptr).

impl CppDeletable for QGraphicsBlurEffect

unsafe fn delete(&mut self)

Destroys the effect.

Calls C++ function: virtual [destructor] void QGraphicsBlurEffect::~QGraphicsBlurEffect().

C++ documentation:

Destroys the effect.