API reference - Class QUndoGroup

Notation used in Ruby API documentation

Description: Binding of QUndoGroup

Class hierarchy: QUndoGroup » QObject

Public constructors

new QUndoGroupnew(QObject ptr parent = 0)Constructor QUndoGroup::QUndoGroup(QObject *parent)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]QUndoStack ptractiveStackMethod QUndoStack *QUndoGroup::activeStack()
voidactiveStack=(QUndoStack ptr stack)Method void QUndoGroup::setActiveStack(QUndoStack *stack)
[event]voidactiveStackChanged(QUndoStack ptr stack)Signal declaration for QUndoGroup::activeStackChanged(QUndoStack *stack)
voidaddStack(QUndoStack ptr stack)Method void QUndoGroup::addStack(QUndoStack *stack)
[const]boolcanRedoMethod bool QUndoGroup::canRedo()
[event]voidcanRedoChanged(bool canRedo)Signal declaration for QUndoGroup::canRedoChanged(bool canRedo)
[const]boolcanUndoMethod bool QUndoGroup::canUndo()
[event]voidcanUndoChanged(bool canUndo)Signal declaration for QUndoGroup::canUndoChanged(bool canUndo)
[event]voidcleanChanged(bool clean)Signal declaration for QUndoGroup::cleanChanged(bool clean)
[const]QAction ptrcreateRedoAction(QObject ptr parent,
string prefix = QString())
Method QAction *QUndoGroup::createRedoAction(QObject *parent, const QString &prefix)
[const]QAction ptrcreateUndoAction(QObject ptr parent,
string prefix = QString())
Method QAction *QUndoGroup::createUndoAction(QObject *parent, const QString &prefix)
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QUndoGroup::destroyed(QObject *)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QUndoGroup::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QUndoGroup::eventFilter(QObject *, QEvent *)
[event]voidindexChanged(int idx)Signal declaration for QUndoGroup::indexChanged(int idx)
[const]boolisClean?Method bool QUndoGroup::isClean()
voidredoMethod void QUndoGroup::redo()
[const]stringredoTextMethod QString QUndoGroup::redoText()
[event]voidredoTextChanged(string redoText)Signal declaration for QUndoGroup::redoTextChanged(const QString &redoText)
voidremoveStack(QUndoStack ptr stack)Method void QUndoGroup::removeStack(QUndoStack *stack)
voidsetActiveStack(QUndoStack ptr stack)Method void QUndoGroup::setActiveStack(QUndoStack *stack)
[const]QUndoStack ptr[]stacksMethod QList<QUndoStack *> QUndoGroup::stacks()
voidundoMethod void QUndoGroup::undo()
[const]stringundoTextMethod QString QUndoGroup::undoText()
[event]voidundoTextChanged(string undoText)Signal declaration for QUndoGroup::undoTextChanged(const QString &undoText)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QUndoGroup::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QUndoGroup::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QUndoGroup::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QUndoGroup::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QUndoGroup::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QUndoGroup::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QUndoGroup::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QUndoGroup::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QUndoGroup::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QUndoGroup::timerEvent(QTimerEvent *)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[const] QUndoStack ptr activeStack

Description: Method QUndoStack *QUndoGroup::activeStack()

Python specific notes:

The object exposes a readable attribute 'activeStack'. This is the getter.

void activeStack=(QUndoStack ptr stack)

Description: Method void QUndoGroup::setActiveStack(QUndoStack *stack)

Python specific notes:

The object exposes a writable attribute 'activeStack'. This is the setter.

[event] void activeStackChanged(QUndoStack ptr stack)

Description: Signal declaration for QUndoGroup::activeStackChanged(QUndoStack *stack)

You can bind a procedure to this signal.

void addStack(QUndoStack ptr stack)

Description: Method void QUndoGroup::addStack(QUndoStack *stack)

[const] bool canRedo

Description: Method bool QUndoGroup::canRedo()

[event] void canRedoChanged(bool canRedo)

Description: Signal declaration for QUndoGroup::canRedoChanged(bool canRedo)

You can bind a procedure to this signal.

[const] bool canUndo

Description: Method bool QUndoGroup::canUndo()

[event] void canUndoChanged(bool canUndo)

Description: Signal declaration for QUndoGroup::canUndoChanged(bool canUndo)

You can bind a procedure to this signal.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QUndoGroup::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

[event] void cleanChanged(bool clean)

Description: Signal declaration for QUndoGroup::cleanChanged(bool clean)

You can bind a procedure to this signal.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] QAction ptr createRedoAction(QObject ptr parent,string prefix = QString())

Description: Method QAction *QUndoGroup::createRedoAction(QObject *parent, const QString &prefix)

[const] QAction ptr createUndoAction(QObject ptr parent,string prefix = QString())

Description: Method QAction *QUndoGroup::createUndoAction(QObject *parent, const QString &prefix)

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QUndoGroup::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QUndoGroup::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QUndoGroup::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QUndoGroup::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QUndoGroup::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[event] void indexChanged(int idx)

Description: Signal declaration for QUndoGroup::indexChanged(int idx)

You can bind a procedure to this signal.

[const] bool isClean?

Description: Method bool QUndoGroup::isClean()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[static] new QUndoGroup new(QObject ptr parent = 0)

Description: Constructor QUndoGroup::QUndoGroup(QObject *parent)

This method creates an object of class QUndoGroup.

Python specific notes:

This method is the default initializer of the object

[const] int receivers(string signal)

Description: Method int QUndoGroup::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

void redo

Description: Method void QUndoGroup::redo()

[const] string redoText

Description: Method QString QUndoGroup::redoText()

[event] void redoTextChanged(string redoText)

Description: Signal declaration for QUndoGroup::redoTextChanged(const QString &redoText)

You can bind a procedure to this signal.

void removeStack(QUndoStack ptr stack)

Description: Method void QUndoGroup::removeStack(QUndoStack *stack)

[const] QObject ptr sender

Description: Method QObject *QUndoGroup::sender()

This method is protected and can only be called from inside a derived class.

void setActiveStack(QUndoStack ptr stack)

Description: Method void QUndoGroup::setActiveStack(QUndoStack *stack)

Python specific notes:

The object exposes a writable attribute 'activeStack'. This is the setter.

[const] QUndoStack ptr[] stacks

Description: Method QList<QUndoStack *> QUndoGroup::stacks()

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QUndoGroup::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QUndoGroup::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QUndoGroup::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QUndoGroup::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QUndoGroup::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

void undo

Description: Method void QUndoGroup::undo()

[const] string undoText

Description: Method QString QUndoGroup::undoText()

[event] void undoTextChanged(string undoText)

Description: Signal declaration for QUndoGroup::undoTextChanged(const QString &undoText)

You can bind a procedure to this signal.