|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QUndoGroup
public class QUndoGroup
The QUndoGroup class is a group of QUndoStack objects.
For an overview of the Qt's undo framework, see the overview.
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 and redo slot, which calls QUndoStack::undo() and QUndoStack::redo() for the active stack. It also has the functions createUndoAction and createRedoAction. The actions returned by these functions behave in the same way as those returned by QUndoStack::createUndoAction() and QUndoStack::createRedoAction() of the active stack.
Stacks are added to a group with addStack and removed with 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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
Field Summary | |
---|---|
QSignalEmitter.Signal1<QUndoStack> |
activeStackChanged
This signal is emitted whenever the active stack of the group changes. |
QSignalEmitter.Signal1<java.lang.Boolean> |
canRedoChanged
This signal is emitted whenever the active stack emits QUndoStack::canRedoChanged() or the active stack changes. |
QSignalEmitter.Signal1<java.lang.Boolean> |
canUndoChanged
This signal is emitted whenever the active stack emits QUndoStack::canUndoChanged() or the active stack changes. |
QSignalEmitter.Signal1<java.lang.Boolean> |
cleanChanged
This signal is emitted whenever the active stack emits QUndoStack::cleanChanged() or the active stack changes. |
QSignalEmitter.Signal1<java.lang.Integer> |
indexChanged
This signal is emitted whenever the active stack emits QUndoStack::indexChanged() or the active stack changes. |
QSignalEmitter.Signal1<java.lang.String> |
redoTextChanged
This signal is emitted whenever the active stack emits QUndoStack::redoTextChanged() or the active stack changes. |
QSignalEmitter.Signal1<java.lang.String> |
undoTextChanged
This signal is emitted whenever the active stack emits QUndoStack::undoTextChanged() or the active stack changes. |
Constructor Summary | |
---|---|
QUndoGroup()
Equivalent to QUndoGroup(0). |
|
QUndoGroup(QObject parent)
Creates an empty QUndoGroup object with parent parent. |
Method Summary | |
---|---|
QUndoStack |
activeStack()
Returns the active stack of this group. |
void |
addStack(QUndoStack stack)
Adds stack to this group. |
boolean |
canRedo()
Returns the value of the active stack's QUndoStack::canRedo(). |
boolean |
canUndo()
Returns the value of the active stack's QUndoStack::canUndo(). |
QAction |
createRedoAction(QObject parent)
Equivalent to createRedoAction(parent, QString()). |
QAction |
createRedoAction(QObject parent,
java.lang.String prefix)
Creates an redo QAction object with parent parent. |
QAction |
createUndoAction(QObject parent)
Equivalent to createUndoAction(parent, QString()). |
QAction |
createUndoAction(QObject parent,
java.lang.String prefix)
Creates an undo QAction object with parent parent. |
static QUndoGroup |
fromNativePointer(QNativePointer nativePointer)
This function returns the QUndoGroup instance pointed to by nativePointer |
boolean |
isClean()
Returns the value of the active stack's QUndoStack::isClean(). |
void |
redo()
Calls QUndoStack::redo() on the active stack. |
java.lang.String |
redoText()
Returns the value of the active stack's QUndoStack::redoText(). |
void |
removeStack(QUndoStack stack)
Removes stack from this group. |
void |
setActiveStack(QUndoStack stack)
Sets the active stack of this group to stack. |
java.util.List<QUndoStack> |
stacks()
Returns a list of stacks in this group. |
void |
undo()
Calls QUndoStack::undo() on the active stack. |
java.lang.String |
undoText()
Returns the value of the active stack's QUndoStack::undoText(). |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
blockSignals, childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, property, removeEventFilter, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
disconnect, disconnect, signalSender |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1<QUndoStack> activeStackChanged
This signal is emitted whenever the active stack of the group changes. This can happen when setActiveStack or 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 is 0.
public final QSignalEmitter.Signal1<java.lang.Boolean> canRedoChanged
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.
public final QSignalEmitter.Signal1<java.lang.Boolean> canUndoChanged
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.
public final QSignalEmitter.Signal1<java.lang.Boolean> cleanChanged
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.
public final QSignalEmitter.Signal1<java.lang.Integer> indexChanged
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.
public final QSignalEmitter.Signal1<java.lang.String> redoTextChanged
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.
public final QSignalEmitter.Signal1<java.lang.String> undoTextChanged
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.
Constructor Detail |
---|
public QUndoGroup()
Equivalent to QUndoGroup(0).
public QUndoGroup(QObject parent)
Creates an empty QUndoGroup object with parent parent.
Method Detail |
---|
public final QUndoStack activeStack()
Returns the active stack of this group.
If none of the stacks are active, or if the group is empty, this function returns 0.
public final void addStack(QUndoStack stack)
Adds 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.
public final boolean canRedo()
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.
public final boolean canUndo()
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.
public final QAction createRedoAction(QObject parent)
Equivalent to createRedoAction(parent, QString()).
public final QAction createRedoAction(QObject parent, java.lang.String prefix)
Creates an redo 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.
If prefix is empty, the default prefix "Undo" is used.
public final QAction createUndoAction(QObject parent)
Equivalent to createUndoAction(parent, QString()).
public final QAction createUndoAction(QObject parent, java.lang.String prefix)
Creates an undo 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.
If prefix is empty, the default prefix "Undo" is used.
public final boolean isClean()
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.
public final void redo()
Calls QUndoStack::redo() on the active stack.
If none of the stacks are active, or if the group is empty, this function does nothing.
public final java.lang.String redoText()
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.
public final void removeStack(QUndoStack stack)
Removes stack from this group. If the stack was the active stack in the group, the active stack becomes 0.
public final void 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() on stack.
The actions returned by createUndoAction and createRedoAction will now behave in the same way as those returned by stack's QUndoStack::createUndoAction() and QUndoStack::createRedoAction().
public final java.util.List<QUndoStack> stacks()
Returns a list of stacks in this group.
public final void undo()
Calls QUndoStack::undo() on the active stack.
If none of the stacks are active, or if the group is empty, this function does nothing.
public final java.lang.String undoText()
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.
public static QUndoGroup fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |