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

API reference - Class QNetworkConfiguration

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QNetworkConfiguration

Sub-classes: BearerType, QFlags_BearerType, Purpose, QFlags_Purpose, StateFlag, QFlags_StateFlag, Type, QFlags_Type

Public constructors

new QNetworkConfigurationnewConstructor QNetworkConfiguration::QNetworkConfiguration()
new QNetworkConfigurationnew(const QNetworkConfiguration other)Constructor QNetworkConfiguration::QNetworkConfiguration(const QNetworkConfiguration &other)

Public methods

[const]bool!=(const QNetworkConfiguration other)Method bool QNetworkConfiguration::operator!=(const QNetworkConfiguration &other)
[const]bool==(const QNetworkConfiguration other)Method bool QNetworkConfiguration::operator==(const QNetworkConfiguration &other)
void_assign(const QNetworkConfiguration other)Assigns another object to self
[const]QNetworkConfiguration 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.
QNetworkConfigurationassign(const QNetworkConfiguration other)Method QNetworkConfiguration &QNetworkConfiguration::operator=(const QNetworkConfiguration &other)
[const]QNetworkConfiguration_BearerTypebearerTypeMethod QNetworkConfiguration::BearerType QNetworkConfiguration::bearerType()
[const]QNetworkConfiguration_BearerTypebearerTypeFamilyMethod QNetworkConfiguration::BearerType QNetworkConfiguration::bearerTypeFamily()
[const]stringbearerTypeNameMethod QString QNetworkConfiguration::bearerTypeName()
[const]QNetworkConfiguration[]childrenMethod QList<QNetworkConfiguration> QNetworkConfiguration::children()
[const]intconnectTimeoutMethod int QNetworkConfiguration::connectTimeout()
[const]new QNetworkConfiguration ptrdupCreates a copy of self
[const]stringidentifierMethod QString QNetworkConfiguration::identifier()
[const]boolisRoamingAvailable?Method bool QNetworkConfiguration::isRoamingAvailable()
[const]boolisValid?Method bool QNetworkConfiguration::isValid()
[const]stringnameMethod QString QNetworkConfiguration::name()
[const]QNetworkConfiguration_PurposepurposeMethod QNetworkConfiguration::Purpose QNetworkConfiguration::purpose()
boolsetConnectTimeout(int timeout)Method bool QNetworkConfiguration::setConnectTimeout(int timeout)
[const]QNetworkConfiguration_QFlags_StateFlagstateMethod QFlags<QNetworkConfiguration::StateFlag> QNetworkConfiguration::state()
voidswap(QNetworkConfiguration other)Method void QNetworkConfiguration::swap(QNetworkConfiguration &other)
[const]QNetworkConfiguration_TypetypeMethod QNetworkConfiguration::Type QNetworkConfiguration::type()

Public static methods and constants

