Notation used in Ruby API documentation
Module: QtGui
Description: Binding of QTextFrame::iterator
This class is equivalent to the class QTextFrame_Iterator
| new QTextFrame_Iterator | new | Constructor QTextFrame::iterator::iterator() | |
| new QTextFrame_Iterator | new | (const QTextFrame_Iterator o) | Constructor QTextFrame::iterator::iterator(const QTextFrame::iterator &o) |
| [const] | bool | != | (const QTextFrame_Iterator o) | Method bool QTextFrame::iterator::operator!=(const QTextFrame::iterator &o) |
| QTextFrame_Iterator | ++ | Method QTextFrame::iterator &QTextFrame::iterator::operator++() | ||
| QTextFrame_Iterator | ++ | (int arg1) | Method QTextFrame::iterator QTextFrame::iterator::operator++(int) | |
| QTextFrame_Iterator | -- | Method QTextFrame::iterator &QTextFrame::iterator::operator--() | ||
| QTextFrame_Iterator | -- | (int arg1) | Method QTextFrame::iterator QTextFrame::iterator::operator--(int) | |
| [const] | bool | == | (const QTextFrame_Iterator o) | Method bool QTextFrame::iterator::operator==(const QTextFrame::iterator &o) |
| void | _assign | (const QTextFrame_Iterator other) | Assigns another object to self | |
| [const] | QTextFrame_Iterator ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| QTextFrame_Iterator | assign | (const QTextFrame_Iterator o) | Method QTextFrame::iterator &QTextFrame::iterator::operator=(const QTextFrame::iterator &o) | |
| [const] | bool | atEnd | Method bool QTextFrame::iterator::atEnd() | |
| [const] | QTextBlock | currentBlock | Method QTextBlock QTextFrame::iterator::currentBlock() | |
| [const] | QTextFrame ptr | currentFrame | Method QTextFrame *QTextFrame::iterator::currentFrame() | |
| [const] | new QTextFrame_Iterator ptr | dup | Creates a copy of self | |
| [const] | QTextFrame ptr | parentFrame | Method QTextFrame *QTextFrame::iterator::parentFrame() |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
!= | Signature: [const] bool != (const QTextFrame_Iterator o) Description: Method bool QTextFrame::iterator::operator!=(const QTextFrame::iterator &o) |
++ | (1) Signature: QTextFrame_Iterator ++ Description: Method QTextFrame::iterator &QTextFrame::iterator::operator++() |
(2) Signature: QTextFrame_Iterator ++ (int arg1) Description: Method QTextFrame::iterator QTextFrame::iterator::operator++(int) | |
-- | (1) Signature: QTextFrame_Iterator -- Description: Method QTextFrame::iterator &QTextFrame::iterator::operator--() |
(2) Signature: QTextFrame_Iterator -- (int arg1) Description: Method QTextFrame::iterator QTextFrame::iterator::operator--(int) | |
== | Signature: [const] bool == (const QTextFrame_Iterator o) Description: Method bool QTextFrame::iterator::operator==(const QTextFrame::iterator &o) |
_assign | Signature: void _assign (const QTextFrame_Iterator other) Description: Assigns another object to self |
_const_cast | Signature: [const] QTextFrame_Iterator ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: 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. |
_destroy | Signature: 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. |
_destroyed? | Signature: [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. |
_is_const_object? | Signature: [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. |
_manage | Signature: 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. |
_unmanage | Signature: 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. |
assign | Signature: QTextFrame_Iterator assign (const QTextFrame_Iterator o) Description: Method QTextFrame::iterator &QTextFrame::iterator::operator=(const QTextFrame::iterator &o) |
atEnd | Signature: [const] bool atEnd Description: Method bool QTextFrame::iterator::atEnd() |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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. |
currentBlock | Signature: [const] QTextBlock currentBlock Description: Method QTextBlock QTextFrame::iterator::currentBlock() |
currentFrame | Signature: [const] QTextFrame ptr currentFrame Description: Method QTextFrame *QTextFrame::iterator::currentFrame() |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead 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. |
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead 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. |
dup | Signature: [const] new QTextFrame_Iterator ptr dup Description: Creates a copy of self Python specific notes: |
is_const_object? | Signature: [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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
new | (1) Signature: [static] new QTextFrame_Iterator new Description: Constructor QTextFrame::iterator::iterator() This method creates an object of class QTextFrame::iterator. Python specific notes: |
(2) Signature: [static] new QTextFrame_Iterator new (const QTextFrame_Iterator o) Description: Constructor QTextFrame::iterator::iterator(const QTextFrame::iterator &o) This method creates an object of class QTextFrame::iterator. Python specific notes: | |
parentFrame | Signature: [const] QTextFrame ptr parentFrame Description: Method QTextFrame *QTextFrame::iterator::parentFrame() |