db/d87/qndefnfcsmartposterrecord_8h_source.html

// Copyright (C) 2016 - 2012 Research In Motion

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef QNDEFNFCSMARTPOSTERRECORD_H

#define QNDEFNFCSMARTPOSTERRECORD_H


#include <QtCore/QList>

#include <QtCore/QString>

#include <QtNfc/qtnfcglobal.h>

#include <QtNfc/QNdefRecord>

#include <QtNfc/qndefnfctextrecord.h>

#include <QtNfc/qndefnfcurirecord.h>


QT_FORWARD_DECLARE_CLASS(QUrl)


QT_BEGIN_NAMESPACE


class QNdefNfcSmartPosterRecordPrivate;


#define Q_DECLARE_ISRECORDTYPE_FOR_MIME_NDEF_RECORD(className) \

    QT_BEGIN_NAMESPACE \

    template<> inline bool QNdefRecord::isRecordType<className>() const\

    { \

        return (typeNameFormat() == QNdefRecord::Mime); \

    } \

    QT_END_NAMESPACE


#define Q_DECLARE_MIME_NDEF_RECORD(className, initialPayload) \

    className() : QNdefRecord(QNdefRecord::Mime, "") { setPayload(initialPayload); } \

    className(const QNdefRecord &other) : QNdefRecord(other, QNdefRecord::Mime) { }


class Q_NFC_EXPORT QNdefNfcIconRecord : public QNdefRecord

{

public:

    Q_DECLARE_MIME_NDEF_RECORD(QNdefNfcIconRecord, QByteArray(0, char(0)))


    void setData(const QByteArray &data);

    QByteArray data() const;

};


class Q_NFC_EXPORT QNdefNfcSmartPosterRecord : public QNdefRecord

{

public:

    enum Action {

        UnspecifiedAction = -1,

        DoAction = 0,

        SaveAction = 1,

        EditAction = 2

    };


    QNdefNfcSmartPosterRecord();

    QNdefNfcSmartPosterRecord(const QNdefRecord &other);

    QNdefNfcSmartPosterRecord(const QNdefNfcSmartPosterRecord &other);

    QNdefNfcSmartPosterRecord &operator=(const QNdefNfcSmartPosterRecord &other);

    ~QNdefNfcSmartPosterRecord();


    void setPayload(const QByteArray &payload);


    bool hasTitle(const QString &locale = QString()) const;

    bool hasAction() const;

    bool hasIcon(const QByteArray &mimetype = QByteArray()) const;

    bool hasSize() const;

    bool hasTypeInfo() const;


    qsizetype titleCount() const;

    QNdefNfcTextRecord titleRecord(qsizetype index) const;

    QString title(const QString &locale = QString()) const;

    QList<QNdefNfcTextRecord> titleRecords() const;


    bool addTitle(const QNdefNfcTextRecord &text);

    bool addTitle(const QString &text, const QString &locale, QNdefNfcTextRecord::Encoding encoding);

    bool removeTitle(const QNdefNfcTextRecord &text);

    bool removeTitle(const QString &locale);

    void setTitles(const QList<QNdefNfcTextRecord> &titles);


    QUrl uri() const;

    QNdefNfcUriRecord uriRecord() const;

    void setUri(const QNdefNfcUriRecord &url);

    void setUri(const QUrl &url);


    Action action() const;

    void setAction(Action act);


    qsizetype iconCount() const;

    QNdefNfcIconRecord iconRecord(qsizetype index) const;

    QByteArray icon(const QByteArray& mimetype = QByteArray()) const;


    QList<QNdefNfcIconRecord> iconRecords() const;


    void addIcon(const QNdefNfcIconRecord &icon);

    void addIcon(const QByteArray &type, const QByteArray &data);

    bool removeIcon(const QNdefNfcIconRecord &icon);

    bool removeIcon(const QByteArray &type);

    void setIcons(const QList<QNdefNfcIconRecord> &icons);


    quint32 size() const;

    void setSize(quint32 size);


    QString typeInfo() const;

    void setTypeInfo(const QString &type);


private:

    QSharedDataPointer<QNdefNfcSmartPosterRecordPrivate> d;


    void cleanup();

    void convertToPayload();


    bool addTitleInternal(const QNdefNfcTextRecord &text);

