Class QfNearFieldReader

ClassList > QfNearFieldReader

More...

• #include <qfnearfieldreader.h>

Inherits the following classes: QObject

Public Properties

Type	Name
property bool	active
property QString	readString
property bool	targetInRange

Public Signals

Type	Name
signal void	activeChanged Emitted when the active state has changed.
signal void	readStringChanged Emitted when the last text string read from a near-field target has changed.
signal void	targetDetected (const QString & targetId) Emitted when a near-field target has been detected.
signal void	targetInRangeChanged Emitted when a near-field target is within range of the device.

Public Functions

Type	Name
	QfNearFieldReader (QObject * parent=nullptr)
bool	active () const
QString	readString () const
void	setActive (bool active)
bool	targetInRange () const
	~QfNearFieldReader ()

Public Static Functions

Type	Name
bool	isSupported ()

Detailed Description

The QfNearFieldReader class allows for the scanning of near-field targets. When text strings are present on targets, the strings will be automatically read and a signal emitted with the string values.

Public Properties Documentation

property active [1/2]

bool QfNearFieldReader::active;

---

property readString [1/2]

QString QfNearFieldReader::readString;

---

property targetInRange [1/2]

bool QfNearFieldReader::targetInRange;

---

Public Signals Documentation

signal activeChanged

Emitted when the active state has changed.

void QfNearFieldReader::activeChanged;

---

signal readStringChanged

Emitted when the last text string read from a near-field target has changed.

void QfNearFieldReader::readStringChanged;

---

signal targetDetected

Emitted when a near-field target has been detected.

void QfNearFieldReader::targetDetected;

---

signal targetInRangeChanged

Emitted when a near-field target is within range of the device.

void QfNearFieldReader::targetInRangeChanged;

---

Public Functions Documentation

function QfNearFieldReader

explicit QfNearFieldReader::QfNearFieldReader (
    QObject * parent=nullptr
) 

---

function active [2/2]

bool QfNearFieldReader::active () const

Returns whether the device is actively scanning and reading text strings from near-field targets.

---

function readString [2/2]

QString QfNearFieldReader::readString () const

Returns the last read near-field string.

---

function setActive

void QfNearFieldReader::setActive (
    bool active
) 

Sets whether the device is actively scanning and reading text strings from near-field targets.

---

function targetInRange [2/2]

bool QfNearFieldReader::targetInRange () const

Returns whether a near-field target is currently within range.

---

function ~QfNearFieldReader

QfNearFieldReader::~QfNearFieldReader () 

---

Public Static Functions Documentation

function isSupported

static bool QfNearFieldReader::isSupported () 

Returns whether the current device can read near-field targets.

---

---

The documentation for this class was generated from the following file src/core/qfnearfieldreader.h