API reference - Class QNetworkAddressEntry

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QNetworkAddressEntry

Public constructors

new QNetworkAddressEntrynewConstructor QNetworkAddressEntry::QNetworkAddressEntry()
new QNetworkAddressEntrynew(const QNetworkAddressEntry other)Constructor QNetworkAddressEntry::QNetworkAddressEntry(const QNetworkAddressEntry &other)

Public methods

[const]bool!=(const QNetworkAddressEntry other)Method bool QNetworkAddressEntry::operator!=(const QNetworkAddressEntry &other)
[const]bool==(const QNetworkAddressEntry other)Method bool QNetworkAddressEntry::operator==(const QNetworkAddressEntry &other)
void_assign(const QNetworkAddressEntry other)Assigns another object 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.
QNetworkAddressEntryassign(const QNetworkAddressEntry other)Method QNetworkAddressEntry &QNetworkAddressEntry::operator=(const QNetworkAddressEntry &other)
[const]QHostAddressbroadcastMethod QHostAddress QNetworkAddressEntry::broadcast()
voidbroadcast=(const QHostAddress newBroadcast)Method void QNetworkAddressEntry::setBroadcast(const QHostAddress &newBroadcast)
[const]new QNetworkAddressEntry ptrdupCreates a copy of self
[const]QHostAddressipMethod QHostAddress QNetworkAddressEntry::ip()
voidip=(const QHostAddress newIp)Method void QNetworkAddressEntry::setIp(const QHostAddress &newIp)
[const]QHostAddressnetmaskMethod QHostAddress QNetworkAddressEntry::netmask()
voidnetmask=(const QHostAddress newNetmask)Method void QNetworkAddressEntry::setNetmask(const QHostAddress &newNetmask)
[const]intprefixLengthMethod int QNetworkAddressEntry::prefixLength()
voidprefixLength=(int length)Method void QNetworkAddressEntry::setPrefixLength(int length)
voidsetBroadcast(const QHostAddress newBroadcast)Method void QNetworkAddressEntry::setBroadcast(const QHostAddress &newBroadcast)
voidsetIp(const QHostAddress newIp)Method void QNetworkAddressEntry::setIp(const QHostAddress &newIp)
voidsetNetmask(const QHostAddress newNetmask)Method void QNetworkAddressEntry::setNetmask(const QHostAddress &newNetmask)
voidsetPrefixLength(int length)Method void QNetworkAddressEntry::setPrefixLength(int length)
voidswap(QNetworkAddressEntry other)Method void QNetworkAddressEntry::swap(QNetworkAddressEntry &other)

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 QNetworkAddressEntry other)

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

==

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

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

_assign

Signature: void _assign (const QNetworkAddressEntry other)

Description: Assigns another object to self

_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: QNetworkAddressEntry assign (const QNetworkAddressEntry other)

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

broadcast

Signature: [const] QHostAddress broadcast

Description: Method QHostAddress QNetworkAddressEntry::broadcast()

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

broadcast=

Signature: void broadcast= (const QHostAddress newBroadcast)

Description: Method void QNetworkAddressEntry::setBroadcast(const QHostAddress &newBroadcast)

Python specific notes:
The object exposes a writable attribute 'broadcast'. 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 QNetworkAddressEntry ptr dup

Description: Creates a copy of self

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

ip

Signature: [const] QHostAddress ip

Description: Method QHostAddress QNetworkAddressEntry::ip()

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

ip=

Signature: void ip= (const QHostAddress newIp)

Description: Method void QNetworkAddressEntry::setIp(const QHostAddress &newIp)

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

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.

netmask

Signature: [const] QHostAddress netmask

Description: Method QHostAddress QNetworkAddressEntry::netmask()

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

netmask=

Signature: void netmask= (const QHostAddress newNetmask)

Description: Method void QNetworkAddressEntry::setNetmask(const QHostAddress &newNetmask)

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

new

(1) Signature: [static] new QNetworkAddressEntry new

Description: Constructor QNetworkAddressEntry::QNetworkAddressEntry()

This method creates an object of class QNetworkAddressEntry.

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

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

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

This method creates an object of class QNetworkAddressEntry.

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

prefixLength

Signature: [const] int prefixLength

Description: Method int QNetworkAddressEntry::prefixLength()

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

prefixLength=

Signature: void prefixLength= (int length)

Description: Method void QNetworkAddressEntry::setPrefixLength(int length)

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

setBroadcast

Signature: void setBroadcast (const QHostAddress newBroadcast)

Description: Method void QNetworkAddressEntry::setBroadcast(const QHostAddress &newBroadcast)

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

setIp

Signature: void setIp (const QHostAddress newIp)

Description: Method void QNetworkAddressEntry::setIp(const QHostAddress &newIp)

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

setNetmask

Signature: void setNetmask (const QHostAddress newNetmask)

Description: Method void QNetworkAddressEntry::setNetmask(const QHostAddress &newNetmask)

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

setPrefixLength

Signature: void setPrefixLength (int length)

Description: Method void QNetworkAddressEntry::setPrefixLength(int length)

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

swap

Signature: void swap (QNetworkAddressEntry other)

Description: Method void QNetworkAddressEntry::swap(QNetworkAddressEntry &other)