[static,const]QNetworkConfiguration_StateFlagActiveEnum constant QNetworkConfiguration::Active
[static,const]QNetworkConfiguration_BearerTypeBearer2GEnum constant QNetworkConfiguration::Bearer2G
[static,const]QNetworkConfiguration_BearerTypeBearer3GEnum constant QNetworkConfiguration::Bearer3G
[static,const]QNetworkConfiguration_BearerTypeBearer4GEnum constant QNetworkConfiguration::Bearer4G
[static,const]QNetworkConfiguration_BearerTypeBearerBluetoothEnum constant QNetworkConfiguration::BearerBluetooth
[static,const]QNetworkConfiguration_BearerTypeBearerCDMA2000Enum constant QNetworkConfiguration::BearerCDMA2000
[static,const]QNetworkConfiguration_BearerTypeBearerEVDOEnum constant QNetworkConfiguration::BearerEVDO
[static,const]QNetworkConfiguration_BearerTypeBearerEthernetEnum constant QNetworkConfiguration::BearerEthernet
[static,const]QNetworkConfiguration_BearerTypeBearerHSPAEnum constant QNetworkConfiguration::BearerHSPA
[static,const]QNetworkConfiguration_BearerTypeBearerLTEEnum constant QNetworkConfiguration::BearerLTE
[static,const]QNetworkConfiguration_BearerTypeBearerUnknownEnum constant QNetworkConfiguration::BearerUnknown
[static,const]QNetworkConfiguration_BearerTypeBearerWCDMAEnum constant QNetworkConfiguration::BearerWCDMA
[static,const]QNetworkConfiguration_BearerTypeBearerWLANEnum constant QNetworkConfiguration::BearerWLAN
[static,const]QNetworkConfiguration_BearerTypeBearerWiMAXEnum constant QNetworkConfiguration::BearerWiMAX
[static,const]QNetworkConfiguration_StateFlagDefinedEnum constant QNetworkConfiguration::Defined
[static,const]QNetworkConfiguration_StateFlagDiscoveredEnum constant QNetworkConfiguration::Discovered
[static,const]QNetworkConfiguration_TypeInternetAccessPointEnum constant QNetworkConfiguration::InternetAccessPoint
[static,const]QNetworkConfiguration_TypeInvalidEnum constant QNetworkConfiguration::Invalid
[static,const]QNetworkConfiguration_PurposePrivatePurposeEnum constant QNetworkConfiguration::PrivatePurpose
[static,const]QNetworkConfiguration_PurposePublicPurposeEnum constant QNetworkConfiguration::PublicPurpose
[static,const]QNetworkConfiguration_TypeServiceNetworkEnum constant QNetworkConfiguration::ServiceNetwork
[static,const]QNetworkConfiguration_PurposeServiceSpecificPurposeEnum constant QNetworkConfiguration::ServiceSpecificPurpose
[static,const]QNetworkConfiguration_StateFlagUndefinedEnum constant QNetworkConfiguration::Undefined
[static,const]QNetworkConfiguration_PurposeUnknownPurposeEnum constant QNetworkConfiguration::UnknownPurpose
[static,const]QNetworkConfiguration_TypeUserChoiceEnum constant QNetworkConfiguration::UserChoice

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

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

==

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

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

Active

Signature: [static,const] QNetworkConfiguration_StateFlag Active

Description: Enum constant QNetworkConfiguration::Active

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

Bearer2G

Signature: [static,const] QNetworkConfiguration_BearerType Bearer2G

Description: Enum constant QNetworkConfiguration::Bearer2G

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

Bearer3G

Signature: [static,const] QNetworkConfiguration_BearerType Bearer3G

Description: Enum constant QNetworkConfiguration::Bearer3G

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

Bearer4G

Signature: [static,const] QNetworkConfiguration_BearerType Bearer4G

Description: Enum constant QNetworkConfiguration::Bearer4G

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

BearerBluetooth

Signature: [static,const] QNetworkConfiguration_BearerType BearerBluetooth

Description: Enum constant QNetworkConfiguration::BearerBluetooth

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

BearerCDMA2000

Signature: [static,const] QNetworkConfiguration_BearerType BearerCDMA2000

Description: Enum constant QNetworkConfiguration::BearerCDMA2000

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

BearerEVDO

Signature: [static,const] QNetworkConfiguration_BearerType BearerEVDO

Description: Enum constant QNetworkConfiguration::BearerEVDO

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

BearerEthernet

Signature: [static,const] QNetworkConfiguration_BearerType BearerEthernet

Description: Enum constant QNetworkConfiguration::BearerEthernet

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

BearerHSPA

Signature: [static,const] QNetworkConfiguration_BearerType BearerHSPA

Description: Enum constant QNetworkConfiguration::BearerHSPA

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

BearerLTE

Signature: [static,const] QNetworkConfiguration_BearerType BearerLTE

Description: Enum constant QNetworkConfiguration::BearerLTE

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

BearerUnknown

Signature: [static,const] QNetworkConfiguration_BearerType BearerUnknown

Description: Enum constant QNetworkConfiguration::BearerUnknown

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

BearerWCDMA

Signature: [static,const] QNetworkConfiguration_BearerType BearerWCDMA

Description: Enum constant QNetworkConfiguration::BearerWCDMA

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

BearerWLAN

Signature: [static,const] QNetworkConfiguration_BearerType BearerWLAN

Description: Enum constant QNetworkConfiguration::BearerWLAN

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

BearerWiMAX

Signature: [static,const] QNetworkConfiguration_BearerType BearerWiMAX

Description: Enum constant QNetworkConfiguration::BearerWiMAX

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

