| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtNfc module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qndeffilter.h" |
| |
| #include <QtCore/QList> |
| |
| QT_BEGIN_NAMESPACE |
| |
| /*! |
| \class QNdefFilter |
| \brief The QNdefFilter class provides a filter for matching NDEF messages. |
| |
| \ingroup connectivity-nfc |
| \inmodule QtNfc |
| \since 5.2 |
| |
| The QNdefFilter encapsulates the structure of an NDEF message and is used by |
| QNearFieldManager::registerNdefMessageHandler() to match NDEF message that have a particular |
| structure. |
| |
| The following filter matches NDEF messages that contain a single smart poster record: |
| |
| \code |
| QNdefFilter filter; |
| filter.append(QNdefRecord::NfcRtd, "Sp"); |
| \endcode |
| |
| The following filter matches NDEF messages that contain a URI, a localized piece of text and an |
| optional JPEG image. The order of the records must be in the order specified: |
| |
| \code |
| QNdefFilter filter; |
| filter.setOrderMatch(true); |
| filter.appendRecord(QNdefRecord::NfcRtd, "U"); |
| filter.appendRecord<QNdefNfcTextRecord>(); |
| filter.appendRecord(QNdefRecord::Mime, "image/jpeg", 0, 1); |
| \endcode |
| */ |
| |
| /*! |
| \fn void QNdefFilter::appendRecord(unsigned int min, unsigned int max) |
| |
| Appends a record matching the template parameter to the NDEF filter. The record must occur |
| between \a min and \a max times in the NDEF message. |
| */ |
| |
| class QNdefFilterPrivate : public QSharedData |
| { |
| public: |
| QNdefFilterPrivate(); |
| |
| bool orderMatching; |
| QList<QNdefFilter::Record> filterRecords; |
| }; |
| |
| QNdefFilterPrivate::QNdefFilterPrivate() |
| : orderMatching(false) |
| { |
| } |
| |
| /*! |
| Constructs a new NDEF filter. |
| */ |
| QNdefFilter::QNdefFilter() |
| : d(new QNdefFilterPrivate) |
| { |
| } |
| |
| /*! |
| constructs a new NDEF filter that is a copy of \a other. |
| */ |
| QNdefFilter::QNdefFilter(const QNdefFilter &other) |
| : d(other.d) |
| { |
| } |
| |
| /*! |
| Destroys the NDEF filter. |
| */ |
| QNdefFilter::~QNdefFilter() |
| { |
| } |
| |
| /*! |
| Assigns \a other to this filter and returns a reference to this filter. |
| */ |
| QNdefFilter &QNdefFilter::operator=(const QNdefFilter &other) |
| { |
| if (d != other.d) |
| d = other.d; |
| |
| return *this; |
| } |
| |
| /*! |
| Clears the filter. |
| */ |
| void QNdefFilter::clear() |
| { |
| d->orderMatching = false; |
| d->filterRecords.clear(); |
| } |
| |
| /*! |
| Sets the ording requirements of the filter. If \a on is true the filter will only match if the |
| order of records in the filter matches the order of the records in the NDEF message. If \a on |
| is false the order of the records is not taken into account when matching. |
| |
| By default record order is not taken into account. |
| */ |
| void QNdefFilter::setOrderMatch(bool on) |
| { |
| d->orderMatching = on; |
| } |
| |
| /*! |
| Returns true if the filter takes NDEF record order into account when matching; otherwise |
| returns false. |
| */ |
| bool QNdefFilter::orderMatch() const |
| { |
| return d->orderMatching; |
| } |
| |
| /*! |
| Appends a record with type name format \a typeNameFormat and type \a type to the NDEF filter. |
| The record must occur between \a min and \a max times in the NDEF message. |
| */ |
| void QNdefFilter::appendRecord(QNdefRecord::TypeNameFormat typeNameFormat, const QByteArray &type, |
| unsigned int min, unsigned int max) |
| { |
| QNdefFilter::Record record; |
| |
| record.typeNameFormat = typeNameFormat; |
| record.type = type; |
| record.minimum = min; |
| record.maximum = max; |
| |
| d->filterRecords.append(record); |
| } |
| |
| /*! |
| Appends \a record to the NDEF filter. |
| */ |
| void QNdefFilter::appendRecord(const Record &record) |
| { |
| d->filterRecords.append(record); |
| } |
| |
| /*! |
| Returns the NDEF record at index \a i. |
| */ |
| QNdefFilter::Record QNdefFilter::recordAt(int i) const |
| { |
| return d->filterRecords.at(i); |
| } |
| |
| /*! |
| Returns the number of NDEF records in the filter. |
| */ |
| int QNdefFilter::recordCount() const |
| { |
| return d->filterRecords.count(); |
| } |
| |
| QT_END_NAMESPACE |