Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QNdefMessage Class Reference

The QNdefMessage class provides an NFC NDEF message. More...

#include <qndefmessage.h>

Inheritance diagram for QNdefMessage:
Collaboration diagram for QNdefMessage:

Public Member Functions

Q_NFC_EXPORT_COMPAT QNdefMessage ()=default
 Constructs a new empty NDEF message.
Q_NFC_EXPORT_COMPAT QNdefMessage (const QNdefRecord &record)
 Constructs a new NDEF message containing a single record record.
Q_NFC_EXPORT_COMPAT QNdefMessage (const QNdefMessage &message)=default
 Constructs a new NDEF message that is a copy of message.
Q_NFC_EXPORT_COMPAT QNdefMessage (const QList< QNdefRecord > &records)
 Constructs a new NDEF message that contains all of the records in records.
Q_NFC_EXPORT_COMPAT QNdefMessage & operator= (const QNdefMessage &other)=default
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Q_NFC_EXPORT_COMPAT QNdefMessage & operator= (QNdefMessage &&other) noexcept=default
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Q_NFC_EXPORT bool operator== (const QNdefMessage &other) const
 Returns true if this NDEF message is equivalent to other; otherwise returns false.
Q_NFC_EXPORT QByteArray toByteArray () const
 Returns the NDEF message as a byte array.
Public Member Functions inherited from QList< QNdefRecord >
DataPointer & data_ptr () &
 QList (DataPointer dd) noexcept
QList< QNdefRecord > & operator= (std::initializer_list< QNdefRecord > args)
void swap (QList &other) noexcept
QTypeTraits::compare_eq_result_container< QList, U > operator== (const QList &other) const
QTypeTraits::compare_eq_result_container< QList, U > operator!= (const QList &other) const
QTypeTraits::compare_lt_result_container< QList, U > operator< (const QList &other) const noexcept(noexcept(std::lexicographical_compare< typename QList< U >::const_iterator, typename QList::const_iterator >(std::declval< QList< U > >().begin(), std::declval< QList< U > >().end(), other.begin(), other.end())))
QTypeTraits::compare_lt_result_container< QList, U > operator> (const QList &other) const noexcept(noexcept(other< std::declval< QList< U > >()))
QTypeTraits::compare_lt_result_container< QList, U > operator<= (const QList &other) const noexcept(noexcept(other< std::declval< QList< U > >()))
QTypeTraits::compare_lt_result_container< QList, U > operator>= (const QList &other) const noexcept(noexcept(std::declval< QList< U > >()< other))
constexpr qsizetype size () const noexcept
constexpr qsizetype count () const noexcept
constexpr qsizetype length () const noexcept
constexpr bool isEmpty () const noexcept
void resize (qsizetype size)
void resizeForOverwrite (qsizetype size)
qsizetype capacity () const
void reserve (qsizetype size)
void squeeze ()
void detach ()
bool isDetached () const noexcept
bool isSharedWith (const QList< QNdefRecord > &other) const
pointer data ()
const_pointer constData () const noexcept
void clear ()
const_reference at (qsizetype i) const noexcept
reference operator[] (qsizetype i)
void append (parameter_type t)
void prepend (rvalue_ref t)
reference emplaceBack (Args &&... args)
reference emplaceFront (Args &&... args)
iterator insert (qsizetype i, parameter_type t)
QList & assign (qsizetype n, parameter_type t)
iterator emplace (const_iterator before, Args &&... args)
void replace (qsizetype i, parameter_type t)
void remove (qsizetype i, qsizetype n=1)
void removeFirst () noexcept
void removeLast () noexcept
value_type takeFirst ()
value_type takeLast ()
QList< QNdefRecord > & fill (parameter_type t, qsizetype size=-1)
void removeAt (qsizetype i)
qsizetype removeAll (const AT &t)
bool removeOne (const AT &t)
qsizetype removeIf (Predicate pred)
QNdefRecord takeAt (qsizetype i)
void move (qsizetype from, qsizetype to)
iterator begin ()
iterator end ()
const_iterator cbegin () const noexcept
const_iterator cend () const noexcept
const_iterator constBegin () const noexcept
const_iterator constEnd () const noexcept
reverse_iterator rbegin ()
reverse_iterator rend ()
const_reverse_iterator crbegin () const noexcept
const_reverse_iterator crend () const noexcept
iterator erase (const_iterator begin, const_iterator end)
QNdefRecord & first ()
const QNdefRecord & constFirst () const noexcept
QNdefRecord & last ()
const QNdefRecord & constLast () const noexcept
bool startsWith (parameter_type t) const
bool endsWith (parameter_type t) const
QList< QNdefRecord > mid (qsizetype pos, qsizetype len=-1) const
QList< QNdefRecord > sliced (qsizetype pos) const
QNdefRecord value (qsizetype i) const
void swapItemsAt (qsizetype i, qsizetype j)
void push_back (parameter_type t)
void push_front (rvalue_ref t)
void pop_back () noexcept
void pop_front () noexcept
reference emplace_back (Args &&... args)
bool empty () const noexcept
reference front ()
reference back ()
void shrink_to_fit ()
constexpr qsizetype max_size () const noexcept
QList< QNdefRecord > & operator+= (const QList< QNdefRecord > &l)
QList< QNdefRecord > operator+ (const QList< QNdefRecord > &l) const &
QList< QNdefRecord > & operator<< (parameter_type t)
QList< QNdefRecord > toList () const noexcept
QList< QNdefRecord > toVector () const noexcept
Public Member Functions inherited from QListSpecialMethodsBase< QNdefRecord >
qsizetype indexOf (const AT &t, qsizetype from=0) const noexcept
qsizetype lastIndexOf (const AT &t, qsizetype from=-1) const noexcept
bool contains (const AT &t) const noexcept

