API reference - Class QPair_int_int
Notation used in Ruby API documentation
Description: Represents a QPair<int, int>
- Public constructors
- Public methods
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
n
Public constructors
| new QPair_int_int ptr | new | Creates a new pair | |
| new QPair_int_int ptr | new | (int first, int second) | Creates a new pair from the given arguments |
Public methods
| [const] | bool | == | (const QPair_int_int other) | Returns true if self is equal to the other pair |
| 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. | ||
| void | assign | (const QPair_int_int other) | Assigns another object to self | |
| [const] | new QPair_int_int ptr | dup | Creates a copy of self | |
| [const] | int | first | Returns the first element of the pair | |
| void | first= | (int first) | Sets the first element of the pair | |
| [const] | int | second | Returns the second element of the pair | |
| void | second= | (int second) | Sets the second element of the pair |
Deprecated methods (protected, public, static, non-static and constructors)
| 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 |
Detailed description
== | Signature: [const] bool == (const QPair_int_int other) Description: Returns true if self is equal to the other pair |
_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: void assign (const QPair_int_int other) Description: Assigns another object to self |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead |
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 |
dup | Signature: [const] new QPair_int_int ptr dup Description: Creates a copy of self |
first | Signature: [const] int first Description: Returns the first element of the pair Python specific notes: |
first= | Signature: void first= (int first) Description: Sets the first element of the pair 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 |
new | Signature: [static] new QPair_int_int ptr new Description: Creates a new pair Python specific notes: |
Signature: [static] new QPair_int_int ptr new (int first,int second) Description: Creates a new pair from the given arguments Python specific notes: | |
second | Signature: [const] int second Description: Returns the second element of the pair Python specific notes: |
second= | Signature: void second= (int second) Description: Sets the second element of the pair Python specific notes: |