API reference - Class QNetworkProxy

!=

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

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

==

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

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

CachingCapability

Signature: [static,const] QNetworkProxy_Capability CachingCapability

Description: Enum constant QNetworkProxy::CachingCapability

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

DefaultProxy

Signature: [static,const] QNetworkProxy_ProxyType DefaultProxy

Description: Enum constant QNetworkProxy::DefaultProxy

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

FtpCachingProxy

Signature: [static,const] QNetworkProxy_ProxyType FtpCachingProxy

Description: Enum constant QNetworkProxy::FtpCachingProxy

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

HostNameLookupCapability

Signature: [static,const] QNetworkProxy_Capability HostNameLookupCapability

Description: Enum constant QNetworkProxy::HostNameLookupCapability

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

HttpCachingProxy

Signature: [static,const] QNetworkProxy_ProxyType HttpCachingProxy

Description: Enum constant QNetworkProxy::HttpCachingProxy

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

HttpProxy

Signature: [static,const] QNetworkProxy_ProxyType HttpProxy

Description: Enum constant QNetworkProxy::HttpProxy

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

ListeningCapability

Signature: [static,const] QNetworkProxy_Capability ListeningCapability

Description: Enum constant QNetworkProxy::ListeningCapability

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

NoProxy

Signature: [static,const] QNetworkProxy_ProxyType NoProxy

Description: Enum constant QNetworkProxy::NoProxy

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

SctpListeningCapability

Signature: [static,const] QNetworkProxy_Capability SctpListeningCapability

Description: Enum constant QNetworkProxy::SctpListeningCapability

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

SctpTunnelingCapability

Signature: [static,const] QNetworkProxy_Capability SctpTunnelingCapability

Description: Enum constant QNetworkProxy::SctpTunnelingCapability

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

Socks5Proxy

Signature: [static,const] QNetworkProxy_ProxyType Socks5Proxy

Description: Enum constant QNetworkProxy::Socks5Proxy

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

TunnelingCapability

Signature: [static,const] QNetworkProxy_Capability TunnelingCapability

Description: Enum constant QNetworkProxy::TunnelingCapability

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

UdpTunnelingCapability

Signature: [static,const] QNetworkProxy_Capability UdpTunnelingCapability

Description: Enum constant QNetworkProxy::UdpTunnelingCapability

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

_assign

Signature: void _assign (const QNetworkProxy other)

Description: Assigns another object to self

_const_cast

Signature: [const] QNetworkProxy 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.

applicationProxy

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

applicationProxy=

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

assign

Signature: QNetworkProxy assign (const QNetworkProxy other)

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

capabilities

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

capabilities=

Signature: void capabilities= (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.

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

Description: Creates a copy of self

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

hasRawHeader

Signature: [const] bool hasRawHeader (bytes headerName)

Description: Method bool QNetworkProxy::hasRawHeader(const QByteArray &headerName)

header

Signature: [const] variant header (const QNetworkRequest_KnownHeaders header)

Description: Method QVariant QNetworkProxy::header(QNetworkRequest::KnownHeaders header)

hostName

Signature: [const] string hostName

Description: Method QString QNetworkProxy::hostName()

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

hostName=

Signature: 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.

isCachingProxy?

Signature: [const] bool isCachingProxy?

Description: Method bool QNetworkProxy::isCachingProxy()

isTransparentProxy?

Signature: [const] bool isTransparentProxy?

Description: Method bool QNetworkProxy::isTransparentProxy()

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.

new

(1) Signature: [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.

(2) Signature: [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.

(3) Signature: [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.

password

Signature: [const] string password

Description: Method QString QNetworkProxy::password()

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

password=

Signature: 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.

port

Signature: [const] unsigned short port

Description: Method quint16 QNetworkProxy::port()

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

port=

Signature: 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.

rawHeader

Signature: [const] bytes rawHeader (bytes headerName)

Description: Method QByteArray QNetworkProxy::rawHeader(const QByteArray &headerName)

rawHeaderList

Signature: [const] bytes[] rawHeaderList

Description: Method QList<QByteArray> QNetworkProxy::rawHeaderList()

setApplicationProxy

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

setCapabilities

Signature: void setCapabilities (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.

setHeader

Signature: void setHeader (const QNetworkRequest_KnownHeaders header, variant value)

Description: Method void QNetworkProxy::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

setHostName

Signature: 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.

setPassword

Signature: 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.

setPort

Signature: 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.

setRawHeader

Signature: void setRawHeader (bytes headerName, bytes value)

Description: Method void QNetworkProxy::setRawHeader(const QByteArray &headerName, const QByteArray &value)

setType

Signature: 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.

setUser

Signature: 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.

swap

Signature: void swap (QNetworkProxy other)

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

type

Signature: [const] QNetworkProxy_ProxyType type

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

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

type=

Signature: 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.

user

Signature: [const] string user

Description: Method QString QNetworkProxy::user()

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

user=

Signature: 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.