API reference - Class QHostAddress

Notation used in Ruby API documentation

Description: Binding of QHostAddress

Sub-classes: SpecialAddress

Public constructors

new QHostAddressnewConstructor QHostAddress::QHostAddress()
new QHostAddressnew(string address)Constructor QHostAddress::QHostAddress(const QString &address)
new QHostAddressnew(const QHostAddress copy)Constructor QHostAddress::QHostAddress(const QHostAddress &copy)

Public methods

[const]bool!=(const QHostAddress address)Method bool QHostAddress::operator !=(const QHostAddress &address)
[const]bool!=(const QHostAddress_SpecialAddress address)Method bool QHostAddress::operator !=(QHostAddress::SpecialAddress address)
[const]bool==(const QHostAddress address)Method bool QHostAddress::operator ==(const QHostAddress &address)
[const]bool==(const QHostAddress_SpecialAddress address)Method bool QHostAddress::operator ==(QHostAddress::SpecialAddress address)
void_assign(const QHostAddress 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.
QHostAddressassign(const QHostAddress other)Method QHostAddress &QHostAddress::operator=(const QHostAddress &other)
QHostAddressassign(string address)Method QHostAddress &QHostAddress::operator=(const QString &address)
voidclearMethod void QHostAddress::clear()
[const]new QHostAddress ptrdupCreates a copy of self
[const]boolisInSubnet?(const QHostAddress subnet,
int netmask)
Method bool QHostAddress::isInSubnet(const QHostAddress &subnet, int netmask)
[const]boolisInSubnet?(const QHostAddressIntPair subnet)Method bool QHostAddress::isInSubnet(const QPair<QHostAddress, int> &subnet)
[const]boolisNull?Method bool QHostAddress::isNull()
[const]QAbstractSocket_NetworkLayerProtocolprotocolMethod QAbstractSocket::NetworkLayerProtocol QHostAddress::protocol()
[const]stringscopeIdMethod QString QHostAddress::scopeId()
voidscopeId=(string id)Method void QHostAddress::setScopeId(const QString &id)
voidsetAddress(unsigned int ip4Addr)Method void QHostAddress::setAddress(quint32 ip4Addr)
boolsetAddress(string address)Method bool QHostAddress::setAddress(const QString &address)
voidsetScopeId(string id)Method void QHostAddress::setScopeId(const QString &id)
[const]unsigned inttoIPv4AddressMethod quint32 QHostAddress::toIPv4Address()
[const]stringtoStringMethod QString QHostAddress::toString()
[const]stringto_sMethod QString QHostAddress::toString()

Public static methods and constants

[static,const]new QHostAddress_SpecialAddress ptrAnyEnum constant QHostAddress::Any
[static,const]new QHostAddress_SpecialAddress ptrAnyIPv6Enum constant QHostAddress::AnyIPv6
[static,const]new QHostAddress_SpecialAddress ptrBroadcastEnum constant QHostAddress::Broadcast
[static,const]new QHostAddress_SpecialAddress ptrLocalHostEnum constant QHostAddress::LocalHost
[static,const]new QHostAddress_SpecialAddress ptrLocalHostIPv6Enum constant QHostAddress::LocalHostIPv6
[static,const]new QHostAddress_SpecialAddress ptrNullEnum constant QHostAddress::Null
new QHostAddressnew_ip4(unsigned int ip4Addr)Constructor QHostAddress::QHostAddress(quint32 ip4Addr)
new QHostAddressnew_special(const QHostAddress_SpecialAddress address)Constructor QHostAddress::QHostAddress(QHostAddress::SpecialAddress address)
QHostAddressIntPairparseSubnet(string subnet)Static method QPair<QHostAddress, int> QHostAddress::parseSubnet(const QString &subnet)

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

[const] bool !=(const QHostAddress address)

Description: Method bool QHostAddress::operator !=(const QHostAddress &address)

[const] bool !=(const QHostAddress_SpecialAddress address)

Description: Method bool QHostAddress::operator !=(QHostAddress::SpecialAddress address)

[const] bool ==(const QHostAddress address)

Description: Method bool QHostAddress::operator ==(const QHostAddress &address)

[const] bool ==(const QHostAddress_SpecialAddress address)

Description: Method bool QHostAddress::operator ==(QHostAddress::SpecialAddress address)

[static,const] new QHostAddress_SpecialAddress ptr Any

Description: Enum constant QHostAddress::Any

[static,const] new QHostAddress_SpecialAddress ptr AnyIPv6

Description: Enum constant QHostAddress::AnyIPv6

[static,const] new QHostAddress_SpecialAddress ptr Broadcast

Description: Enum constant QHostAddress::Broadcast

[static,const] new QHostAddress_SpecialAddress ptr LocalHost

Description: Enum constant QHostAddress::LocalHost

[static,const] new QHostAddress_SpecialAddress ptr LocalHostIPv6

Description: Enum constant QHostAddress::LocalHostIPv6

[static,const] new QHostAddress_SpecialAddress ptr Null

Description: Enum constant QHostAddress::Null

void _assign(const QHostAddress other)

Description: Assigns another object to self

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.

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.

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

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

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.

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.

QHostAddress assign(const QHostAddress other)

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

QHostAddress assign(string address)

Description: Method QHostAddress &QHostAddress::operator=(const QString &address)

void clear

Description: Method void QHostAddress::clear()

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new QHostAddress ptr dup

Description: Creates a copy of self

[const] bool isInSubnet?(const QHostAddress subnet,int netmask)

Description: Method bool QHostAddress::isInSubnet(const QHostAddress &subnet, int netmask)

[const] bool isInSubnet?(const QHostAddressIntPair subnet)

Description: Method bool QHostAddress::isInSubnet(const QPair<QHostAddress, int> &subnet)

[const] bool isNull?

Description: Method bool QHostAddress::isNull()

[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

[static] new QHostAddress new

Description: Constructor QHostAddress::QHostAddress()

This method creates an object of class QHostAddress.

Python specific notes:

This method is the default initializer of the object

[static] new QHostAddress new(string address)

Description: Constructor QHostAddress::QHostAddress(const QString &address)

This method creates an object of class QHostAddress.

Python specific notes:

This method is the default initializer of the object

[static] new QHostAddress new(const QHostAddress copy)

Description: Constructor QHostAddress::QHostAddress(const QHostAddress &copy)

This method creates an object of class QHostAddress.

Python specific notes:

This method is the default initializer of the object

[static] new QHostAddress new_ip4(unsigned int ip4Addr)

Description: Constructor QHostAddress::QHostAddress(quint32 ip4Addr)

This method creates an object of class QHostAddress.

[static] new QHostAddress new_special(const QHostAddress_SpecialAddress address)

Description: Constructor QHostAddress::QHostAddress(QHostAddress::SpecialAddress address)

This method creates an object of class QHostAddress.

[static] QHostAddressIntPair parseSubnet(string subnet)

Description: Static method QPair<QHostAddress, int> QHostAddress::parseSubnet(const QString &subnet)

This method is static and can be called without an instance.

[const] QAbstractSocket_NetworkLayerProtocol protocol

Description: Method QAbstractSocket::NetworkLayerProtocol QHostAddress::protocol()

[const] string scopeId

Description: Method QString QHostAddress::scopeId()

Python specific notes:

The object exposes a readable attribute 'scopeId'. This is the getter.

void scopeId=(string id)

Description: Method void QHostAddress::setScopeId(const QString &id)

Python specific notes:

The object exposes a writable attribute 'scopeId'. This is the setter.

void setAddress(unsigned int ip4Addr)

Description: Method void QHostAddress::setAddress(quint32 ip4Addr)

bool setAddress(string address)

Description: Method bool QHostAddress::setAddress(const QString &address)

void setScopeId(string id)

Description: Method void QHostAddress::setScopeId(const QString &id)

Python specific notes:

The object exposes a writable attribute 'scopeId'. This is the setter.

[const] unsigned int toIPv4Address

Description: Method quint32 QHostAddress::toIPv4Address()

[const] string toString

Description: Method QString QHostAddress::toString()

Python specific notes:

This method is also available as 'str(object)'

[const] string to_s

Description: Method QString QHostAddress::toString()

Python specific notes:

This method is also available as 'str(object)'