Defined

Signature: [static,const] QNetworkConfiguration_StateFlag Defined

Description: Enum constant QNetworkConfiguration::Defined

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

Discovered

Signature: [static,const] QNetworkConfiguration_StateFlag Discovered

Description: Enum constant QNetworkConfiguration::Discovered

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

InternetAccessPoint

Signature: [static,const] QNetworkConfiguration_Type InternetAccessPoint

Description: Enum constant QNetworkConfiguration::InternetAccessPoint

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

Invalid

Signature: [static,const] QNetworkConfiguration_Type Invalid

Description: Enum constant QNetworkConfiguration::Invalid

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

PrivatePurpose

Signature: [static,const] QNetworkConfiguration_Purpose PrivatePurpose

Description: Enum constant QNetworkConfiguration::PrivatePurpose

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

PublicPurpose

Signature: [static,const] QNetworkConfiguration_Purpose PublicPurpose

Description: Enum constant QNetworkConfiguration::PublicPurpose

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

ServiceNetwork

Signature: [static,const] QNetworkConfiguration_Type ServiceNetwork

Description: Enum constant QNetworkConfiguration::ServiceNetwork

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

ServiceSpecificPurpose

Signature: [static,const] QNetworkConfiguration_Purpose ServiceSpecificPurpose

Description: Enum constant QNetworkConfiguration::ServiceSpecificPurpose

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

Undefined

Signature: [static,const] QNetworkConfiguration_StateFlag Undefined

Description: Enum constant QNetworkConfiguration::Undefined

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

UnknownPurpose

Signature: [static,const] QNetworkConfiguration_Purpose UnknownPurpose

Description: Enum constant QNetworkConfiguration::UnknownPurpose

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

UserChoice

Signature: [static,const] QNetworkConfiguration_Type UserChoice

Description: Enum constant QNetworkConfiguration::UserChoice

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

_assign

Signature: void _assign (const QNetworkConfiguration other)

Description: Assigns another object to self

_const_cast

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

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

bearerType

Signature: [const] QNetworkConfiguration_BearerType bearerType

Description: Method QNetworkConfiguration::BearerType QNetworkConfiguration::bearerType()

bearerTypeFamily

Signature: [const] QNetworkConfiguration_BearerType bearerTypeFamily

Description: Method QNetworkConfiguration::BearerType QNetworkConfiguration::bearerTypeFamily()

bearerTypeName

Signature: [const] string bearerTypeName

Description: Method QString QNetworkConfiguration::bearerTypeName()

children

Signature: [const] QNetworkConfiguration[] children

Description: Method QList<QNetworkConfiguration> QNetworkConfiguration::children()

connectTimeout

Signature: [const] int connectTimeout

Description: Method int QNetworkConfiguration::connectTimeout()

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

Description: Creates a copy of self

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

identifier

Signature: [const] string identifier

Description: Method QString QNetworkConfiguration::identifier()

isRoamingAvailable?

Signature: [const] bool isRoamingAvailable?

Description: Method bool QNetworkConfiguration::isRoamingAvailable()

isValid?

Signature: [const] bool isValid?

Description: Method bool QNetworkConfiguration::isValid()

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.

name

Signature: [const] string name

Description: Method QString QNetworkConfiguration::name()

new

(1) Signature: [static] new QNetworkConfiguration new

Description: Constructor QNetworkConfiguration::QNetworkConfiguration()

This method creates an object of class QNetworkConfiguration.

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

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

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

This method creates an object of class QNetworkConfiguration.

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

purpose

Signature: [const] QNetworkConfiguration_Purpose purpose

Description: Method QNetworkConfiguration::Purpose QNetworkConfiguration::purpose()

setConnectTimeout

Signature: bool setConnectTimeout (int timeout)

Description: Method bool QNetworkConfiguration::setConnectTimeout(int timeout)

state

Signature: [const] QNetworkConfiguration_QFlags_StateFlag state

Description: Method QFlags<QNetworkConfiguration::StateFlag> QNetworkConfiguration::state()

swap

Signature: void swap (QNetworkConfiguration other)

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

type

Signature: [const] QNetworkConfiguration_Type type

Description: Method QNetworkConfiguration::Type QNetworkConfiguration::type()