Static Public Member Functions

static Q_NFC_EXPORT QNdefMessage fromByteArray (const QByteArray &message)
 Returns an NDEF message parsed from the contents of message.
Static Public Member Functions inherited from QList< QNdefRecord >
static constexpr qsizetype maxSize ()
static QList< QNdefRecord > fromList (const QList< QNdefRecord > &list) noexcept
static QList< QNdefRecord > fromVector (const QList< QNdefRecord > &vector) noexcept
static QList< QNdefRecord > fromReadOnlyData (const QNdefRecord(&t)[N]) noexcept

Additional Inherited Members

Public Types inherited from QList< QNdefRecord >
using Type
using value_type
using pointer
using const_pointer
using reference
using const_reference
using size_type
using difference_type
using parameter_type
using rvalue_ref
using Iterator
using ConstIterator
using reverse_iterator
using const_reverse_iterator
Protected Types inherited from QListSpecialMethodsBase< QNdefRecord >
using Self
Protected Member Functions inherited from QListSpecialMethods< QNdefRecord >
 QListSpecialMethods ()=default
Protected Member Functions inherited from QListSpecialMethodsBase< QNdefRecord >
 QListSpecialMethodsBase ()=default
Self * self ()

Detailed Description

The QNdefMessage class provides an NFC NDEF message.

\inmodule QtNfc

Since
Qt 5.2

A QNdefMessage is a collection of 0 or more QNdefRecords. QNdefMessage inherits from QList<QNdefRecord> and therefore the standard QList functions can be used to manipulate the NDEF records in the message.

NDEF messages can be parsed from a byte array conforming to the NFC Data Exchange Format technical specification by using the fromByteArray() static function. Conversely QNdefMessages can be converted into a byte array with the toByteArray() function.

Definition at line 22 of file qndefmessage.h.

Constructor & Destructor Documentation

◆ QNdefMessage() [1/4]

Q_NFC_EXPORT_COMPAT QNdefMessage::QNdefMessage ( )
default

Constructs a new empty NDEF message.

◆ QNdefMessage() [2/4]

Q_NFC_EXPORT_COMPAT QNdefMessage::QNdefMessage ( const QNdefRecord & record)
inlineexplicit

Constructs a new NDEF message containing a single record record.

Definition at line 28 of file qndefmessage.h.

◆ QNdefMessage() [3/4]

Q_NFC_EXPORT_COMPAT QNdefMessage::QNdefMessage ( const QNdefMessage & message)
default

Constructs a new NDEF message that is a copy of message.

◆ QNdefMessage() [4/4]

Q_NFC_EXPORT_COMPAT QNdefMessage::QNdefMessage ( const QList< QNdefRecord > & records)
inline

Constructs a new NDEF message that contains all of the records in records.

Definition at line 32 of file qndefmessage.h.

Member Function Documentation

◆ fromByteArray()

QNdefMessage QNdefMessage::fromByteArray ( const QByteArray & message)
static

Returns an NDEF message parsed from the contents of message.

The message parameter is interpreted as the raw message format defined in the NFC Data Exchange Format technical specification.

If a parse error occurs an empty NDEF message is returned.

Definition at line 61 of file qndefmessage.cpp.

◆ operator=() [1/2]

Q_NFC_EXPORT_COMPAT QNdefMessage & QNdefMessage::operator= ( const QNdefMessage & other)
default

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since
6.2

Copy assignment operator from QList<QNdefRecord>. Assigns the other list of NDEF records to this NDEF record list.

After the operation, other and *this will be equal.

◆ operator=() [2/2]

Q_NFC_EXPORT_COMPAT QNdefMessage & QNdefMessage::operator= ( QNdefMessage && other)
defaultnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since
6.2

Move assignment operator from QList<QNdefRecord>. Moves the other list of NDEF records to this NDEF record list.

After the operation, other will be empty.

◆ operator==()

bool QNdefMessage::operator== ( const QNdefMessage & other) const

Returns true if this NDEF message is equivalent to other; otherwise returns false.

An empty message (i.e. isEmpty() returns true) is equivalent to a NDEF message containing a single record of type \l QNdefRecord::Empty.

Definition at line 242 of file qndefmessage.cpp.

◆ toByteArray()

QByteArray QNdefMessage::toByteArray ( ) const

Returns the NDEF message as a byte array.

The return value of this function conforms to the format defined in the NFC Data Exchange Format technical specification.

Definition at line 271 of file qndefmessage.cpp.

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