Struct qt_core::QSequentialAnimationGroup
source · #[repr(C)]pub struct QSequentialAnimationGroup { /* private fields */ }
Expand description
The QSequentialAnimationGroup class provides a sequential group of animations.
C++ class: QSequentialAnimationGroup
.
The QSequentialAnimationGroup class provides a sequential group of animations.
QSequentialAnimationGroup is a QAnimationGroup that runs its animations in sequence, i.e., it starts one animation after another has finished playing. The animations are played in the order they are added to the group (using addAnimation() or insertAnimation()). The animation group finishes when its last animation has finished.
At each moment there is at most one animation that is active in the group; it is returned by currentAnimation(). An empty group has no current animation.
A sequential animation group can be treated as any other animation, i.e., it can be started, stopped, and added to other groups. You can also call addPause() or insertPause() to add a pause to a sequential animation group.
QSequentialAnimationGroup *group = new QSequentialAnimationGroup;
group->addAnimation(anim1); group->addAnimation(anim2);
group->start();
In this example, anim1
and anim2
are two already set up QPropertyAnimations.
Implementations§
source§impl QSequentialAnimationGroup
impl QSequentialAnimationGroup
sourcepub fn current_animation_changed(&self) -> Signal<(*mut QAbstractAnimation,)>
pub fn current_animation_changed(&self) -> Signal<(*mut QAbstractAnimation,)>
QSequentialAnimationGroup emits this signal when currentAnimation has been changed. current is the current animation.
Returns a built-in Qt signal QSequentialAnimationGroup::currentAnimationChanged
that can be passed to qt_core::Signal::connect
.
QSequentialAnimationGroup emits this signal when currentAnimation has been changed. current is the current animation.
Note: Notifier signal for property currentAnimation.
See also currentAnimation().
sourcepub unsafe fn add_pause(&self, msecs: c_int) -> QPtr<QPauseAnimation>
pub unsafe fn add_pause(&self, msecs: c_int) -> QPtr<QPauseAnimation>
Adds a pause of msecs to this animation group. The pause is considered as a special type of animation, thus animationCount will be increased by one.
Calls C++ function: QPauseAnimation* QSequentialAnimationGroup::addPause(int msecs)
.
Adds a pause of msecs to this animation group. The pause is considered as a special type of animation, thus animationCount will be increased by one.
See also insertPause() and QAnimationGroup::addAnimation().
sourcepub unsafe fn current_animation(&self) -> QPtr<QAbstractAnimation>
pub unsafe fn current_animation(&self) -> QPtr<QAbstractAnimation>
Returns the animation in the current time.
Calls C++ function: QAbstractAnimation* QSequentialAnimationGroup::currentAnimation() const
.
Returns the animation in the current time.
Access functions:
QAbstractAnimation * | currentAnimation() const |
Notifier signal:
void | currentAnimationChanged(QAbstractAnimation *current) |
sourcepub unsafe fn duration(&self) -> c_int
pub unsafe fn duration(&self) -> c_int
Reimplemented from QAbstractAnimation::duration().
Calls C++ function: virtual int QSequentialAnimationGroup::duration() const
.
Reimplemented from QAbstractAnimation::duration().
sourcepub unsafe fn insert_pause(
&self,
index: c_int,
msecs: c_int
) -> QPtr<QPauseAnimation>
pub unsafe fn insert_pause( &self, index: c_int, msecs: c_int ) -> QPtr<QPauseAnimation>
Inserts a pause of msecs milliseconds at index in this animation group.
Calls C++ function: QPauseAnimation* QSequentialAnimationGroup::insertPause(int index, int msecs)
.
Inserts a pause of msecs milliseconds at index in this animation group.
See also addPause() and QAnimationGroup::insertAnimation().
sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QSequentialAnimationGroup::metaObject() const
.
sourcepub unsafe fn new_1a(
parent: impl CastInto<Ptr<QObject>>
) -> QBox<QSequentialAnimationGroup>
pub unsafe fn new_1a( parent: impl CastInto<Ptr<QObject>> ) -> QBox<QSequentialAnimationGroup>
Constructs a QSequentialAnimationGroup. parent is passed to QObject's constructor.
Calls C++ function: [constructor] void QSequentialAnimationGroup::QSequentialAnimationGroup(QObject* parent = …)
.
Constructs a QSequentialAnimationGroup. parent is passed to QObject’s constructor.
sourcepub unsafe fn new_0a() -> QBox<QSequentialAnimationGroup>
pub unsafe fn new_0a() -> QBox<QSequentialAnimationGroup>
The QSequentialAnimationGroup class provides a sequential group of animations.
Calls C++ function: [constructor] void QSequentialAnimationGroup::QSequentialAnimationGroup()
.
The QSequentialAnimationGroup class provides a sequential group of animations.
QSequentialAnimationGroup is a QAnimationGroup that runs its animations in sequence, i.e., it starts one animation after another has finished playing. The animations are played in the order they are added to the group (using addAnimation() or insertAnimation()). The animation group finishes when its last animation has finished.
At each moment there is at most one animation that is active in the group; it is returned by currentAnimation(). An empty group has no current animation.
A sequential animation group can be treated as any other animation, i.e., it can be started, stopped, and added to other groups. You can also call addPause() or insertPause() to add a pause to a sequential animation group.
QSequentialAnimationGroup *group = new QSequentialAnimationGroup;
group->addAnimation(anim1); group->addAnimation(anim2);
group->start();
In this example, anim1
and anim2
are two already set up QPropertyAnimations.
sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void ) -> c_int
Calls C++ function: virtual int QSequentialAnimationGroup::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QSequentialAnimationGroup::qt_metacast(const char* arg1)
.
sourcepub unsafe fn static_meta_object() -> Ref<QMetaObject>
pub unsafe fn static_meta_object() -> Ref<QMetaObject>
Returns a reference to the staticMetaObject
field.
Methods from Deref<Target = QAnimationGroup>§
sourcepub unsafe fn add_animation(
&self,
animation: impl CastInto<Ptr<QAbstractAnimation>>
)
pub unsafe fn add_animation( &self, animation: impl CastInto<Ptr<QAbstractAnimation>> )
Adds animation to this group. This will call insertAnimation with index equals to animationCount().
Calls C++ function: void QAnimationGroup::addAnimation(QAbstractAnimation* animation)
.
Adds animation to this group. This will call insertAnimation with index equals to animationCount().
Note: The group takes ownership of the animation.
See also removeAnimation().
sourcepub unsafe fn animation_at(&self, index: c_int) -> QPtr<QAbstractAnimation>
pub unsafe fn animation_at(&self, index: c_int) -> QPtr<QAbstractAnimation>
Returns a pointer to the animation at index in this group. This function is useful when you need access to a particular animation. index is between 0 and animationCount() - 1.
Calls C++ function: QAbstractAnimation* QAnimationGroup::animationAt(int index) const
.
Returns a pointer to the animation at index in this group. This function is useful when you need access to a particular animation. index is between 0 and animationCount() - 1.
See also animationCount() and indexOfAnimation().
sourcepub unsafe fn animation_count(&self) -> c_int
pub unsafe fn animation_count(&self) -> c_int
Returns the number of animations managed by this group.
Calls C++ function: int QAnimationGroup::animationCount() const
.
Returns the number of animations managed by this group.
See also indexOfAnimation(), addAnimation(), and animationAt().
sourcepub unsafe fn clear(&self)
pub unsafe fn clear(&self)
Removes and deletes all animations in this animation group, and resets the current time to 0.
Calls C++ function: void QAnimationGroup::clear()
.
Removes and deletes all animations in this animation group, and resets the current time to 0.
See also addAnimation() and removeAnimation().
sourcepub unsafe fn index_of_animation(
&self,
animation: impl CastInto<Ptr<QAbstractAnimation>>
) -> c_int
pub unsafe fn index_of_animation( &self, animation: impl CastInto<Ptr<QAbstractAnimation>> ) -> c_int
Returns the index of animation. The returned index can be passed to the other functions that take an index as an argument.
Calls C++ function: int QAnimationGroup::indexOfAnimation(QAbstractAnimation* animation) const
.
Returns the index of animation. The returned index can be passed to the other functions that take an index as an argument.
See also insertAnimation(), animationAt(), and takeAnimation().
sourcepub unsafe fn insert_animation(
&self,
index: c_int,
animation: impl CastInto<Ptr<QAbstractAnimation>>
)
pub unsafe fn insert_animation( &self, index: c_int, animation: impl CastInto<Ptr<QAbstractAnimation>> )
Inserts animation into this animation group at index. If index is 0 the animation is inserted at the beginning. If index is animationCount(), the animation is inserted at the end.
Calls C++ function: void QAnimationGroup::insertAnimation(int index, QAbstractAnimation* animation)
.
Inserts animation into this animation group at index. If index is 0 the animation is inserted at the beginning. If index is animationCount(), the animation is inserted at the end.
Note: The group takes ownership of the animation.
See also takeAnimation(), addAnimation(), indexOfAnimation(), and removeAnimation().
sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QAnimationGroup::metaObject() const
.
sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void ) -> c_int
Calls C++ function: virtual int QAnimationGroup::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QAnimationGroup::qt_metacast(const char* arg1)
.
sourcepub unsafe fn remove_animation(
&self,
animation: impl CastInto<Ptr<QAbstractAnimation>>
)
pub unsafe fn remove_animation( &self, animation: impl CastInto<Ptr<QAbstractAnimation>> )
Removes animation from this group. The ownership of animation is transferred to the caller.
Calls C++ function: void QAnimationGroup::removeAnimation(QAbstractAnimation* animation)
.
Removes animation from this group. The ownership of animation is transferred to the caller.
See also takeAnimation(), insertAnimation(), and addAnimation().
sourcepub unsafe fn take_animation(&self, index: c_int) -> QPtr<QAbstractAnimation>
pub unsafe fn take_animation(&self, index: c_int) -> QPtr<QAbstractAnimation>
Returns the animation at index and removes it from the animation group.
Calls C++ function: QAbstractAnimation* QAnimationGroup::takeAnimation(int index)
.
Returns the animation at index and removes it from the animation group.
Note: The ownership of the animation is transferred to the caller.
See also removeAnimation(), addAnimation(), insertAnimation(), and indexOfAnimation().
Methods from Deref<Target = QAbstractAnimation>§
sourcepub fn finished(&self) -> Signal<()>
pub fn finished(&self) -> Signal<()>
QAbstractAnimation emits this signal after the animation has stopped and has reached the end.
Returns a built-in Qt signal QAbstractAnimation::finished
that can be passed to qt_core::Signal::connect
.
QAbstractAnimation emits this signal after the animation has stopped and has reached the end.
This signal is emitted after stateChanged().
See also stateChanged().
sourcepub fn state_changed(&self) -> Signal<(State, State)>
pub fn state_changed(&self) -> Signal<(State, State)>
QAbstractAnimation emits this signal whenever the state of the animation has changed from oldState to newState. This signal is emitted after the virtual updateState() function is called.
Returns a built-in Qt signal QAbstractAnimation::stateChanged
that can be passed to qt_core::Signal::connect
.
QAbstractAnimation emits this signal whenever the state of the animation has changed from oldState to newState. This signal is emitted after the virtual updateState() function is called.
Note: Notifier signal for property state.
See also updateState().
sourcepub fn current_loop_changed(&self) -> Signal<(c_int,)>
pub fn current_loop_changed(&self) -> Signal<(c_int,)>
QAbstractAnimation emits this signal whenever the current loop changes. currentLoop is the current loop.
Returns a built-in Qt signal QAbstractAnimation::currentLoopChanged
that can be passed to qt_core::Signal::connect
.
QAbstractAnimation emits this signal whenever the current loop changes. currentLoop is the current loop.
Note: Notifier signal for property currentLoop.
See also currentLoop() and loopCount().
sourcepub fn direction_changed(&self) -> Signal<(Direction,)>
pub fn direction_changed(&self) -> Signal<(Direction,)>
QAbstractAnimation emits this signal whenever the direction has been changed. newDirection is the new direction.
Returns a built-in Qt signal QAbstractAnimation::directionChanged
that can be passed to qt_core::Signal::connect
.
QAbstractAnimation emits this signal whenever the direction has been changed. newDirection is the new direction.
Note: Notifier signal for property direction.
See also direction.
sourcepub fn slot_start(&self) -> Receiver<(DeletionPolicy,)>
pub fn slot_start(&self) -> Receiver<(DeletionPolicy,)>
Starts the animation. The policy argument says whether or not the animation should be deleted when it's done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.
Returns a built-in Qt slot QAbstractAnimation::start
that can be passed to qt_core::Signal::connect
.
Starts the animation. The policy argument says whether or not the animation should be deleted when it’s done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.
If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.
If the animation is already running, this function does nothing.
sourcepub fn slot_pause(&self) -> Receiver<()>
pub fn slot_pause(&self) -> Receiver<()>
Pauses the animation. When the animation is paused, state() returns Paused. The value of currentTime will remain unchanged until resume() or start() is called. If you want to continue from the current time, call resume().
Returns a built-in Qt slot QAbstractAnimation::pause
that can be passed to qt_core::Signal::connect
.
sourcepub fn slot_resume(&self) -> Receiver<()>
pub fn slot_resume(&self) -> Receiver<()>
Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.
Returns a built-in Qt slot QAbstractAnimation::resume
that can be passed to qt_core::Signal::connect
.
Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.
sourcepub fn slot_set_paused(&self) -> Receiver<(bool,)>
pub fn slot_set_paused(&self) -> Receiver<(bool,)>
If paused is true, the animation is paused. If paused is false, the animation is resumed.
Returns a built-in Qt slot QAbstractAnimation::setPaused
that can be passed to qt_core::Signal::connect
.
sourcepub fn slot_stop(&self) -> Receiver<()>
pub fn slot_stop(&self) -> Receiver<()>
Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.
Returns a built-in Qt slot QAbstractAnimation::stop
that can be passed to qt_core::Signal::connect
.
Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.
If the animation stops by itself after reaching the end (i.e., currentLoopTime() == duration() and currentLoop() > loopCount() - 1), the finished() signal is emitted.
sourcepub fn slot_set_current_time(&self) -> Receiver<(c_int,)>
pub fn slot_set_current_time(&self) -> Receiver<(c_int,)>
This property holds the current time and progress of the animation
Returns a built-in Qt slot QAbstractAnimation::setCurrentTime
that can be passed to qt_core::Signal::connect
.
This property holds the current time and progress of the animation
This property describes the animation's current time. You can change the current time by calling setCurrentTime, or you can call start() and let the animation run, setting the current time automatically as the animation progresses.
The animation's current time starts at 0, and ends at totalDuration().
Access functions:
int | currentTime() const |
void | setCurrentTime(int msecs) |
See also loopCount and currentLoopTime().
sourcepub unsafe fn current_loop(&self) -> c_int
pub unsafe fn current_loop(&self) -> c_int
This property holds the current loop of the animation
Calls C++ function: int QAbstractAnimation::currentLoop() const
.
This property holds the current loop of the animation
This property describes the current loop of the animation. By default, the animation's loop count is 1, and so the current loop will always be 0. If the loop count is 2 and the animation runs past its duration, it will automatically rewind and restart at current time 0, and current loop 1, and so on.
When the current loop changes, QAbstractAnimation emits the currentLoopChanged() signal.
Access functions:
int | currentLoop() const |
Notifier signal:
void | currentLoopChanged(int currentLoop) |
sourcepub unsafe fn current_loop_time(&self) -> c_int
pub unsafe fn current_loop_time(&self) -> c_int
Returns the current time inside the current loop. It can go from 0 to duration().
Calls C++ function: int QAbstractAnimation::currentLoopTime() const
.
Returns the current time inside the current loop. It can go from 0 to duration().
See also duration() and currentTime.
sourcepub unsafe fn current_time(&self) -> c_int
pub unsafe fn current_time(&self) -> c_int
This property holds the current time and progress of the animation
Calls C++ function: int QAbstractAnimation::currentTime() const
.
This property holds the current time and progress of the animation
This property describes the animation's current time. You can change the current time by calling setCurrentTime, or you can call start() and let the animation run, setting the current time automatically as the animation progresses.
The animation's current time starts at 0, and ends at totalDuration().
Access functions:
int | currentTime() const |
void | setCurrentTime(int msecs) |
See also loopCount and currentLoopTime().
sourcepub unsafe fn direction(&self) -> Direction
pub unsafe fn direction(&self) -> Direction
This property holds the direction of the animation when it is in Running state.
Calls C++ function: QAbstractAnimation::Direction QAbstractAnimation::direction() const
.
This property holds the direction of the animation when it is in Running state.
This direction indicates whether the time moves from 0 towards the animation duration, or from the value of the duration and towards 0 after start() has been called.
By default, this property is set to Forward.
Access functions:
Direction | direction() const |
void | setDirection(Direction direction) |
Notifier signal:
void | directionChanged(QAbstractAnimation::Direction newDirection) |
sourcepub unsafe fn duration(&self) -> c_int
pub unsafe fn duration(&self) -> c_int
This property holds the duration of the animation.
Calls C++ function: pure virtual int QAbstractAnimation::duration() const
.
sourcepub unsafe fn group(&self) -> QPtr<QAnimationGroup>
pub unsafe fn group(&self) -> QPtr<QAnimationGroup>
If this animation is part of a QAnimationGroup, this function returns a pointer to the group; otherwise, it returns 0.
Calls C++ function: QAnimationGroup* QAbstractAnimation::group() const
.
If this animation is part of a QAnimationGroup, this function returns a pointer to the group; otherwise, it returns 0.
See also QAnimationGroup::addAnimation().
sourcepub unsafe fn loop_count(&self) -> c_int
pub unsafe fn loop_count(&self) -> c_int
This property holds the loop count of the animation
Calls C++ function: int QAbstractAnimation::loopCount() const
.
This property holds the loop count of the animation
This property describes the loop count of the animation as an integer. By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.
Access functions:
int | loopCount() const |
void | setLoopCount(int loopCount) |
sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QAbstractAnimation::metaObject() const
.
sourcepub unsafe fn pause(&self)
pub unsafe fn pause(&self)
Pauses the animation. When the animation is paused, state() returns Paused. The value of currentTime will remain unchanged until resume() or start() is called. If you want to continue from the current time, call resume().
Calls C++ function: [slot] void QAbstractAnimation::pause()
.
sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void ) -> c_int
Calls C++ function: virtual int QAbstractAnimation::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QAbstractAnimation::qt_metacast(const char* arg1)
.
sourcepub unsafe fn resume(&self)
pub unsafe fn resume(&self)
Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.
Calls C++ function: [slot] void QAbstractAnimation::resume()
.
Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.
sourcepub unsafe fn set_current_time(&self, msecs: c_int)
pub unsafe fn set_current_time(&self, msecs: c_int)
This property holds the current time and progress of the animation
Calls C++ function: [slot] void QAbstractAnimation::setCurrentTime(int msecs)
.
This property holds the current time and progress of the animation
This property describes the animation's current time. You can change the current time by calling setCurrentTime, or you can call start() and let the animation run, setting the current time automatically as the animation progresses.
The animation's current time starts at 0, and ends at totalDuration().
Access functions:
int | currentTime() const |
void | setCurrentTime(int msecs) |
See also loopCount and currentLoopTime().
sourcepub unsafe fn set_direction(&self, direction: Direction)
pub unsafe fn set_direction(&self, direction: Direction)
This property holds the direction of the animation when it is in Running state.
Calls C++ function: void QAbstractAnimation::setDirection(QAbstractAnimation::Direction direction)
.
This property holds the direction of the animation when it is in Running state.
This direction indicates whether the time moves from 0 towards the animation duration, or from the value of the duration and towards 0 after start() has been called.
By default, this property is set to Forward.
Access functions:
Direction | direction() const |
void | setDirection(Direction direction) |
Notifier signal:
void | directionChanged(QAbstractAnimation::Direction newDirection) |
sourcepub unsafe fn set_loop_count(&self, loop_count: c_int)
pub unsafe fn set_loop_count(&self, loop_count: c_int)
This property holds the loop count of the animation
Calls C++ function: void QAbstractAnimation::setLoopCount(int loopCount)
.
This property holds the loop count of the animation
This property describes the loop count of the animation as an integer. By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.
Access functions:
int | loopCount() const |
void | setLoopCount(int loopCount) |
sourcepub unsafe fn set_paused(&self, arg1: bool)
pub unsafe fn set_paused(&self, arg1: bool)
If paused is true, the animation is paused. If paused is false, the animation is resumed.
Calls C++ function: [slot] void QAbstractAnimation::setPaused(bool arg1)
.
sourcepub unsafe fn start_1a(&self, policy: DeletionPolicy)
pub unsafe fn start_1a(&self, policy: DeletionPolicy)
Starts the animation. The policy argument says whether or not the animation should be deleted when it's done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.
Calls C++ function: [slot] void QAbstractAnimation::start(QAbstractAnimation::DeletionPolicy policy = …)
.
Starts the animation. The policy argument says whether or not the animation should be deleted when it’s done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.
If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.
If the animation is already running, this function does nothing.
sourcepub unsafe fn start_0a(&self)
pub unsafe fn start_0a(&self)
Starts the animation. The policy argument says whether or not the animation should be deleted when it's done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.
Calls C++ function: [slot] void QAbstractAnimation::start()
.
Starts the animation. The policy argument says whether or not the animation should be deleted when it’s done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.
If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.
If the animation is already running, this function does nothing.
sourcepub unsafe fn state(&self) -> State
pub unsafe fn state(&self) -> State
state of the animation.
Calls C++ function: QAbstractAnimation::State QAbstractAnimation::state() const
.
state of the animation.
This property describes the current state of the animation. When the animation state changes, QAbstractAnimation emits the stateChanged() signal.
Access functions:
State | state() const |
Notifier signal:
void | stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) |
sourcepub unsafe fn stop(&self)
pub unsafe fn stop(&self)
Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.
Calls C++ function: [slot] void QAbstractAnimation::stop()
.
Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.
If the animation stops by itself after reaching the end (i.e., currentLoopTime() == duration() and currentLoop() > loopCount() - 1), the finished() signal is emitted.
sourcepub unsafe fn total_duration(&self) -> c_int
pub unsafe fn total_duration(&self) -> c_int
Returns the total and effective duration of the animation, including the loop count.
Calls C++ function: int QAbstractAnimation::totalDuration() const
.
Returns the total and effective duration of the animation, including the loop count.
See also duration() and currentTime.
Methods from Deref<Target = QObject>§
sourcepub unsafe fn find_child<T>(
&self,
name: &str
) -> Result<QPtr<T>, FindChildError>
pub unsafe fn find_child<T>( &self, name: &str ) -> Result<QPtr<T>, FindChildError>
Finds a child of self
with the specified object name
and casts it to type T
.
The search is performed recursively. If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned.
Returns an error if there is no child object with object name name
or
the found object cannot be cast to T
.
sourcepub fn destroyed(&self) -> Signal<(*mut QObject,)>
pub fn destroyed(&self) -> Signal<(*mut QObject,)>
This signal is emitted immediately before the object obj is destroyed, and can not be blocked.
Returns a built-in Qt signal QObject::destroyed
that can be passed to qt_core::Signal::connect
.
This signal is emitted immediately before the object obj is destroyed, and can not be blocked.
All the objects's children are destroyed immediately after this signal is emitted.
See also deleteLater() and QPointer.
sourcepub fn object_name_changed(&self) -> Signal<(*const QString,)>
pub fn object_name_changed(&self) -> Signal<(*const QString,)>
This signal is emitted after the object's name has been changed. The new object name is passed as objectName.
Returns a built-in Qt signal QObject::objectNameChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted after the object’s name has been changed. The new object name is passed as objectName.
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
Note: Notifier signal for property objectName.
See also QObject::objectName.
sourcepub fn slot_delete_later(&self) -> Receiver<()>
pub fn slot_delete_later(&self) -> Receiver<()>
Schedules this object for deletion.
Returns a built-in Qt slot QObject::deleteLater
that can be passed to qt_core::Signal::connect
.
Schedules this object for deletion.
The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.
Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.
Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.
sourcepub unsafe fn block_signals(&self, b: bool) -> bool
pub unsafe fn block_signals(&self, b: bool) -> bool
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.
Calls C++ function: bool QObject::blockSignals(bool b)
.
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.
The return value is the previous value of signalsBlocked().
Note that the destroyed() signal will be emitted even if the signals for this object have been blocked.
Signals emitted while being blocked are not buffered.
See also signalsBlocked() and QSignalBlocker.
sourcepub unsafe fn children(&self) -> Ref<QListOfQObject>
pub unsafe fn children(&self) -> Ref<QListOfQObject>
Returns a list of child objects. The QObjectList class is defined in the <QObject>
header file as the following:
Calls C++ function: const QList<QObject*>& QObject::children() const
.
Returns a list of child objects. The QObjectList class is defined in the <QObject>
header file as the following:
typedef QList<QObject*> QObjectList;
The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end.
Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list.
See also findChild(), findChildren(), parent(), and setParent().
sourcepub unsafe fn delete_later(&self)
pub unsafe fn delete_later(&self)
Schedules this object for deletion.
Calls C++ function: [slot] void QObject::deleteLater()
.
Schedules this object for deletion.
The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.
Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.
Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.
sourcepub unsafe fn disconnect_char_q_object_char(
&self,
signal: *const c_char,
receiver: impl CastInto<Ptr<QObject>>,
member: *const c_char
) -> bool
pub unsafe fn disconnect_char_q_object_char( &self, signal: *const c_char, receiver: impl CastInto<Ptr<QObject>>, member: *const c_char ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …, const char* member = …) const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
sourcepub unsafe fn disconnect_q_object_char(
&self,
receiver: impl CastInto<Ptr<QObject>>,
member: *const c_char
) -> bool
pub unsafe fn disconnect_q_object_char( &self, receiver: impl CastInto<Ptr<QObject>>, member: *const c_char ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const QObject* receiver, const char* member = …) const
.
This function overloads disconnect().
Disconnects all signals in this object from receiver's method.
A signal-slot connection is removed when either of the objects involved are destroyed.
sourcepub unsafe fn disconnect_char_q_object(
&self,
signal: *const c_char,
receiver: impl CastInto<Ptr<QObject>>
) -> bool
pub unsafe fn disconnect_char_q_object( &self, signal: *const c_char, receiver: impl CastInto<Ptr<QObject>> ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …) const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
sourcepub unsafe fn disconnect_char(&self, signal: *const c_char) -> bool
pub unsafe fn disconnect_char(&self, signal: *const c_char) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …) const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
sourcepub unsafe fn disconnect(&self) -> bool
pub unsafe fn disconnect(&self) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect() const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
sourcepub unsafe fn disconnect_q_object(
&self,
receiver: impl CastInto<Ptr<QObject>>
) -> bool
pub unsafe fn disconnect_q_object( &self, receiver: impl CastInto<Ptr<QObject>> ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const QObject* receiver) const
.
This function overloads disconnect().
Disconnects all signals in this object from receiver's method.
A signal-slot connection is removed when either of the objects involved are destroyed.
sourcepub unsafe fn dump_object_info_mut(&self)
pub unsafe fn dump_object_info_mut(&self)
Dumps information about signal connections, etc. for this object to the debug output.
Calls C++ function: void QObject::dumpObjectInfo()
.
Dumps information about signal connections, etc. for this object to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectTree().
sourcepub unsafe fn dump_object_info(&self)
pub unsafe fn dump_object_info(&self)
Dumps information about signal connections, etc. for this object to the debug output.
Calls C++ function: void QObject::dumpObjectInfo() const
.
Dumps information about signal connections, etc. for this object to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectTree().
sourcepub unsafe fn dump_object_tree_mut(&self)
pub unsafe fn dump_object_tree_mut(&self)
Dumps a tree of children to the debug output.
Calls C++ function: void QObject::dumpObjectTree()
.
Dumps a tree of children to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectInfo().
sourcepub unsafe fn dump_object_tree(&self)
pub unsafe fn dump_object_tree(&self)
Dumps a tree of children to the debug output.
Calls C++ function: void QObject::dumpObjectTree() const
.
Dumps a tree of children to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectInfo().
sourcepub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>
pub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>
Returns the names of all properties that were dynamically added to the object using setProperty().
Calls C++ function: QList<QByteArray> QObject::dynamicPropertyNames() const
.
Returns the names of all properties that were dynamically added to the object using setProperty().
This function was introduced in Qt 4.2.
sourcepub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool
pub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool
Returns true
if c1 and c2 are the same Unicode character; otherwise returns false
.
Calls C++ function: bool operator==(QObject* o, const QPointer<QObject>& p)
.
Warning: no exact match found in C++ documentation. Below is the C++ documentation for bool operator==(QChar c1, QChar c2)
:
Returns true
if c1 and c2 are the same Unicode character; otherwise returns false
.
sourcepub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool
pub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool
This virtual function receives events to an object and should return true if the event e was recognized and processed.
Calls C++ function: virtual bool QObject::event(QEvent* event)
.
This virtual function receives events to an object and should return true if the event e was recognized and processed.
The event() function can be reimplemented to customize the behavior of an object.
Make sure you call the parent event class implementation for all the events you did not handle.
Example:
class MyClass : public QWidget { Q_OBJECT
public: MyClass(QWidget *parent = 0); ~MyClass();
bool event(QEvent* ev) { if (ev->type() == QEvent::PolishRequest) { // overwrite handling of PolishRequest if any doThings(); return true; } else if (ev->type() == QEvent::Show) { // complement handling of Show if any doThings2(); QWidget::event(ev); return true; } // Make sure the rest of events are handled return QWidget::event(ev); } };
See also installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), and QCoreApplication::postEvent().
sourcepub unsafe fn event_filter(
&self,
watched: impl CastInto<Ptr<QObject>>,
event: impl CastInto<Ptr<QEvent>>
) -> bool
pub unsafe fn event_filter( &self, watched: impl CastInto<Ptr<QObject>>, event: impl CastInto<Ptr<QEvent>> ) -> bool
Filters events if this object has been installed as an event filter for the watched object.
Calls C++ function: virtual bool QObject::eventFilter(QObject* watched, QEvent* event)
.
Filters events if this object has been installed as an event filter for the watched object.
In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Example:
class MainWindow : public QMainWindow { public: MainWindow();
protected: bool eventFilter(QObject obj, QEvent ev);
private: QTextEdit *textEdit; };
MainWindow::MainWindow() { textEdit = new QTextEdit; setCentralWidget(textEdit);
textEdit->installEventFilter(this); }
bool MainWindow::eventFilter(QObject obj, QEvent event) { if (obj == textEdit) { if (event->type() == QEvent::KeyPress) { QKeyEvent keyEvent = static_cast<QKeyEvent>(event); qDebug() << “Ate key press” << keyEvent->key(); return true; } else { return false; } } else { // pass the event on to the parent class return QMainWindow::eventFilter(obj, event); } }
Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.
Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also installEventFilter().
sourcepub unsafe fn find_child_q_object_2a(
&self,
a_name: impl CastInto<Ref<QString>>,
options: QFlags<FindChildOption>
) -> QPtr<QObject>
pub unsafe fn find_child_q_object_2a( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption> ) -> QPtr<QObject>
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const
.
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.
This example returns a child QPushButton
of parentWidget
named "button1"
, even if the button isn't a direct child of the parent:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”);
This example returns a QListWidget
child of parentWidget
:
QListWidget list = parentWidget->findChild<QListWidget >();
This example returns a child QPushButton
of parentWidget
(its direct parent) named "button1"
:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);
This example returns a QListWidget
child of parentWidget
, its direct parent:
QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);
See also findChildren().
sourcepub unsafe fn find_child_q_object_1a(
&self,
a_name: impl CastInto<Ref<QString>>
) -> QPtr<QObject>
pub unsafe fn find_child_q_object_1a( &self, a_name: impl CastInto<Ref<QString>> ) -> QPtr<QObject>
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …) const
.
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.
This example returns a child QPushButton
of parentWidget
named "button1"
, even if the button isn't a direct child of the parent:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”);
This example returns a QListWidget
child of parentWidget
:
QListWidget list = parentWidget->findChild<QListWidget >();
This example returns a child QPushButton
of parentWidget
(its direct parent) named "button1"
:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);
This example returns a QListWidget
child of parentWidget
, its direct parent:
QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);
See also findChildren().
sourcepub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>
pub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QObject* QObject::findChild<QObject*>() const
.
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.
This example returns a child QPushButton
of parentWidget
named "button1"
, even if the button isn't a direct child of the parent:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”);
This example returns a QListWidget
child of parentWidget
:
QListWidget list = parentWidget->findChild<QListWidget >();
This example returns a child QPushButton
of parentWidget
(its direct parent) named "button1"
:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);
This example returns a QListWidget
child of parentWidget
, its direct parent:
QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);
See also findChildren().
sourcepub unsafe fn find_children_q_object_q_string_q_flags_find_child_option(
&self,
a_name: impl CastInto<Ref<QString>>,
options: QFlags<FindChildOption>
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_string_q_flags_find_child_option( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption> ) -> CppBox<QListOfQObject>
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. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) 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. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
The following example shows how to find a list of child QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
sourcepub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option(
&self,
re: impl CastInto<Ref<QRegExp>>,
options: QFlags<FindChildOption>
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegExp>>, options: QFlags<FindChildOption> ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re, QFlags<Qt::FindChildOption> options = …) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
sourcepub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option(
&self,
re: impl CastInto<Ref<QRegularExpression>>,
options: QFlags<FindChildOption>
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegularExpression>>, options: QFlags<FindChildOption> ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re, QFlags<Qt::FindChildOption> options = …) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
This function was introduced in Qt 5.0.
sourcepub unsafe fn find_children_q_object_q_string(
&self,
a_name: impl CastInto<Ref<QString>>
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_string( &self, a_name: impl CastInto<Ref<QString>> ) -> CppBox<QListOfQObject>
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. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …) 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. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
The following example shows how to find a list of child QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
sourcepub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>
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. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>() 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. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
The following example shows how to find a list of child QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
sourcepub unsafe fn find_children_q_object_q_reg_exp(
&self,
re: impl CastInto<Ref<QRegExp>>
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_reg_exp( &self, re: impl CastInto<Ref<QRegExp>> ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
sourcepub unsafe fn find_children_q_object_q_regular_expression(
&self,
re: impl CastInto<Ref<QRegularExpression>>
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_regular_expression( &self, re: impl CastInto<Ref<QRegularExpression>> ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
This function was introduced in Qt 5.0.
sourcepub unsafe fn inherits(&self, classname: *const c_char) -> bool
pub unsafe fn inherits(&self, classname: *const c_char) -> bool
Returns true
if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false
.
Calls C++ function: bool QObject::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
.
A class is considered to inherit itself.
Example:
QTimer *timer = new QTimer; // QTimer inherits QObject timer->inherits(“QTimer”); // returns true timer->inherits(“QObject”); // returns true timer->inherits(“QAbstractButton”); // returns false
// QVBoxLayout inherits QObject and QLayoutItem QVBoxLayout *layout = new QVBoxLayout; layout->inherits(“QObject”); // returns true layout->inherits(“QLayoutItem”); // returns true (even though QLayoutItem is not a QObject)
If you need to determine whether an object is an instance of a particular class for the purpose of casting it, consider using qobject_cast<Type *>(object) instead.
See also metaObject() and qobject_cast().
sourcepub unsafe fn install_event_filter(
&self,
filter_obj: impl CastInto<Ptr<QObject>>
)
pub unsafe fn install_event_filter( &self, filter_obj: impl CastInto<Ptr<QObject>> )
Installs an event filter filterObj on this object. For example:
Calls C++ function: void QObject::installEventFilter(QObject* filterObj)
.
Installs an event filter filterObj on this object. For example:
monitoredObj->installEventFilter(filterObj);
An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter filterObj receives events via its eventFilter() function. The eventFilter() function must return true if the event should be filtered, (i.e. stopped); otherwise it must return false.
If multiple event filters are installed on a single object, the filter that was installed last is activated first.
Here's a KeyPressEater
class that eats the key presses of its monitored objects:
class KeyPressEater : public QObject { Q_OBJECT ...
protected: bool eventFilter(QObject obj, QEvent event); };
bool KeyPressEater::eventFilter(QObject obj, QEvent event) { if (event->type() == QEvent::KeyPress) { QKeyEvent keyEvent = static_cast<QKeyEvent >(event); qDebug(“Ate key press %d”, keyEvent->key()); return true; } else { // standard event processing return QObject::eventFilter(obj, event); } }
And here's how to install it on two widgets:
KeyPressEater keyPressEater = new KeyPressEater(this); QPushButton pushButton = new QPushButton(this); QListView *listView = new QListView(this);
pushButton->installEventFilter(keyPressEater); listView->installEventFilter(keyPressEater);
The QShortcut class, for example, uses this technique to intercept shortcut key presses.
Warning: If you delete the receiver object in your eventFilter() function, be sure to return true. If you return false, Qt sends the event to the deleted object and the program will crash.
Note that the filtering object must be in the same thread as this object. If filterObj is in a different thread, this function does nothing. If either filterObj or this object are moved to a different thread after calling this function, the event filter will not be called until both objects have the same thread affinity again (it is not removed).
See also removeEventFilter(), eventFilter(), and event().
sourcepub unsafe fn is_widget_type(&self) -> bool
pub unsafe fn is_widget_type(&self) -> bool
Returns true
if the object is a widget; otherwise returns false
.
Calls C++ function: bool QObject::isWidgetType() const
.
Returns true
if the object is a widget; otherwise returns false
.
Calling this function is equivalent to calling inherits("QWidget")
, except that it is much faster.
sourcepub unsafe fn is_window_type(&self) -> bool
pub unsafe fn is_window_type(&self) -> bool
Returns true
if the object is a window; otherwise returns false
.
Calls C++ function: bool QObject::isWindowType() const
.
Returns true
if the object is a window; otherwise returns false
.
Calling this function is equivalent to calling inherits("QWindow")
, except that it is much faster.
sourcepub unsafe fn kill_timer(&self, id: c_int)
pub unsafe fn kill_timer(&self, id: c_int)
Kills the timer with timer identifier, id.
Calls C++ function: void QObject::killTimer(int id)
.
Kills the timer with timer identifier, id.
The timer identifier is returned by startTimer() when a timer event is started.
See also timerEvent() and startTimer().
sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Returns a pointer to the meta-object of this object.
Calls C++ function: virtual const QMetaObject* QObject::metaObject() const
.
Returns a pointer to the meta-object of this object.
A meta-object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every QObject subclass that contains the Q_OBJECT macro will have a meta-object.
The meta-object information is required by the signal/slot connection mechanism and the property system. The inherits() function also makes use of the meta-object.
If you have no pointer to an actual object instance but still want to access the meta-object of a class, you can use staticMetaObject.
Example:
QObject *obj = new QPushButton; obj->metaObject()->className(); // returns “QPushButton”
QPushButton::staticMetaObject.className(); // returns “QPushButton”
See also staticMetaObject.
sourcepub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)
pub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)
Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.
Calls C++ function: void QObject::moveToThread(QThread* thread)
.
Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.
To move an object to the main thread, use QApplication::instance() to retrieve a pointer to the current application, and then use QApplication::thread() to retrieve the thread in which the application lives. For example:
myObject->moveToThread(QApplication::instance()->thread());
If targetThread is zero, all event processing for this object and its children stops.
Note that all active timers for the object will be reset. The timers are first stopped in the current thread and restarted (with the same interval) in the targetThread. As a result, constantly moving an object between threads can postpone timer events indefinitely.
A QEvent::ThreadChange event is sent to this object just before the thread affinity is changed. You can handle this event to perform any special processing. Note that any new events that are posted to this object will be handled in the targetThread.
Warning: This function is not thread-safe; the current thread must be same as the current thread affinity. In other words, this function can only "push" an object from the current thread to another thread, it cannot "pull" an object from any arbitrary thread to the current thread.
See also thread().
sourcepub unsafe fn object_name(&self) -> CppBox<QString>
pub unsafe fn object_name(&self) -> CppBox<QString>
This property holds the name of this object
Calls C++ function: QString QObject::objectName() const
.
This property holds the name of this object
You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().
qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”, qPrintable(objectName()), newPrecision);
By default, this property contains an empty string.
Access functions:
QString | objectName() const |
void | setObjectName(const QString &name) |
Notifier signal:
void | objectNameChanged(const QString &objectName) | [see note below] |
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
See also metaObject() and QMetaObject::className().
sourcepub unsafe fn parent(&self) -> QPtr<QObject>
pub unsafe fn parent(&self) -> QPtr<QObject>
Returns a pointer to the parent object.
Calls C++ function: QObject* QObject::parent() const
.
sourcepub unsafe fn property(&self, name: *const c_char) -> CppBox<QVariant>
pub unsafe fn property(&self, name: *const c_char) -> CppBox<QVariant>
Returns the value of the object's name property.
Calls C++ function: QVariant QObject::property(const char* name) const
.
Returns the value of the object’s name property.
If no such property exists, the returned variant is invalid.
Information about all available properties is provided through the metaObject() and dynamicPropertyNames().
See also setProperty(), QVariant::isValid(), metaObject(), and dynamicPropertyNames().
sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void ) -> c_int
Calls C++ function: virtual int QObject::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QObject::qt_metacast(const char* arg1)
.
sourcepub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)
pub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)
Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.
Calls C++ function: void QObject::removeEventFilter(QObject* obj)
.
Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.
All event filters for this object are automatically removed when this object is destroyed.
It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function).
See also installEventFilter(), eventFilter(), and event().
sourcepub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)
pub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)
This property holds the name of this object
Calls C++ function: void QObject::setObjectName(const QString& name)
.
This property holds the name of this object
You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().
qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”, qPrintable(objectName()), newPrecision);
By default, this property contains an empty string.
Access functions:
QString | objectName() const |
void | setObjectName(const QString &name) |
Notifier signal:
void | objectNameChanged(const QString &objectName) | [see note below] |
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
See also metaObject() and QMetaObject::className().
sourcepub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)
pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)
Makes the object a child of parent.
Calls C++ function: void QObject::setParent(QObject* parent)
.
sourcepub unsafe fn set_property(
&self,
name: *const c_char,
value: impl CastInto<Ref<QVariant>>
) -> bool
pub unsafe fn set_property( &self, name: *const c_char, value: impl CastInto<Ref<QVariant>> ) -> bool
Sets the value of the object's name property to value.
Calls C++ function: bool QObject::setProperty(const char* name, const QVariant& value)
.
Sets the value of the object’s name property to value.
If the property is defined in the class using Q_PROPERTY then true is returned on success and false otherwise. If the property is not defined using Q_PROPERTY, and therefore not listed in the meta-object, it is added as a dynamic property and false is returned.
Information about all available properties is provided through the metaObject() and dynamicPropertyNames().
Dynamic properties can be queried again using property() and can be removed by setting the property value to an invalid QVariant. Changing the value of a dynamic property causes a QDynamicPropertyChangeEvent to be sent to the object.
Note: Dynamic properties starting with "_q_" are reserved for internal purposes.
See also property(), metaObject(), dynamicPropertyNames(), and QMetaProperty::write().
sourcepub unsafe fn signals_blocked(&self) -> bool
pub unsafe fn signals_blocked(&self) -> bool
Returns true
if signals are blocked; otherwise returns false
.
Calls C++ function: bool QObject::signalsBlocked() const
.
Returns true
if signals are blocked; otherwise returns false
.
Signals are not blocked by default.
See also blockSignals() and QSignalBlocker.
sourcepub unsafe fn start_timer_2a(
&self,
interval: c_int,
timer_type: TimerType
) -> c_int
pub unsafe fn start_timer_2a( &self, interval: c_int, timer_type: TimerType ) -> c_int
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
Calls C++ function: int QObject::startTimer(int interval, Qt::TimerType timerType = …)
.
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.
The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.
If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.
Example:
class MyObject : public QObject { Q_OBJECT
public: MyObject(QObject *parent = 0);
protected: void timerEvent(QTimerEvent *event); };
MyObject::MyObject(QObject *parent) : QObject(parent) { startTimer(50); // 50-millisecond timer startTimer(1000); // 1-second timer startTimer(60000); // 1-minute timer
using namespace std::chrono; startTimer(milliseconds(50)); startTimer(seconds(1)); startTimer(minutes(1));
// since C++14 we can use std::chrono::duration literals, e.g.: startTimer(100ms); startTimer(5s); startTimer(2min); startTimer(1h); }
void MyObject::timerEvent(QTimerEvent *event) { qDebug() << “Timer ID:” << event->timerId(); }
Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.
The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.
See also timerEvent(), killTimer(), and QTimer::singleShot().
sourcepub unsafe fn start_timer_1a(&self, interval: c_int) -> c_int
pub unsafe fn start_timer_1a(&self, interval: c_int) -> c_int
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
Calls C++ function: int QObject::startTimer(int interval)
.
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.
The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.
If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.
Example:
class MyObject : public QObject { Q_OBJECT
public: MyObject(QObject *parent = 0);
protected: void timerEvent(QTimerEvent *event); };
MyObject::MyObject(QObject *parent) : QObject(parent) { startTimer(50); // 50-millisecond timer startTimer(1000); // 1-second timer startTimer(60000); // 1-minute timer
using namespace std::chrono; startTimer(milliseconds(50)); startTimer(seconds(1)); startTimer(minutes(1));
// since C++14 we can use std::chrono::duration literals, e.g.: startTimer(100ms); startTimer(5s); startTimer(2min); startTimer(1h); }
void MyObject::timerEvent(QTimerEvent *event) { qDebug() << “Timer ID:” << event->timerId(); }
Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.
The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.
See also timerEvent(), killTimer(), and QTimer::singleShot().
sourcepub unsafe fn thread(&self) -> QPtr<QThread>
pub unsafe fn thread(&self) -> QPtr<QThread>
Returns the thread in which the object lives.
Calls C++ function: QThread* QObject::thread() const
.
Returns the thread in which the object lives.
See also moveToThread().
Trait Implementations§
source§impl CppDeletable for QSequentialAnimationGroup
impl CppDeletable for QSequentialAnimationGroup
source§impl Deref for QSequentialAnimationGroup
impl Deref for QSequentialAnimationGroup
source§fn deref(&self) -> &QAnimationGroup
fn deref(&self) -> &QAnimationGroup
Calls C++ function: QAnimationGroup* static_cast<QAnimationGroup*>(QSequentialAnimationGroup* ptr)
.
§type Target = QAnimationGroup
type Target = QAnimationGroup
source§impl DynamicCast<QSequentialAnimationGroup> for QAbstractAnimation
impl DynamicCast<QSequentialAnimationGroup> for QAbstractAnimation
source§unsafe fn dynamic_cast(
ptr: Ptr<QAbstractAnimation>
) -> Ptr<QSequentialAnimationGroup>
unsafe fn dynamic_cast( ptr: Ptr<QAbstractAnimation> ) -> Ptr<QSequentialAnimationGroup>
Calls C++ function: QSequentialAnimationGroup* dynamic_cast<QSequentialAnimationGroup*>(QAbstractAnimation* ptr)
.
source§impl DynamicCast<QSequentialAnimationGroup> for QAnimationGroup
impl DynamicCast<QSequentialAnimationGroup> for QAnimationGroup
source§unsafe fn dynamic_cast(
ptr: Ptr<QAnimationGroup>
) -> Ptr<QSequentialAnimationGroup>
unsafe fn dynamic_cast( ptr: Ptr<QAnimationGroup> ) -> Ptr<QSequentialAnimationGroup>
Calls C++ function: QSequentialAnimationGroup* dynamic_cast<QSequentialAnimationGroup*>(QAnimationGroup* ptr)
.
source§impl DynamicCast<QSequentialAnimationGroup> for QObject
impl DynamicCast<QSequentialAnimationGroup> for QObject
source§unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QSequentialAnimationGroup>
unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QSequentialAnimationGroup>
Calls C++ function: QSequentialAnimationGroup* dynamic_cast<QSequentialAnimationGroup*>(QObject* ptr)
.
source§impl StaticDowncast<QSequentialAnimationGroup> for QAbstractAnimation
impl StaticDowncast<QSequentialAnimationGroup> for QAbstractAnimation
source§unsafe fn static_downcast(
ptr: Ptr<QAbstractAnimation>
) -> Ptr<QSequentialAnimationGroup>
unsafe fn static_downcast( ptr: Ptr<QAbstractAnimation> ) -> Ptr<QSequentialAnimationGroup>
Calls C++ function: QSequentialAnimationGroup* static_cast<QSequentialAnimationGroup*>(QAbstractAnimation* ptr)
.
source§impl StaticDowncast<QSequentialAnimationGroup> for QAnimationGroup
impl StaticDowncast<QSequentialAnimationGroup> for QAnimationGroup
source§unsafe fn static_downcast(
ptr: Ptr<QAnimationGroup>
) -> Ptr<QSequentialAnimationGroup>
unsafe fn static_downcast( ptr: Ptr<QAnimationGroup> ) -> Ptr<QSequentialAnimationGroup>
Calls C++ function: QSequentialAnimationGroup* static_cast<QSequentialAnimationGroup*>(QAnimationGroup* ptr)
.
source§impl StaticDowncast<QSequentialAnimationGroup> for QObject
impl StaticDowncast<QSequentialAnimationGroup> for QObject
source§unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QSequentialAnimationGroup>
unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QSequentialAnimationGroup>
Calls C++ function: QSequentialAnimationGroup* static_cast<QSequentialAnimationGroup*>(QObject* ptr)
.
source§impl StaticUpcast<QAbstractAnimation> for QSequentialAnimationGroup
impl StaticUpcast<QAbstractAnimation> for QSequentialAnimationGroup
source§unsafe fn static_upcast(
ptr: Ptr<QSequentialAnimationGroup>
) -> Ptr<QAbstractAnimation>
unsafe fn static_upcast( ptr: Ptr<QSequentialAnimationGroup> ) -> Ptr<QAbstractAnimation>
Calls C++ function: QAbstractAnimation* static_cast<QAbstractAnimation*>(QSequentialAnimationGroup* ptr)
.
source§impl StaticUpcast<QAnimationGroup> for QSequentialAnimationGroup
impl StaticUpcast<QAnimationGroup> for QSequentialAnimationGroup
source§unsafe fn static_upcast(
ptr: Ptr<QSequentialAnimationGroup>
) -> Ptr<QAnimationGroup>
unsafe fn static_upcast( ptr: Ptr<QSequentialAnimationGroup> ) -> Ptr<QAnimationGroup>
Calls C++ function: QAnimationGroup* static_cast<QAnimationGroup*>(QSequentialAnimationGroup* ptr)
.
source§impl StaticUpcast<QObject> for QSequentialAnimationGroup
impl StaticUpcast<QObject> for QSequentialAnimationGroup
source§unsafe fn static_upcast(ptr: Ptr<QSequentialAnimationGroup>) -> Ptr<QObject>
unsafe fn static_upcast(ptr: Ptr<QSequentialAnimationGroup>) -> Ptr<QObject>
Calls C++ function: QObject* static_cast<QObject*>(QSequentialAnimationGroup* ptr)
.