QUndoGroup 类是组为 QUndoStack 对象。 更多...
| 头： | #include <QUndoGroup> |
| CMake: |
find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| 继承： | QObject |
| QUndoGroup (QObject * parent = nullptr) | |
| virtual | ~QUndoGroup () |
| QUndoStack * | activeStack () const |
| void | addStack (QUndoStack * stack ) |
| bool | canRedo () const |
| bool | canUndo () const |
| QAction * | createRedoAction (QObject * parent , const QString & prefix = QString()) const |
| QAction * | createUndoAction (QObject * parent , const QString & prefix = QString()) const |
| bool | isClean () const |
| QString | redoText () const |
| void | removeStack (QUndoStack * stack ) |
| QList<QUndoStack *> | stacks () const |
| QString | undoText () const |
| void | redo () |
| void | setActiveStack (QUndoStack * stack ) |
| void | undo () |
| void | activeStackChanged (QUndoStack * stack ) |
| void | canRedoChanged (bool canRedo ) |
| void | canUndoChanged (bool canUndo ) |
| void | cleanChanged (bool clean ) |
| void | indexChanged (int idx ) |
| void | redoTextChanged (const QString & redoText ) |
| void | undoTextChanged (const QString & undoText ) |
有关 Qt 撤消框架的概述，见 概述 .
An application often has multiple undo stacks, one for each opened document. At the same time, an application usually has one undo action and one redo action, which triggers undo or redo in the active document.
QUndoGroup is a group of QUndoStack objects, one of which may be active. It has an undo () 和 redo () slot, which calls QUndoStack::undo () 和 QUndoStack::redo () for the active stack. It also has the functions createUndoAction () 和 createRedoAction (). The actions returned by these functions behave in the same way as those returned by QUndoStack::createUndoAction () 和 QUndoStack::createRedoAction () of the active stack.
Stacks are added to a group with addStack () 和被移除采用 removeStack (). A stack is implicitly added to a group when it is created with the group as its parent QObject .
It is the programmer's responsibility to specify which stack is active by calling QUndoStack::setActive (), usually when the associated document window receives focus. The active stack may also be set with setActiveStack (), and is returned by activeStack ().
When a stack is added to a group using addStack (), the group does not take ownership of the stack. This means the stack has to be deleted separately from the group. When a stack is deleted, it is automatically removed from a group. A stack may belong to only one group. Adding it to another group will cause it to be removed from the previous group.
A QUndoGroup is also useful in conjunction with QUndoView . If a QUndoView is set to watch a group using QUndoView::setGroup (), it will update itself to display the active stack.
[explicit]
QUndoGroup::
QUndoGroup
(
QObject
*
parent
= nullptr)
Creates an empty QUndoGroup object with parent parent .
另请参阅 addStack ().
[virtual noexcept]
QUndoGroup::
~QUndoGroup
()
销毁 QUndoGroup .
Returns the active stack of this group.
If none of the stacks are active, or if the group is empty, this function returns
nullptr
.
另请参阅 setActiveStack () 和 QUndoStack::setActive ().
[signal]
void
QUndoGroup::
activeStackChanged
(
QUndoStack
*
stack
)
This signal is emitted whenever the active stack of the group changes. This can happen when setActiveStack () 或 QUndoStack::setActive () is called, or when the active stack is removed form the group. stack is the new active stack. If no stack is active, stack 为 0。
另请参阅 setActiveStack () 和 QUndoStack::setActive ().
添加 stack to this group. The group does not take ownership of the stack. Another way of adding a stack to a group is by specifying the group as the stack's parent QObject in QUndoStack::QUndoStack (). In this case, the stack is deleted when the group is deleted, in the usual manner of QObjects.
另请参阅 removeStack (), stacks ()，和 QUndoStack::QUndoStack ().
Returns the value of the active stack's QUndoStack::canRedo ().
If none of the stacks are active, or if the group is empty, this function returns
false
.
另请参阅 canUndo () 和 setActiveStack ().
[signal]
void
QUndoGroup::
canRedoChanged
(
bool
canRedo
)
This signal is emitted whenever the active stack emits QUndoStack::canRedoChanged () or the active stack changes.
canRedo is the new state, or false if the active stack is 0.
另请参阅 QUndoStack::canRedoChanged () 和 setActiveStack ().
Returns the value of the active stack's QUndoStack::canUndo ().
If none of the stacks are active, or if the group is empty, this function returns
false
.
另请参阅 canRedo () 和 setActiveStack ().
[signal]
void
QUndoGroup::
canUndoChanged
(
bool
canUndo
)
This signal is emitted whenever the active stack emits QUndoStack::canUndoChanged () or the active stack changes.
canUndo is the new state, or false if the active stack is 0.
另请参阅 QUndoStack::canUndoChanged () 和 setActiveStack ().
[signal]
void
QUndoGroup::
cleanChanged
(
bool
clean
)
This signal is emitted whenever the active stack emits QUndoStack::cleanChanged () or the active stack changes.
clean is the new state, or true if the active stack is 0.
另请参阅 QUndoStack::cleanChanged () 和 setActiveStack ().
创建重做 QAction object with parent parent .
Triggering this action will cause a call to QUndoStack::redo () on the active stack. The text of this action will always be the text of the command which will be redone in the next call to redo (), prefixed by prefix . If there is no command available for redo, if the group is empty or if none of the stacks are active, this action will be disabled.
若 prefix is empty, the default template "Redo %1" is used instead of prefix. Before Qt 4.8, the prefix "Redo" was used by default.
另请参阅 createUndoAction (), canRedo ()，和 QUndoCommand::text ().
创建撤消 QAction object with parent parent .
Triggering this action will cause a call to QUndoStack::undo () on the active stack. The text of this action will always be the text of the command which will be undone in the next call to undo (), prefixed by prefix . If there is no command available for undo, if the group is empty or if none of the stacks are active, this action will be disabled.
若 prefix is empty, the default template "Undo %1" is used instead of prefix. Before Qt 4.8, the prefix "Undo" was used by default.
另请参阅 createRedoAction (), canUndo ()，和 QUndoCommand::text ().
[signal]
void
QUndoGroup::
indexChanged
(
int
idx
)
This signal is emitted whenever the active stack emits QUndoStack::indexChanged () or the active stack changes.
idx is the new current index, or 0 if the active stack is 0.
另请参阅 QUndoStack::indexChanged () 和 setActiveStack ().
Returns the value of the active stack's QUndoStack::isClean ().
If none of the stacks are active, or if the group is empty, this function returns
true
.
另请参阅 setActiveStack ().
[slot]
void
QUndoGroup::
redo
()
调用 QUndoStack::redo () on the active stack.
If none of the stacks are active, or if the group is empty, this function does nothing.
另请参阅 undo (), canRedo ()，和 setActiveStack ().
Returns the value of the active stack's QUndoStack::redoText ().
If none of the stacks are active, or if the group is empty, this function returns an empty string.
另请参阅 undoText () 和 setActiveStack ().
[signal]
void
QUndoGroup::
redoTextChanged
(const
QString
&
redoText
)
This signal is emitted whenever the active stack emits QUndoStack::redoTextChanged () or the active stack changes.
redoText is the new state, or an empty string if the active stack is 0.
另请参阅 QUndoStack::redoTextChanged () 和 setActiveStack ().
移除 stack from this group. If the stack was the active stack in the group, the active stack becomes 0.
另请参阅 addStack (), stacks ()，和 QUndoStack::~QUndoStack ().
[slot]
void
QUndoGroup::
setActiveStack
(
QUndoStack
*
stack
)
Sets the active stack of this group to stack .
If the stack is not a member of this group, this function does nothing.
Synonymous with calling QUndoStack::setActive () 在 stack .
The actions returned by createUndoAction () 和 createRedoAction () will now behave in the same way as those returned by stack 's QUndoStack::createUndoAction () 和 QUndoStack::createRedoAction ().
另请参阅 QUndoStack::setActive () 和 activeStack ().
Returns a list of stacks in this group.
另请参阅 addStack () 和 removeStack ().
[slot]
void
QUndoGroup::
undo
()
调用 QUndoStack::undo () on the active stack.
If none of the stacks are active, or if the group is empty, this function does nothing.
另请参阅 redo (), canUndo ()，和 setActiveStack ().
Returns the value of the active stack's QUndoStack::undoText ().
If none of the stacks are active, or if the group is empty, this function returns an empty string.
另请参阅 redoText () 和 setActiveStack ().
[signal]
void
QUndoGroup::
undoTextChanged
(const
QString
&
undoText
)
This signal is emitted whenever the active stack emits QUndoStack::undoTextChanged () or the active stack changes.
undoText is the new state, or an empty string if the active stack is 0.
另请参阅 QUndoStack::undoTextChanged () 和 setActiveStack ().