qbar Namespace Reference

Namespace used for QWlanManager library. More...

Classes
class	Array2D
	Use to manage a 2-dimensional array. More...
class	Barcode
	Represent a barcode entity. More...
class	Payload
	Store data of a Barcode. More...
class	PayloadQrString
	Store QrCode string data. More...
class	PayloadQrUrl
	Store QrCode URL data. More...
class	PayloadQrWifi
	Store QrCode WIFI data. More...
class	QrCode
	Represent a QrCode entity. More...
class	Renderer
	Allow to render a barcode. More...
class	RendererQrCode
	Represent a QrCode renderer. More...

Typedefs
using	MatrixData = Array2D<uint8_t>
	Contains barcode matrix data.

Enumerations
enum class	BarError { QBAR_ERR_NO_ERROR = 0 , QBAR_ERR_UNKNOWN , QBAR_ERR_ITEM_INVALID }
	List of all barcode related errors. More...
enum class	BarType { QBAR_TYPE_UNKNOWN = 0 , QBAR_TYPE_QRCODE , QBAR_TYPE_NB }
	List of all supported barcode types. More...
enum class	PayloadType { PAYLOAD_TYPE_GENERIC_STRING = 0 , PAYLOAD_TYPE_QR_URL , PAYLOAD_TYPE_QR_WIFI , PAYLOAD_TYPE_NB }
	List of all types of payload. More...
enum class	QrLevelEcc { QR_ECC_LOW = 0 , QR_ECC_MEDIUM , QR_ECC_QUARTILE , QR_ECC_HIGH }
	Qrcode level of errors correction capability (ECC). More...

Functions
QBAR_EXPORT QDebug	operator<< (QDebug debug, const Barcode &barcode)
QBAR_EXPORT QDebug	operator<< (QDebug debug, const QrCode &qrcode)
QBAR_EXPORT QDebug	operator<< (QDebug debug, const Payload &payload)
QBAR_EXPORT QDebug	operator<< (QDebug debug, const PayloadQrString &payload)
QBAR_EXPORT QDebug	operator<< (QDebug debug, const PayloadQrUrl &payload)
QBAR_EXPORT QDebug	operator<< (QDebug debug, const PayloadQrWifi &payload)
QBAR_EXPORT QString	barErrorToString (BarError idErr)
	Use to convert barcode errors to string.
QBAR_EXPORT QString	barTypeToString (BarType idType)
	Use to convert barcode types to string.
QBAR_EXPORT QString	payloadTypeToString (PayloadType idType)
	Use to convert payload types to string.
QBAR_EXPORT QString	qrLevelEccToString (QrLevelEcc idLevel)
	Use to convert QrCode level of error correction to string.
QBAR_EXPORT QVersionNumber	getLibraryVersion ()
	Used to retrieve QBarcode library version.
QBAR_EXPORT QDebug	operator<< (QDebug debug, const Renderer &renderer)
QBAR_EXPORT QDebug	operator<< (QDebug debug, const RendererQrCode &renderer)

Detailed Description

Namespace used for QWlanManager library.

See also

getLibraryVersion()

Typedef Documentation

MatrixData

using qbar::MatrixData = Array2D<uint8_t>

Contains barcode matrix data.

Allow to store matrix modules of a barcode

See also

Barcode::getMatrixData()

Enumeration Type Documentation

BarError

enum class qbar::BarError

strong

List of all barcode related errors.

See also

barErrorToString()

Enumerator
QBAR_ERR_NO_ERROR	0	No error, operation succeed
QBAR_ERR_UNKNOWN		Unknown error
QBAR_ERR_ITEM_INVALID		Operation cannot be performed due to an invalid item

BarType

enum class qbar::BarType

strong

List of all supported barcode types.

See also

barTypeToString()

Enumerator
QBAR_TYPE_UNKNOWN	0	Unknown/unsupported barcode type
QBAR_TYPE_QRCODE		QrCode type
QBAR_TYPE_NB		Number of supporter barcode types

PayloadType

enum class qbar::PayloadType

strong

List of all types of payload.

See also

payloadTypeToString()

Enumerator
PAYLOAD_TYPE_GENERIC_STRING	0	Payload containing a string
PAYLOAD_TYPE_QR_URL		Payload containing QrCode formatted URL datas
PAYLOAD_TYPE_QR_WIFI		Payload containing QrCode formatted WIFI datas
PAYLOAD_TYPE_NB		Number of supported payloads

QrLevelEcc

enum class qbar::QrLevelEcc

strong

Qrcode level of errors correction capability (ECC).

Higher levels of error correction sacrifice data capacity, but allow a larger portion of the QR code to be damaged or unreadable.

See also

qrLevelEccToString()

Enumerator
QR_ECC_LOW	0	7% of data bytes can be restored.
QR_ECC_MEDIUM		15% of data bytes can be restored.
QR_ECC_QUARTILE		25% of data bytes can be restored.
QR_ECC_HIGH		30% of data bytes can be restored.

Function Documentation

barErrorToString()

QString qbar::barErrorToString

(

BarError

idErr

)

Use to convert barcode errors to string.

Parameters

[in]

idErr

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

Returns

Returns string equivalent.

barTypeToString()

QString qbar::barTypeToString

(

BarType

idType

)

Use to convert barcode types to string.

Parameters

[in]

idType

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

Returns

Returns string equivalent.

payloadTypeToString()

QString qbar::payloadTypeToString

(

PayloadType

idType

)

Use to convert payload types to string.

Parameters

[in]

idType

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

Returns

Returns string equivalent.

qrLevelEccToString()

QString qbar::qrLevelEccToString

(

QrLevelEcc

idLevel

)

Use to convert QrCode level of error correction to string.

Parameters

[in]

idLevel

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

Returns

Returns string equivalent.

getLibraryVersion()

QVersionNumber qbar::getLibraryVersion

(

)

Used to retrieve QBarcode library version.

Returns

Returns semantic version of the library.