API reference - Class QUndoStack

Notation used in Ruby API documentation

Description: Binding of QUndoStack

Class hierarchy: QUndoStack » QObject

Public constructors

new QUndoStacknew(QObject ptr parent = 0)Constructor QUndoStack::QUndoStack(QObject *parent)

Public methods

voidactive=(bool active = true)Method void QUndoStack::setActive(bool active)
voidbeginMacro(string text)Method void QUndoStack::beginMacro(const QString &text)
[const]boolcanRedoMethod bool QUndoStack::canRedo()
[event]voidcanRedoChanged(bool canRedo)Signal declaration for QUndoStack::canRedoChanged(bool canRedo)
[const]boolcanUndoMethod bool QUndoStack::canUndo()
[event]voidcanUndoChanged(bool canUndo)Signal declaration for QUndoStack::canUndoChanged(bool canUndo)
[event]voidcleanChanged(bool clean)Signal declaration for QUndoStack::cleanChanged(bool clean)
[const]intcleanIndexMethod int QUndoStack::cleanIndex()
voidclearMethod void QUndoStack::clear()
[const]const QUndoCommand ptrcommand(int index)Method const QUndoCommand *QUndoStack::command(int index)
[const]intcountMethod int QUndoStack::count()
voidcreateEnsures the C++ object is created
[const]QAction ptrcreateRedoAction(QObject ptr parent,
string prefix = QString())
Method QAction *QUndoStack::createRedoAction(QObject *parent, const QString &prefix)
[const]QAction ptrcreateUndoAction(QObject ptr parent,
string prefix = QString())
Method QAction *QUndoStack::createUndoAction(QObject *parent, const QString &prefix)
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QUndoStack::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
voidendMacroMethod void QUndoStack::endMacro()
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QUndoStack::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QUndoStack::eventFilter(QObject *, QEvent *)
[const]intindexMethod int QUndoStack::index()
voidindex=(int idx)Method void QUndoStack::setIndex(int idx)
[event]voidindexChanged(int idx)Signal declaration for QUndoStack::indexChanged(int idx)
[const]boolisActiveMethod bool QUndoStack::isActive()
[const]boolisActive?Method bool QUndoStack::isActive()
[const]boolisCleanMethod bool QUndoStack::isClean()
[const]boolisClean?Method bool QUndoStack::isClean()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidpush(QUndoCommand ptr cmd)Method void QUndoStack::push(QUndoCommand *cmd)
voidredoMethod void QUndoStack::redo()
[const]stringredoTextMethod QString QUndoStack::redoText()
[event]voidredoTextChanged(string redoText)Signal declaration for QUndoStack::redoTextChanged(const QString &redoText)
voidsetActive(bool active = true)Method void QUndoStack::setActive(bool active)
voidsetCleanMethod void QUndoStack::setClean()
voidsetIndex(int idx)Method void QUndoStack::setIndex(int idx)
voidsetUndoLimit(int limit)Method void QUndoStack::setUndoLimit(int limit)
[const]stringtext(int idx)Method QString QUndoStack::text(int idx)
voidundoMethod void QUndoStack::undo()
[const]intundoLimitMethod int QUndoStack::undoLimit()
voidundoLimit=(int limit)Method void QUndoStack::setUndoLimit(int limit)
[const]stringundoTextMethod QString QUndoStack::undoText()
[event]voidundoTextChanged(string undoText)Signal declaration for QUndoStack::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 QUndoStack::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QUndoStack::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QUndoStack::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QUndoStack::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

void active=(bool active = true)

Description: Method void QUndoStack::setActive(bool active)

void beginMacro(string text)

Description: Method void QUndoStack::beginMacro(const QString &text)

[const] bool canRedo

Description: Method bool QUndoStack::canRedo()

[event] void canRedoChanged(bool canRedo)

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

You can bind a procedure to this signal.

[const] bool canUndo

Description: Method bool QUndoStack::canUndo()

[event] void canUndoChanged(bool canUndo)

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

You can bind a procedure to this signal.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[event] void cleanChanged(bool clean)

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

You can bind a procedure to this signal.

[const] int cleanIndex

Description: Method int QUndoStack::cleanIndex()

void clear

Description: Method void QUndoStack::clear()

[const] const QUndoCommand ptr command(int index)

Description: Method const QUndoCommand *QUndoStack::command(int index)

[const] int count

Description: Method int QUndoStack::count()

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.

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

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

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

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

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroy the object

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

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[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.

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

void endMacro

Description: Method void QUndoStack::endMacro()

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[const] int index

Description: Method int QUndoStack::index()

void index=(int idx)

Description: Method void QUndoStack::setIndex(int idx)

[event] void indexChanged(int idx)

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

You can bind a procedure to this signal.

[const] bool isActive

Description: Method bool QUndoStack::isActive()

[const] bool isActive?

Description: Method bool QUndoStack::isActive()

[const] bool isClean

Description: Method bool QUndoStack::isClean()

[const] bool isClean?

Description: Method bool QUndoStack::isClean()

[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.

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

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

This method creates an object of class QUndoStack.

void push(QUndoCommand ptr cmd)

Description: Method void QUndoStack::push(QUndoCommand *cmd)

[const] int receivers(string signal)

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

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

void redo

Description: Method void QUndoStack::redo()

[const] string redoText

Description: Method QString QUndoStack::redoText()

[event] void redoTextChanged(string redoText)

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

You can bind a procedure to this signal.

[const] QObject ptr sender

Description: Method QObject *QUndoStack::sender()

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

void setActive(bool active = true)

Description: Method void QUndoStack::setActive(bool active)

void setClean

Description: Method void QUndoStack::setClean()

void setIndex(int idx)

Description: Method void QUndoStack::setIndex(int idx)

void setUndoLimit(int limit)

Description: Method void QUndoStack::setUndoLimit(int limit)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] string text(int idx)

Description: Method QString QUndoStack::text(int idx)

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

Description: Static method QString QUndoStack::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 QUndoStack::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 QUndoStack::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 QUndoStack::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 QUndoStack::undo()

[const] int undoLimit

Description: Method int QUndoStack::undoLimit()

void undoLimit=(int limit)

Description: Method void QUndoStack::setUndoLimit(int limit)

[const] string undoText

Description: Method QString QUndoStack::undoText()

[event] void undoTextChanged(string undoText)

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

You can bind a procedure to this signal.