    void addIconInternal(const QNdefNfcIconRecord &icon);

};


QT_END_NAMESPACE


Q_DECLARE_ISRECORDTYPE_FOR_NDEF_RECORD(QNdefNfcSmartPosterRecord, QNdefRecord::NfcRtd, "Sp")

Q_DECLARE_ISRECORDTYPE_FOR_MIME_NDEF_RECORD(QNdefNfcIconRecord)


#endif // QNDEFNFCSMARTPOSTERRECORD_H

QByteArray
\inmodule QtCore
Definition qbytearray.h:57

QList
Definition qlist.h:74

QNdefNfcIconRecord
The QNdefNfcIconRecord class provides an NFC MIME record to hold an icon.
Definition qndefnfcsmartposterrecord.h:33

QNdefNfcIconRecord::Q_DECLARE_MIME_NDEF_RECORD
Q_DECLARE_MIME_NDEF_RECORD(QNdefNfcIconRecord, QByteArray(0, char(0))) void setData(const QByteArray &data)

QNdefNfcSmartPosterRecordPrivate
Definition qndefnfcsmartposterrecord_p.h:48

QNdefNfcSmartPosterRecord
The QNdefNfcSmartPosterRecord class provides an NFC RTD-SmartPoster.
Definition qndefnfcsmartposterrecord.h:42

QNdefNfcSmartPosterRecord::Action
Action
This enum describes the course of action that a device should take with the content.
Definition qndefnfcsmartposterrecord.h:44

QNdefNfcTextRecord
The QNdefNfcTextRecord class provides an NFC RTD-Text.
Definition qndefnfctextrecord.h:13

QNdefNfcTextRecord::Encoding
Encoding
This enum describes the text encoding standard used.
Definition qndefnfctextrecord.h:28

QNdefNfcUriRecord
The QNdefNfcUriRecord class provides an NFC RTD-URI.
Definition qndefnfcurirecord.h:15

QNdefRecord
The QNdefRecord class provides an NFC NDEF record.
Definition qndefrecord.h:16

QNdefRecord::setPayload
void setPayload(const QByteArray &payload)
Sets the payload of the NDEF record to payload.
Definition qndefrecord.cpp:276

QNdefRecord::operator=
QNdefRecord & operator=(const QNdefRecord &other)
Assigns this NDEF record to other.
Definition qndefrecord.cpp:196

QNdefRecord::NfcRtd
@ NfcRtd
Definition qndefrecord.h:20

QSharedDataPointer
\inmodule QtCore
Definition qshareddata.h:35

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:127

QUrl
\inmodule QtCore
Definition qurl.h:94

text
QString text
Definition doc_src_properties.cpp:102

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1545

QT_FORWARD_DECLARE_CLASS
QT_FORWARD_DECLARE_CLASS(QCocoaMenuItem)

void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:401

Q_DECLARE_ISRECORDTYPE_FOR_MIME_NDEF_RECORD
#define Q_DECLARE_ISRECORDTYPE_FOR_MIME_NDEF_RECORD(className)
Definition qndefnfcsmartposterrecord.h:20

Q_DECLARE_ISRECORDTYPE_FOR_NDEF_RECORD
#define Q_DECLARE_ISRECORDTYPE_FOR_NDEF_RECORD(className, typeNameFormat_, type_)
Definition qndefrecord.h:72

size
GLenum GLuint GLintptr GLsizeiptr size
[1]
Definition qopengles2ext.h:660

index
GLuint index
[2]
Definition qopengles2ext.h:331

type
GLenum type
Definition qopengles2ext.h:150

data
GLint GLsizei GLsizei GLenum GLenum GLsizei void * data
Definition qopengles2ext.h:206

quint32
unsigned int quint32
Definition qtypes.h:45

qsizetype
ptrdiff_t qsizetype
Definition qtypes.h:70

icon
QIcon icon
[15]
Definition src_corelib_global_qglobal.cpp:144

url
QUrl url("example.com")
[constructor-url-reference]
Definition src_corelib_io_qurl.cpp:19

setData
mimeData setData("text/csv", csvData)

title
QString title
[35]
Definition src_corelib_kernel_qobject.cpp:314

d
double d
Definition src_corelib_text_qlocale.cpp:9

other
QSharedPointer< T > other(t)
[5]