API reference - Class QNetworkProxy

Notation used in Ruby API documentation

Description: Binding of QNetworkProxy

Sub-classes: Capability, ProxyType

Public constructors

new QNetworkProxynewConstructor QNetworkProxy::QNetworkProxy()
new QNetworkProxynew(const QNetworkProxy_ProxyType type,
string hostName = QString(),
unsigned short port = 0,
string user = QString(),
string password = QString())
Constructor QNetworkProxy::QNetworkProxy(QNetworkProxy::ProxyType type, const QString &hostName, quint16 port, const QString &user, const QString &password)
new QNetworkProxynew(const QNetworkProxy other)Constructor QNetworkProxy::QNetworkProxy(const QNetworkProxy &other)

Public methods

[const]bool!=(const QNetworkProxy other)Method bool QNetworkProxy::operator!=(const QNetworkProxy &other)
[const]bool==(const QNetworkProxy other)Method bool QNetworkProxy::operator==(const QNetworkProxy &other)
void_assign(const QNetworkProxy 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.
QNetworkProxyassign(const QNetworkProxy other)Method QNetworkProxy &QNetworkProxy::operator=(const QNetworkProxy &other)
[const]QNetworkProxy_QFlags_CapabilitycapabilitiesMethod QFlags<QNetworkProxy::Capability> QNetworkProxy::capabilities()
voidcapabilities=(const QNetworkProxy_QFlags_Capability capab)Method void QNetworkProxy::setCapabilities(QFlags<QNetworkProxy::Capability> capab)
[const]new QNetworkProxy ptrdupCreates a copy of self
[const]stringhostNameMethod QString QNetworkProxy::hostName()
voidhostName=(string hostName)Method void QNetworkProxy::setHostName(const QString &hostName)
[const]boolisCachingProxy?Method bool QNetworkProxy::isCachingProxy()
[const]boolisTransparentProxy?Method bool QNetworkProxy::isTransparentProxy()
[const]stringpasswordMethod QString QNetworkProxy::password()
voidpassword=(string password)Method void QNetworkProxy::setPassword(const QString &password)
[const]unsigned shortportMethod quint16 QNetworkProxy::port()
voidport=(unsigned short port)Method void QNetworkProxy::setPort(quint16 port)
voidsetCapabilities(const QNetworkProxy_QFlags_Capability capab)Method void QNetworkProxy::setCapabilities(QFlags<QNetworkProxy::Capability> capab)
voidsetHostName(string hostName)Method void QNetworkProxy::setHostName(const QString &hostName)
voidsetPassword(string password)Method void QNetworkProxy::setPassword(const QString &password)
voidsetPort(unsigned short port)Method void QNetworkProxy::setPort(quint16 port)
voidsetType(const QNetworkProxy_ProxyType type)Method void QNetworkProxy::setType(QNetworkProxy::ProxyType type)
voidsetUser(string userName)Method void QNetworkProxy::setUser(const QString &userName)
[const]QNetworkProxy_ProxyTypetypeMethod QNetworkProxy::ProxyType QNetworkProxy::type()
voidtype=(const QNetworkProxy_ProxyType type)Method void QNetworkProxy::setType(QNetworkProxy::ProxyType type)
[const]stringuserMethod QString QNetworkProxy::user()
voiduser=(string userName)Method void QNetworkProxy::setUser(const QString &userName)

Public static methods and constants

[static,const]new QNetworkProxy_Capability ptrCachingCapabilityEnum constant QNetworkProxy::CachingCapability
[static,const]new QNetworkProxy_ProxyType ptrDefaultProxyEnum constant QNetworkProxy::DefaultProxy
[static,const]new QNetworkProxy_ProxyType ptrFtpCachingProxyEnum constant QNetworkProxy::FtpCachingProxy
[static,const]new QNetworkProxy_Capability ptrHostNameLookupCapabilityEnum constant QNetworkProxy::HostNameLookupCapability
[static,const]new QNetworkProxy_ProxyType ptrHttpCachingProxyEnum constant QNetworkProxy::HttpCachingProxy
[static,const]new QNetworkProxy_ProxyType ptrHttpProxyEnum constant QNetworkProxy::HttpProxy
[static,const]new QNetworkProxy_Capability ptrListeningCapabilityEnum constant QNetworkProxy::ListeningCapability
[static,const]new QNetworkProxy_ProxyType ptrNoProxyEnum constant QNetworkProxy::NoProxy
[static,const]new QNetworkProxy_ProxyType ptrSocks5ProxyEnum constant QNetworkProxy::Socks5Proxy
[static,const]new QNetworkProxy_Capability ptrTunnelingCapabilityEnum constant QNetworkProxy::TunnelingCapability
[static,const]new QNetworkProxy_Capability ptrUdpTunnelingCapabilityEnum constant QNetworkProxy::UdpTunnelingCapability
QNetworkProxyapplicationProxyStatic method QNetworkProxy QNetworkProxy::applicationProxy()
voidapplicationProxy=(const QNetworkProxy proxy)Static method void QNetworkProxy::setApplicationProxy(const QNetworkProxy &proxy)
voidsetApplicationProxy(const QNetworkProxy proxy)Static method void QNetworkProxy::setApplicationProxy(const QNetworkProxy &proxy)

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

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

[const] bool ==(const QNetworkProxy other)

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

[static,const] new QNetworkProxy_Capability ptr CachingCapability

Description: Enum constant QNetworkProxy::CachingCapability

[static,const] new QNetworkProxy_ProxyType ptr DefaultProxy

Description: Enum constant QNetworkProxy::DefaultProxy

[static,const] new QNetworkProxy_ProxyType ptr FtpCachingProxy

Description: Enum constant QNetworkProxy::FtpCachingProxy

[static,const] new QNetworkProxy_Capability ptr HostNameLookupCapability

Description: Enum constant QNetworkProxy::HostNameLookupCapability

[static,const] new QNetworkProxy_ProxyType ptr HttpCachingProxy

Description: Enum constant QNetworkProxy::HttpCachingProxy

[static,const] new QNetworkProxy_ProxyType ptr HttpProxy

Description: Enum constant QNetworkProxy::HttpProxy

[static,const] new QNetworkProxy_Capability ptr ListeningCapability

Description: Enum constant QNetworkProxy::ListeningCapability

[static,const] new QNetworkProxy_ProxyType ptr NoProxy

Description: Enum constant QNetworkProxy::NoProxy

[static,const] new QNetworkProxy_ProxyType ptr Socks5Proxy

Description: Enum constant QNetworkProxy::Socks5Proxy

[static,const] new QNetworkProxy_Capability ptr TunnelingCapability

Description: Enum constant QNetworkProxy::TunnelingCapability

[static,const] new QNetworkProxy_Capability ptr UdpTunnelingCapability

Description: Enum constant QNetworkProxy::UdpTunnelingCapability

void _assign(const QNetworkProxy 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.

[static] QNetworkProxy applicationProxy

Description: Static method QNetworkProxy QNetworkProxy::applicationProxy()

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

Python specific notes:

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

[static] void applicationProxy=(const QNetworkProxy proxy)

Description: Static method void QNetworkProxy::setApplicationProxy(const QNetworkProxy &proxy)

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

Python specific notes:

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

QNetworkProxy assign(const QNetworkProxy other)

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

[const] QNetworkProxy_QFlags_Capability capabilities

Description: Method QFlags<QNetworkProxy::Capability> QNetworkProxy::capabilities()

Python specific notes:

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

void capabilities=(const QNetworkProxy_QFlags_Capability capab)

Description: Method void QNetworkProxy::setCapabilities(QFlags<QNetworkProxy::Capability> capab)

Python specific notes:

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

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

Description: Creates a copy of self

[const] string hostName

Description: Method QString QNetworkProxy::hostName()

Python specific notes:

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

void hostName=(string hostName)

Description: Method void QNetworkProxy::setHostName(const QString &hostName)

Python specific notes:

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

[const] bool isCachingProxy?

Description: Method bool QNetworkProxy::isCachingProxy()

[const] bool isTransparentProxy?

Description: Method bool QNetworkProxy::isTransparentProxy()

[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 QNetworkProxy new

Description: Constructor QNetworkProxy::QNetworkProxy()

This method creates an object of class QNetworkProxy.

Python specific notes:

This method is the default initializer of the object

[static] new QNetworkProxy new(const QNetworkProxy_ProxyType type,string hostName = QString(),unsigned short port = 0,string user = QString(),string password = QString())

Description: Constructor QNetworkProxy::QNetworkProxy(QNetworkProxy::ProxyType type, const QString &hostName, quint16 port, const QString &user, const QString &password)

This method creates an object of class QNetworkProxy.

Python specific notes:

This method is the default initializer of the object

[static] new QNetworkProxy new(const QNetworkProxy other)

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

This method creates an object of class QNetworkProxy.

Python specific notes:

This method is the default initializer of the object

[const] string password

Description: Method QString QNetworkProxy::password()

Python specific notes:

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

void password=(string password)

Description: Method void QNetworkProxy::setPassword(const QString &password)

Python specific notes:

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

[const] unsigned short port

Description: Method quint16 QNetworkProxy::port()

Python specific notes:

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

void port=(unsigned short port)

Description: Method void QNetworkProxy::setPort(quint16 port)

Python specific notes:

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

[static] void setApplicationProxy(const QNetworkProxy proxy)

Description: Static method void QNetworkProxy::setApplicationProxy(const QNetworkProxy &proxy)

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

Python specific notes:

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

void setCapabilities(const QNetworkProxy_QFlags_Capability capab)

Description: Method void QNetworkProxy::setCapabilities(QFlags<QNetworkProxy::Capability> capab)

Python specific notes:

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

void setHostName(string hostName)

Description: Method void QNetworkProxy::setHostName(const QString &hostName)

Python specific notes:

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

void setPassword(string password)

Description: Method void QNetworkProxy::setPassword(const QString &password)

Python specific notes:

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

void setPort(unsigned short port)

Description: Method void QNetworkProxy::setPort(quint16 port)

Python specific notes:

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

void setType(const QNetworkProxy_ProxyType type)

Description: Method void QNetworkProxy::setType(QNetworkProxy::ProxyType type)

Python specific notes:

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

void setUser(string userName)

Description: Method void QNetworkProxy::setUser(const QString &userName)

Python specific notes:

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

[const] QNetworkProxy_ProxyType type

Description: Method QNetworkProxy::ProxyType QNetworkProxy::type()

Python specific notes:

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

void type=(const QNetworkProxy_ProxyType type)

Description: Method void QNetworkProxy::setType(QNetworkProxy::ProxyType type)

Python specific notes:

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

[const] string user

Description: Method QString QNetworkProxy::user()

Python specific notes:

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

void user=(string userName)

Description: Method void QNetworkProxy::setUser(const QString &userName)

Python specific notes:

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