KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QSourceLocation

Notation used in Ruby API documentation

Module: QtXmlPatterns

Description: Binding of QSourceLocation

Public constructors

new QSourceLocationnewConstructor QSourceLocation::QSourceLocation()
new QSourceLocationnew(const QSourceLocation other)Constructor QSourceLocation::QSourceLocation(const QSourceLocation &other)
new QSourceLocationnew(const QUrl uri,
int line = -1,
int column = -1)
Constructor QSourceLocation::QSourceLocation(const QUrl &uri, int line, int column)

Public methods

[const]bool!=(const QSourceLocation other)Method bool QSourceLocation::operator!=(const QSourceLocation &other)
[const]bool==(const QSourceLocation other)Method bool QSourceLocation::operator==(const QSourceLocation &other)
void_assign(const QSourceLocation other)Assigns another object to self
[const]QSourceLocation ptr_const_castReturns a non-const reference to self.
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.
QSourceLocationassign(const QSourceLocation other)Method QSourceLocation &QSourceLocation::operator=(const QSourceLocation &other)
[const]long longcolumnMethod qint64 QSourceLocation::column()
voidcolumn=(long long newColumn)Method void QSourceLocation::setColumn(qint64 newColumn)
[const]new QSourceLocation ptrdupCreates a copy of self
[const]boolisNull?Method bool QSourceLocation::isNull()
[const]long longlineMethod qint64 QSourceLocation::line()
voidline=(long long newLine)Method void QSourceLocation::setLine(qint64 newLine)
voidsetColumn(long long newColumn)Method void QSourceLocation::setColumn(qint64 newColumn)
voidsetLine(long long newLine)Method void QSourceLocation::setLine(qint64 newLine)
voidsetUri(const QUrl newUri)Method void QSourceLocation::setUri(const QUrl &newUri)
[const]QUrluriMethod QUrl QSourceLocation::uri()
voiduri=(const QUrl newUri)Method void QSourceLocation::setUri(const QUrl &newUri)

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

!=

Signature: [const] bool != (const QSourceLocation other)

Description: Method bool QSourceLocation::operator!=(const QSourceLocation &other)

==

Signature: [const] bool == (const QSourceLocation other)

Description: Method bool QSourceLocation::operator==(const QSourceLocation &other)

_assign

Signature: void _assign (const QSourceLocation other)

Description: Assigns another object to self

_const_cast

Signature: [const] QSourceLocation 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: QSourceLocation assign (const QSourceLocation other)

Description: Method QSourceLocation &QSourceLocation::operator=(const QSourceLocation &other)

column

Signature: [const] long long column

Description: Method qint64 QSourceLocation::column()

Python specific notes:
The object exposes a readable attribute 'column'. This is the getter.

column=

Signature: void column= (long long newColumn)

Description: Method void QSourceLocation::setColumn(qint64 newColumn)

Python specific notes:
The object exposes a writable attribute 'column'. This is the setter.

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.

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 QSourceLocation ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

isNull?

Signature: [const] bool isNull?

Description: Method bool QSourceLocation::isNull()

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.

line

Signature: [const] long long line

Description: Method qint64 QSourceLocation::line()

Python specific notes:
The object exposes a readable attribute 'line'. This is the getter.

line=

Signature: void line= (long long newLine)

Description: Method void QSourceLocation::setLine(qint64 newLine)

Python specific notes:
The object exposes a writable attribute 'line'. This is the setter.

new

(1) Signature: [static] new QSourceLocation new

Description: Constructor QSourceLocation::QSourceLocation()

This method creates an object of class QSourceLocation.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSourceLocation new (const QSourceLocation other)

Description: Constructor QSourceLocation::QSourceLocation(const QSourceLocation &other)

This method creates an object of class QSourceLocation.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QSourceLocation new (const QUrl uri, int line = -1, int column = -1)

Description: Constructor QSourceLocation::QSourceLocation(const QUrl &uri, int line, int column)

This method creates an object of class QSourceLocation.

Python specific notes:
This method is the default initializer of the object.

setColumn

Signature: void setColumn (long long newColumn)

Description: Method void QSourceLocation::setColumn(qint64 newColumn)

Python specific notes:
The object exposes a writable attribute 'column'. This is the setter.

setLine

Signature: void setLine (long long newLine)

Description: Method void QSourceLocation::setLine(qint64 newLine)

Python specific notes:
The object exposes a writable attribute 'line'. This is the setter.

setUri

Signature: void setUri (const QUrl newUri)

Description: Method void QSourceLocation::setUri(const QUrl &newUri)

Python specific notes:
The object exposes a writable attribute 'uri'. This is the setter.

uri

Signature: [const] QUrl uri

Description: Method QUrl QSourceLocation::uri()

Python specific notes:
The object exposes a readable attribute 'uri'. This is the getter.

uri=

Signature: void uri= (const QUrl newUri)

Description: Method void QSourceLocation::setUri(const QUrl &newUri)

Python specific notes:
The object exposes a writable attribute 'uri'. This is the setter.