qbar::PayloadQrWifi Class Reference

Store QrCode WIFI data. More...

Inheritance diagram for qbar::PayloadQrWifi:

Collaboration diagram for qbar::PayloadQrWifi:

Public Types
enum class	SecurityType { NO_SECURITY = 0 , WEP , WPA , NB_SECURITY_TYPE }

Public Member Functions
	Q_ENUM (SecurityType)
	PayloadQrWifi ()
	Create an empty wifi payload.
	PayloadQrWifi (const PayloadQrWifi &other)
PayloadQrWifi &	operator= (const PayloadQrWifi &other)
	PayloadQrWifi (PayloadQrWifi &&other) noexcept
PayloadQrWifi &	operator= (PayloadQrWifi &&) noexcept
SecurityType	getSecurityType () const
	Retrieve security type.
QString	getSsid () const
	Retrieve SSID.
QString	getPassword () const
	Retrieve password.
bool	isHidden () const
	Do current wifi network payload is set as an hidden network.
void	setSecurityType (SecurityType idSecurity)
	Set security type.
void	setSsid (const QString &ssid)
	Set SSID.
void	setPassword (const QString &passwd)
	Set password.
void	setIsHidden (bool isHidden)
	Set network hidden status.
Public Member Functions inherited from qbar::Payload
	Payload (const Payload &other)
Payload &	operator= (const Payload &other)
	Payload (Payload &&other) noexcept
Payload &	operator= (Payload &&) noexcept
bool	isValid () const
	Allow to verify if a payload is valid.
PayloadType	getType () const
	Get payload type.
QByteArray	getData () const
	Retrieve encoded data as bytes array.
QString	getString () const
	Retrieve encoded data as string.
BarError	getLastError () const
	Retrieve last error.
void	clear ()
	Clear payload content.

Static Public Member Functions
static QString	securityTypeToString (SecurityType idSecurity)
	Use to convert security type to string.

Detailed Description

Store QrCode WIFI data.

Allow to easily set wifi datas of a QrCode.
All will be taking care :

• Escaping special characters
• Encoding to UTF-8
• Manage fields of each security type

For reference, QrCode wifi data formatting is based on this format:

• https://github.com/zxing/zxing/wiki/Barcode-Contents#wi-fi-network-config-android-ios-11

Constructor & Destructor Documentation

PayloadQrWifi()

qbar::PayloadQrWifi::PayloadQrWifi

(

)

Create an empty wifi payload.

See also

isValid()

setSecurityType(), setSsid(), setPassword(), setIsHidden()

Member Function Documentation

getSecurityType()

PayloadQrWifi::SecurityType qbar::PayloadQrWifi::getSecurityType

(

)

const

Retrieve security type.

Returns

Returns current security type of wifi payload.

See also

setSecurityType()

getSsid()

QString qbar::PayloadQrWifi::getSsid

(

)

const

Retrieve SSID.

Returns

Returns current SSID of wifi payload.

See also

setSsid()

getPassword(), setPassword()

getPassword()

QString qbar::PayloadQrWifi::getPassword

(

)

const

Retrieve password.

Returns

Returns current password of wifi payload.

See also

setPassword()

getSsid(), setSsid()

isHidden()

bool qbar::PayloadQrWifi::isHidden

(

)

const

Do current wifi network payload is set as an hidden network.

Returns

Returns \true if network payload is hidden.

See also

setIsHidden()

setSecurityType()

void qbar::PayloadQrWifi::setSecurityType

(

SecurityType

idSecurity

)

Set security type.

Parameters

[in]

idSecurity

Security ID to use.

See also

getSecurityType()

setSsid()

void qbar::PayloadQrWifi::setSsid

(

const QString &

ssid

)

Set SSID.

Parameters

[in]

ssid

SSID to use.

See also

getSsid()

setPassword(), getPassword()

setPassword()

void qbar::PayloadQrWifi::setPassword

(

const QString &

passwd

)

Set password.

Parameters

[in]

passwd

Password to use.

See also

getPassword()

setSsid(), getSsid()

setIsHidden()

void qbar::PayloadQrWifi::setIsHidden

(

bool

isHidden

)

Set network hidden status.

Parameters

[in]

isHidden

Set to true if network is hidden.

See also

isHidden()

securityTypeToString()

QString qbar::PayloadQrWifi::securityTypeToString ( SecurityType idSecurity )

static

Use to convert security type to string.

Parameters

[in]

idSecurity

Security ID to convert. If unknown, string "unknown" will be returned.

Returns

Returns string equivalent.

---

The documentation for this class was generated from the following files:

• include/qbarcode/payloads/payloadqrwifi.h
• src/payloads/payloadqrwifi.cpp