Files
ispyisail ae6b992ae4 Give QPropertyUndoCommand::undo() its own first-time grace period
redo() has a direct-write path guarded by m_first_time: on the very
first call it writes the property immediately, and only animates on
calls after that (per setAnimated()'s documented contract). undo()
had no equivalent -- it always animated, so undo() both returned
before the property was restored (stale state visible to anything
sharing the call stack) and, with no running event loop, never
restored it at all.

The obvious fix -- reuse m_first_time in undo()'s guard too -- turns
out not to work, and I verified this with a standalone build before
picking an approach: QUndoStack::push() always calls redo() once
before any undo() can run, and redo()'s direct-write branch sets
m_first_time = true as it completes. So by the time undo() is ever
called, m_first_time has already flipped, and reusing it would make
undo() take the animate branch on every call, unconditionally --
syntactically symmetric with redo(), but behaviourally unchanged for
the exact scenario reported.

Instead, undo() gets its own m_undo_first_time flag, seeded from the
same first_time argument setAnimated() already takes, and set true by
undo()'s own direct-write branch the same way m_first_time is set by
redo()'s. That gives undo() a real, reachable direct-write path on its
own first call, independent of how many times redo() has already run.

Verified against a standalone build of just this class (as the issue's
own repro does): first redo and first undo are both now synchronous
with no event loop running; with an event loop present, both settle to
the correct value once "broken in"; behaviour for every other caller
of QPropertyUndoCommand -- everywhere that calls plain enableAnimation()
or the bare setAnimated() (first_time defaulting true) -- is provably
unchanged, since m_undo_first_time starts true either way and the
animate branch never modifies it.

Fixes #755.
2026-08-24 20:10:32 +12:00

66 lines
2.1 KiB
C++

/*
Copyright 2006-2026 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef QPROPERTYUNDOCOMMAND_H
#define QPROPERTYUNDOCOMMAND_H
#include <QUndoCommand>
#include <QVariant>
class QObject;
/**
@brief The QPropertyUndoCommand class
This undo command manage QProperty of a QObject.
This undo command can use QPropertyAnimation to animate the change when undo/redo is call
To use animation call setAnimated(true). By default animation is disable.
Some QVariant date can't be animated and result this command don't work.
*/
class QPropertyUndoCommand : public QUndoCommand
{
public:
QPropertyUndoCommand(QObject *object,
const char *property_name,
const QVariant &old_value,
const QVariant &new_value,
QUndoCommand *parent = nullptr);
QPropertyUndoCommand(QObject *object,
const char *property_name,
const QVariant &old_value,
QUndoCommand *parent = nullptr);
QPropertyUndoCommand(const QPropertyUndoCommand *other);
void setNewValue(const QVariant &new_value);
void enableAnimation (bool animate = true);
void setAnimated(bool animate = true, bool first_time = true);
int id() const override{return 10000;}
bool mergeWith(const QUndoCommand *other) override;
void redo() override;
void undo() override;
private:
QObject *m_object = nullptr;
const char *m_property_name;
QVariant m_old_value, m_new_value;
bool m_animate = false,
m_first_time = true,
m_undo_first_time = true;
};
#endif // QPROPERTYUNDOCOMMAND_H