Spec-Zone.ru › Qt

Класс QVariant

Класс QVariant действует как объединение для наиболее распространённых типов данных Qt. Подробнее...

Заголовок: #include <QVariant>
CMake: find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
  • Список всех членов, включая унаследованные
  • Устаревшие члены

Открытые функции

QVariant(QVariant &&other)
QVariant(const QPersistentModelIndex &val)
QVariant(const QModelIndex &val)
QVariant(const QJsonDocument &val)
QVariant(const QJsonArray &val)
QVariant(const QJsonObject &val)
QVariant(const QJsonValue &val)
QVariant(const QUrl &val)
QVariant(const QUuid &val)
QVariant(const QEasingCurve &val)
QVariant(const QRegularExpression &re)
QVariant(const QLocale &l)
QVariant(const QRectF &val)
QVariant(const QRect &val)
QVariant(const QLineF &val)
QVariant(const QLine &val)
QVariant(const QPointF &val)
QVariant(const QPoint &val)
QVariant(const QSizeF &val)
QVariant(const QSize &val)
QVariant(const QHash &val)
QVariant(const QMap &val)
QVariant(const QList &val)
QVariant(const QDateTime &val)
QVariant(QTime val)
QVariant(QDate val)
QVariant(QChar c)
QVariant(const QStringList &val)
QVariant(QLatin1String val)
QVariant(const QString &val)
QVariant(const QBitArray &val)
QVariant(const QByteArray &val)
QVariant(const char *val)
QVariant(float val)
QVariant(double val)
QVariant(bool val)
QVariant(qulonglong val)
QVariant(qlonglong val)
QVariant(uint val)
QVariant(int val)
QVariant(const QVariant &p)
QVariant(QMetaType type, const void *copy = nullptr)
QVariant()
QVariant & operator=(QVariant &&other)
QVariant & operator=(const QVariant &variant)
~QVariant()
bool canConvert(QMetaType type) const
bool canConvert() const
bool canView() const
void clear()
const void * constData() const
bool convert(QMetaType targetType)
void * data()
const void * data() const
bool isNull() const
bool isValid() const
QMetaType metaType() const
void setValue(T &&value)
void setValue(const QVariant &value)
void setValue(QVariant &&value)
void swap(QVariant &other)
QBitArray toBitArray() const
bool toBool() const
QByteArray toByteArray() const
QChar toChar() const
END_OF_DOCUMENT_MARKER
QDate toDate() const
QDateTime toDateTime() const
double toDouble(bool *ok = nullptr) const
QEasingCurve toEasingCurve() const
float toFloat(bool *ok = nullptr) const
QHash<QString, QVariant> toHash() const
int toInt(bool *ok = nullptr) const
QJsonArray toJsonArray() const
QJsonDocument toJsonDocument() const
QJsonObject toJsonObject() const
QJsonValue toJsonValue() const
QLine toLine() const
QLineF toLineF() const
QList<QVariant> toList() const
QLocale toLocale() const
qlonglong toLongLong(bool *ok = nullptr) const
QMap<QString, QVariant> toMap() const
QModelIndex toModelIndex() const
QPersistentModelIndex toPersistentModelIndex() const
QPoint toPoint() const
QPointF toPointF() const
qreal toReal(bool *ok = nullptr) const
QRect toRect() const
QRectF toRectF() const
QRegularExpression toRegularExpression() const
QSize toSize() const
QSizeF toSizeF() const
QString toString() const
QStringList toStringList() const
QTime toTime() const
uint toUInt(bool *ok = nullptr) const
qulonglong toULongLong(bool *ok = nullptr) const
QUrl toUrl() const
QUuid toUuid() const
int typeId() const
const char * typeName() const
int userType() const
T value() const
T view()

Статические открытые члены

QPartialOrdering compare(const QVariant &lhs, const QVariant &rhs)
QVariant fromStdVariant(const std::variant<Types...> &value)
QVariant fromValue(const T &value)

Связанные нечлены

QVariantHash
QVariantList
QVariantMap
T qvariant_cast(const QVariant &value)
bool operator!=(const QVariant &v1, const QVariant &v2)
bool operator==(const QVariant &v1, const QVariant &v2)

Подробное описание

Поскольку C++ запрещает объединения, включающие типы с конструкторами или деструкторами, отличными от по умолчанию, большинство интересных классов Qt не могут использоваться в объединениях. Без QVariant это была бы проблема для QObject::property() и для работы с базами данных и т. д.

Объект QVariant хранит единственное значение одного typeId() одновременно. (Некоторые типы являются многозначными, например, список строк.) Вы можете узнать, какой тип T имеет вариант, преобразовать его в другой тип с помощью convert(), получить его значение с помощью одной из функций toT() (например, toSize()), и проверить, можно ли преобразовать тип в определенный тип с помощью canConvert().

Методы с именем toT() (например, toInt(), toString()) являются const. Если вы запрашиваете сохраненный тип, они возвращают копию сохраненного объекта. Если вы запрашиваете тип, который может быть сгенерирован из сохраненного типа, toT() копирует и преобразует, и оставляет сам объект неизменным. Если вы запрашиваете тип, который не может быть сгенерирован из сохраненного типа, результат зависит от типа; см. документацию функции для получения подробной информации.

Вот пример кода, демонстрирующий использование QVariant:

QDataStream out(...);
QVariant v(123);                // The variant now contains an int
int x = v.toInt();              // x = 123
out << v;                       // Writes a type tag and an int to out
v = QVariant(tr("hello"));      // The variant now contains a QString
int y = v.toInt();              // y = 0 since v cannot be converted to an int
QString s = v.toString();       // s = tr("hello")  (see QObject::tr())
out << v;                       // Writes a type tag and a QString to out
...
QDataStream in(...);            // (opening the previously written stream)
in >> v;                        // Reads an Int variant
int z = v.toInt();              // z = 123
qDebug("Type is %s",            // prints "Type is int"
        v.typeName());
v = v.toInt() + 100;            // The variant now holds the value 223
v = QVariant(QStringList());    // The variant now holds a QStringList

Вы даже можете хранить QList<QVariant> и QMap<QString, QVariant> значения в варианте, так что вы можете легко создавать произвольно сложные структуры данных произвольных типов. Это очень мощно и универсально, но может оказаться менее эффективным с точки зрения памяти и скорости, чем хранение определенных типов в стандартных структурах данных.

QVariant также поддерживает понятие нулевых значений. Вариант является нулевым, если вариант не содержит инициализированного значения или содержит нулевой указатель.

QVariant x;                                // x.isNull() == true
QVariant y = QVariant::fromValue(nullptr); // y.isNull() == true

QVariant можно расширить, чтобы он поддерживал другие типы, помимо тех, которые указаны в списке QMetaType::Type. Смотрите Создание пользовательских типов Qt для получения подробной информации.

Примечание по типам GUI

Поскольку QVariant является частью модуля Qt Core, он не может предоставить функции преобразования к типам данных, определенным в Qt GUI, таким как QColor, QImage и QPixmap. Другими словами, нет функции toColor(). Вместо этого вы можете использовать QVariant::value() или шаблонную функцию qvariant_cast(). Например:

QVariant variant;
...
QColor color = variant.value<QColor>();

Обратное преобразование (например, от QColor к QVariant) выполняется автоматически для всех типов данных, поддерживаемых QVariant, включая типы, относящиеся к GUI:

QColor color = palette().background().color();
QVariant variant = color;

Использование canConvert() и convert() последовательно

При последовательном использовании canConvert() и convert() возможно, что canConvert() вернёт true, а convert() — false. Обычно это происходит потому, что canConvert() лишь сообщает о возможности преобразования типов в QVariant при наличии подходящих данных; всё ещё возможно предоставить данные, которые фактически преобразовать нельзя.

Например, canConvert(QMetaType::fromType<int>()) вернёт true, если вызвана на варианте, содержащем строку, поскольку QVariant, в принципе, может преобразовать строку с числом в целое число. Однако, если строка содержит нечисловые символы, её нельзя преобразовать в целое число, и любая попытка преобразования завершится неудачей. Поэтому важно, чтобы обе функции возвращали true для успешного преобразования.

См. также QMetaType.

Документация по членам-функциям

const void *QVariant::constData() const

const void *QVariant::data() const

Возвращает указатель на содержащийся объект в виде универсального void*, к которому нельзя получить доступ для записи.

См. также QMetaType.

int QVariant::typeId() const

int QVariant::userType() const

Возвращает тип хранения значения, хранящегося в варианте. Это то же, что и metaType().id().

См. также metaType().

[since 5.2] QVariant::QVariant(QVariant &&other)

Создаёт экземпляр QVariant, ссылаясь на тот же объект, на который ссылался other.

Эта функция была добавлена в Qt 5.2.

[since 5.5] QVariant::QVariant(const QPersistentModelIndex &val)

Создаёт новый вариант со значением QPersistentModelIndex, val.

Эта функция была добавлена в Qt 5.5.

[since 5.0] QVariant::QVariant(const QModelIndex &val)

Создаёт новый вариант со значением QModelIndex, val.

Эта функция была добавлена в Qt 5.0.

[since 5.0] QVariant::QVariant(const QJsonDocument &val)

Создаёт новый вариант со значением документа JSON, val.

Эта функция была добавлена в Qt 5.0.

[since 5.0] QVariant::QVariant(const QJsonArray &val)

Создаёт новый вариант со значением массива JSON, val.

Эта функция была добавлена в Qt 5.0.

[since 5.0] QVariant::QVariant(const QJsonObject &val)

Создаёт новый вариант со значением объекта JSON, val.

Эта функция была добавлена в Qt 5.0.

[since 5.0] QVariant::QVariant(const QJsonValue &val)

Создаёт новый вариант со значением значения JSON, val.

Эта функция была добавлена в Qt 5.0.

QVariant::QVariant(const QUrl &val)

Создаёт новый вариант со значением URL val.

[since 5.0] QVariant::QVariant(const QUuid &val)

Создаёт новый вариант со значением UUID, val.

Эта функция была добавлена в Qt 5.0.

QVariant::QVariant(const QEasingCurve &val)

Создаёт новый вариант со значением кривой сглаживания, val.

[since 5.0] QVariant::QVariant(const QRegularExpression &re)

Создаёт новый вариант со значением регулярного выражения re.

Эта функция была добавлена в Qt 5.0.

QVariant::QVariant(const QLocale &l)

Создаёт новый вариант со значением локали, l.

QVariant::QVariant(const QRectF &val)

Создаёт новый вариант со значением прямоугольника val.

QVariant::QVariant(const QRect &val)

Создаёт новый вариант со значением прямоугольника val.

QVariant::QVariant(const QLineF &val)

Создаёт новый вариант со значением линии val.

QVariant::QVariant(const QLine &val)

Создаёт новый вариант со значением линии val.

QVariant::QVariant(const QPointF &val)

Создаёт новый вариант со значением точки val.

QVariant::QVariant(const QPoint &val)

Создаёт новый вариант со значением точки val.

QVariant::QVariant(const QSizeF &val)

Создаёт новый вариант со значением размера val.

QVariant::QVariant(const QSize &val)

Создаёт новый вариант со значением размера val.

QVariant::QVariant(const QHash<QString, QVariant> &val)

Создаёт новый вариант со значением хэша QVariant, val.

QVariant::QVariant(const QMap<QString, QVariant> &val)

Создаёт новый вариант со значением карты QVariant, val.

QVariant::QVariant(const QList<QVariant> &val)

Создаёт новый вариант со значением списка, val.

QVariant::QVariant(const QDateTime &val)

Создаёт новый вариант со значением даты/времени, val.

QVariant::QVariant(QTime val)

Создаёт новый вариант со значением времени, val.

QVariant::QVariant(QDate val)

Создаёт новый вариант со значением даты, val.

QVariant::QVariant(QChar c)

Создаёт новый вариант со значением символа, c.

QVariant::QVariant(const QStringList &val)

Создаёт новый вариант со значением списка строк, val.

QVariant::QVariant(QLatin1String val)

Создаёт новый вариант со строковым значением, val.

QVariant::QVariant(const QString &val)

Создаёт новый вариант со строковым значением, val.

QVariant::QVariant(const QBitArray &val)

Создаёт новый вариант со значением битового массива, val.

QVariant::QVariant(const QByteArray &val)

Создаёт новый вариант со значением массива байтов, val.

QVariant::QVariant(const char *val)

Создаёт новый вариант со строковым значением val. Вариант создаёт глубокую копию val в QString, предполагая кодировку UTF-8 для входного val.

Обратите внимание, что val преобразуется в QString для хранения в варианте, и QVariant::userType() вернёт QMetaType::QString для варианта.

Вы можете отключить этот оператор, определив QT_NO_CAST_FROM_ASCII при компиляции приложений.

QVariant::QVariant(float val)

Создаёт новый вариант с плавающей точкой значением, val.

QVariant::QVariant(double val)

Создаёт новый вариант с плавающей точкой значением, val.

QVariant::QVariant(bool val)

Создаёт новый вариант с булевым значением, val.

QVariant::QVariant(qulonglong val)

Создаёт новый вариант с беззнаковым 64-битным целым значением, val.

END_OF_DOCUMENT_MARKER

QVariant::QVariant(qlonglong val)

Создаёт новую переменную с целым значением типа long long, val.

QVariant::QVariant(uint val)

Создаёт новую переменную со значением беззнакового целого типа, val.

QVariant::QVariant(int val)

Создаёт новую переменную со значением целого типа, val.

QVariant::QVariant(const QVariant &p)

Создаёт копию переменной, p, переданной в качестве аргумента конструктору.

QVariant::QVariant(QMetaType type, const void *copy = nullptr)

Создаёт переменную типа type и инициализирует её значением copy, если copy не nullptr.

Обратите внимание, что необходимо передать адрес переменной, которую вы хотите сохранить.

Обычно, вам не нужно использовать этот конструктор, используйте QVariant::fromValue() вместо него для создания переменных из указателей на типы, представленные QMetaType::VoidStar, и QMetaType::QObjectStar.

См. также QVariant::fromValue() и QMetaType::Type.

QVariant::QVariant()

Создаёт недействительную переменную.

[since 5.2] QVariant &QVariant::operator=(QVariant &&other)

Перемещает присваивание other этому экземпляру QVariant.

Эта функция была добавлена в Qt 5.2.

QVariant &QVariant::operator=(const QVariant &variant)

Присваивает значение переменной variant этой переменной.

QVariant::~QVariant()

Удаляет QVariant и содержащийся в ней объект.

Обратите внимание, что подклассы, которые переопределяют clear(), должны переопределить деструктор, чтобы вызвать clear(). Этот деструктор вызывает clear(), но поскольку это деструктор, вызывается QVariant::clear(), а не clear() подкласса.

[since 6.0] bool QVariant::canConvert(QMetaType type) const

Возвращает true, если тип переменной может быть преобразован к запрошенному типу type. Такое преобразование выполняется автоматически при вызове методов toInt(), toBool() и т.д.

Эта функция была добавлена в Qt 6.0.

См. также QMetaType::canConvert().

template <typename T> bool QVariant::canConvert() const

Возвращает true, если переменная может быть преобразована к шаблону типа T, в противном случае возвращает false.

Пример:

QVariant v = 42;

v.canConvert<int>();              // returns true
v.canConvert<QString>();          // returns true

MyCustomStruct s;
v.setValue(s);

v.canConvert<int>();              // returns false
v.canConvert<MyCustomStruct>();   // returns true

QVariant, содержащая указатель на тип, производный от QObject, также вернёт true для этой функции, если qobject_cast к шаблону типа T будет успешным. Обратите внимание, что это работает только для подклассов QObject, которые используют макрос Q_OBJECT.

См. также convert().

template <typename T> bool QVariant::canView() const

Возвращает true, если можно создать изменяемый вид шаблона типа T в этой переменной, в противном случае false.

См. также value().

void QVariant::clear()

Преобразует эту переменную к типу QMetaType::UnknownType и освобождает все используемые ресурсы.

[static, since 6.0] QPartialOrdering QVariant::compare(const QVariant &lhs, const QVariant &rhs)

Сравнивает объекты в lhs и rhs для определения порядка.

Возвращает QPartialOrdering::Unordered, если сравнение не поддерживается или значения не упорядочены. В противном случае возвращает QPartialOrdering::Less, QPartialOrdering::Equivalent или QPartialOrdering::Greater, если lhs меньше, равно или больше rhs соответственно.

Если переменные содержат данные с разными метатипами, значения считаются неупорядоченными, за исключением случаев, когда они оба являются числовыми или указателями, где будут использоваться стандартные правила сравнения чисел или указателей.

Примечание: Если выполняется численное сравнение и хотя бы одно значение равно NaN, возвращается QPartialOrdering::Unordered.

Если обе переменные содержат данные одного и того же метатипа, метод использует метод QMetaType::compare для определения порядка двух переменных, который также может указывать, что порядок между двумя значениями установить невозможно.

Эта функция была добавлена в Qt 6.0.

См. также QMetaType::compare() и QMetaType::isOrdered().

[since 6.0] bool QVariant::convert(QMetaType targetType)

Преобразует переменную к запрошенному типу targetType. Если преобразование невозможно, переменная всё равно изменяется на запрошенный тип, но остаётся в очищенном состоянии null, подобно тому, как создаётся QVariant(Type).

Возвращает true, если текущий тип переменной был успешно преобразован; в противном случае возвращает false.

QVariant, содержащая указатель на тип, производный от QObject, также преобразует и возвращает true для этой функции, если qobject_cast к типу, описанному в targetType, будет успешным. Обратите внимание, что это работает только для подклассов QObject, которые используют макрос Q_OBJECT.

Примечание: Преобразование QVariant, которые равны null из-за отсутствия инициализации или из-за неудачи предыдущего преобразования, всегда завершится ошибкой, изменит тип, останется null и вернёт false.

Эта функция была добавлена в Qt 6.0.

См. также canConvert() и clear().

void *QVariant::data()

Возвращает указатель на содержащийся объект в виде универсального void*, к которому можно получить доступ для записи.

Эта функция отсоединяет QVariant. Если вызвана на null-QVariant, QVariant не будет null после вызова.

См. также QMetaType.

[static, since 5.11] template <typename Types> QVariant QVariant::fromStdVariant(const std::variant<Types...> &value)

Возвращает QVariant с типом и значением активной переменной value. Если активный тип std::monostate, возвращается стандартная QVariant.

Примечание: С этим методом вам не нужно регистрировать переменную как Qt метатип, так как std::variant разрешается до хранения. Однако компоненты типов должны быть зарегистрированы.

Эта функция была добавлена в Qt 5.11.

См. также fromValue().

[static] template <typename T> QVariant QVariant::fromValue(const T &value)

Возвращает QVariant, содержащую копию value. Ведёт себя точно так же, как setValue() в остальном.

Пример:

MyCustomStruct s;
return QVariant::fromValue(s);

Примечание: Если вы работаете с пользовательскими типами, используйте макрос Q_DECLARE_METATYPE() для регистрации пользовательского типа.

См. также setValue() и value().

bool QVariant::isNull() const

Возвращает true , если это null-переменная, в противном случае false.

Переменная считается null, если она не содержит инициализированного значения или указателя на null.

Примечание: Это поведение изменено с Qt 5, где isNull() также возвращало бы true, если переменная содержала объект встроенного типа с методом isNull(), который возвращал true для этого объекта.

См. также convert().

bool QVariant::isValid() const

Возвращает true , если тип хранения этой переменной не QMetaType::UnknownType; в противном случае возвращает false.

[since 6.0] QMetaType QVariant::metaType() const

Возвращает QMetaType значения, хранящегося в переменной.

Эта функция была добавлена в Qt 6.0.

template <typename T, typename> void QVariant::setValue(T &&value)

Хранит копию value. Если T — тип, который QVariant не поддерживает, используется QMetaType для хранения значения. Возникнет ошибка компиляции, если QMetaType не обрабатывает тип.

Пример:

QVariant v;

v.setValue(5);
int i = v.toInt();         // i is now 5
QString s = v.toString();  // s is now "5"

MyCustomStruct c;
v.setValue(c);

...

MyCustomStruct c2 = v.value<MyCustomStruct>();

См. также value(), fromValue() и canConvert().

void QVariant::setValue(const QVariant &value)

Копирует value в этот QVariant. Эквивалентно простому присваиванию value этому QVariant.

void QVariant::setValue(QVariant &&value)

Перемещает value в этот QVariant. Эквивалентно простому перемещающему присваиванию value этому QVariant.

void QVariant::swap(QVariant &other)

Меняет местами переменную other с данной переменной. Эта операция очень быстрая и никогда не терпит неудачу.

QBitArray QVariant::toBitArray() const

Возвращает переменную как QBitArray, если у переменной userType() равна QMetaType::QBitArray; в противном случае возвращает пустой массив битов.

См. также canConvert() и convert().

bool QVariant::toBool() const

Возвращает переменную как bool, если у переменной userType() равна Bool.

Возвращает true если у переменной userType() равна QMetaType::Bool, QMetaType::QChar, QMetaType::Double, QMetaType::Int, QMetaType::LongLong, QMetaType::UInt или QMetaType::ULongLong и значение не равно нулю, или если у переменной тип QMetaType::QString или QMetaType::QByteArray и её содержимое в нижнем регистре не равно пустой строке, "0" или "false"; в противном случае возвращает false.

См. также canConvert() и convert().

QByteArray QVariant::toByteArray() const

Возвращает переменную как QByteArray, если у переменной userType() равна QMetaType::QByteArray или QMetaType::QString (преобразованная с помощью QString::fromUtf8()); в противном случае возвращает пустой массив байтов.

См. также canConvert() и convert().

QChar QVariant::toChar() const

Возвращает переменную как QChar, если у переменной userType() равна QMetaType::QChar, QMetaType::Int или QMetaType::UInt; в противном случае возвращает недопустимый QChar.

См. также canConvert() и convert().

QDate QVariant::toDate() const

Возвращает переменную как QDate, если у переменной userType() равна QMetaType::QDate, QMetaType::QDateTime или QMetaType::QString; в противном случае возвращает недопустимую дату.

Если тип() равен QMetaType::QString, будет возвращена недопустимая дата, если строка не может быть разобрана как дата в формате Qt::ISODate.

См. также canConvert() и convert().

QDateTime QVariant::toDateTime() const

Возвращает переменную как QDateTime, если у переменной userType() равна QMetaType::QDateTime, QMetaType::QDate или QMetaType::QString; в противном случае возвращает недопустимое время.

Если тип() равен QMetaType::QString, будет возвращено недопустимое время, если строка не может быть разобрана как время в формате Qt::ISODate.

См. также canConvert() и convert().

double QVariant::toDouble(bool *ok = nullptr) const

Возвращает переменную как double, если у переменной userType() равна QMetaType::Double, QMetaType::Float, QMetaType::Bool, QMetaType::QByteArray, QMetaType::Int, QMetaType::LongLong, QMetaType::QString, QMetaType::UInt или QMetaType::ULongLong; в противном случае возвращает 0.0.

Если ok не равен null: *ok устанавливается в true, если значение можно преобразовать в double; иначе *ok устанавливается в false.

См. также canConvert() и convert().

QEasingCurve QVariant::toEasingCurve() const

Возвращает переменную как QEasingCurve, если у переменной userType() равна QMetaType::QEasingCurve; в противном случае возвращает стандартную кривую изменения.

См. также canConvert() и convert().

float QVariant::toFloat(bool *ok = nullptr) const

Возвращает переменную как float, если у переменной userType() равна QMetaType::Double, QMetaType::Float, QMetaType::Bool, QMetaType::QByteArray, QMetaType::Int, QMetaType::LongLong, QMetaType::QString, QMetaType::UInt или QMetaType::ULongLong; в противном случае возвращает 0.0.

Если ok не равен null: *ok устанавливается в true, если значение можно преобразовать в double; иначе *ok устанавливается в false.

См. также canConvert() и convert().

QHash<QString, QVariant> QVariant::toHash() const

Возвращает переменную как QHash<QString, QVariant>, если у переменной тип() равен QMetaType::QVariantHash; в противном случае возвращает пустой словарь.

См. также canConvert() и convert().

int QVariant::toInt(bool *ok = nullptr) const

Возвращает переменную как int, если у переменной userType() равна QMetaType::Int, QMetaType::Bool, QMetaType::QByteArray, QMetaType::QChar, QMetaType::Double, QMetaType::LongLong, QMetaType::QString, QMetaType::UInt или QMetaType::ULongLong; в противном случае возвращает 0.

Если ok не равен null: *ok устанавливается в true, если значение можно преобразовать в int; иначе *ok устанавливается в false.

Предупреждение: Если значение преобразуемо в QMetaType::LongLong, но слишком велико для представления в int, то результат арифметического переполнения не будет отражён в ok. Простым решением является использование QString::toInt().

См. также canConvert() и convert().

QJsonArray QVariant::toJsonArray() const

Возвращает переменную как QJsonArray, если у переменной userType() равна QJsonArray; в противном случае возвращает конструктор по умолчанию QJsonArray.

Эта функция была добавлена в Qt 5.0.

См. также canConvert() и convert().

QJsonDocument QVariant::toJsonDocument() const

Возвращает переменную как QJsonDocument, если у переменной userType() равна QJsonDocument; в противном случае возвращает конструктор по умолчанию QJsonDocument.

Эта функция была добавлена в Qt 5.0.

См. также canConvert() и convert().

QJsonObject QVariant::toJsonObject() const

Возвращает вариативное значение как QJsonObject, если у вариативного значения есть userType() QJsonObject; в противном случае возвращает QJsonObject по умолчанию.

Эта функция была добавлена в Qt 5.0.

См. также canConvert() и convert().

[since 5.0] QJsonValue QVariant::toJsonValue() const

Возвращает вариативное значение как QJsonValue, если у вариативного значения есть userType() QJsonValue; в противном случае возвращает QJsonValue по умолчанию.

Эта функция была добавлена в Qt 5.0.

См. также canConvert() и convert().

QLine QVariant::toLine() const

Возвращает вариативное значение как QLine, если у вариативного значения есть userType() QMetaType::QLine; в противном случае возвращает невалидную QLine.

См. также canConvert() и convert().

QLineF QVariant::toLineF() const

Возвращает вариативное значение как QLineF, если у вариативного значения есть userType() QMetaType::QLineF; в противном случае возвращает невалидную QLineF.

См. также canConvert() и convert().

QList<QVariant> QVariant::toList() const

Возвращает вариативное значение как QVariantList, если у вариативного значения есть userType() QMetaType::QVariantList или QMetaType::QStringList; в противном случае возвращает пустой список.

См. также canConvert() и convert().

QLocale QVariant::toLocale() const

Возвращает вариативное значение как QLocale, если у вариативного значения есть userType() QMetaType::QLocale; в противном случае возвращает невалидный QLocale.

См. также canConvert() и convert().

qlonglong QVariant::toLongLong(bool *ok = nullptr) const

Возвращает вариативное значение как целое число типа long long, если у вариативного значения есть userType() QMetaType::LongLong, QMetaType::Bool, QMetaType::QByteArray, QMetaType::QChar, QMetaType::Double, QMetaType::Int, QMetaType::QString, QMetaType::UInt или QMetaType::ULongLong; в противном случае возвращает 0.

Если ok не равен null: *ok устанавливается в true, если значение может быть преобразовано в целое число; в противном случае *ok устанавливается в false.

См. также canConvert() и convert().

QMap<QString, QVariant> QVariant::toMap() const

Возвращает вариативное значение как QMap<QString, QVariant>, если у вариативного значения тип() QMetaType::QVariantMap; в противном случае возвращает пустой массив.

См. также canConvert() и convert().

[since 5.0] QModelIndex QVariant::toModelIndex() const

Возвращает вариативное значение как QModelIndex, если у вариативного значения есть userType() QModelIndex; в противном случае возвращает QModelIndex по умолчанию.

Эта функция была добавлена в Qt 5.0.

См. также canConvert(), convert() и toPersistentModelIndex().

[since 5.5] QPersistentModelIndex QVariant::toPersistentModelIndex() const

Возвращает вариативное значение как QPersistentModelIndex, если у вариативного значения есть userType() QPersistentModelIndex; в противном случае возвращает QPersistentModelIndex по умолчанию.

Эта функция была добавлена в Qt 5.5.

См. также canConvert(), convert() и toModelIndex().

QPoint QVariant::toPoint() const

Возвращает вариативное значение как QPoint, если у вариативного значения есть userType() QMetaType::QPoint или QMetaType::QPointF; в противном случае возвращает нулевой QPoint.

См. также canConvert() и convert().

QPointF QVariant::toPointF() const

Возвращает вариативное значение как QPointF, если у вариативного значения есть userType() QMetaType::QPoint или QMetaType::QPointF; в противном случае возвращает нулевой QPointF.

См. также canConvert() и convert().

qreal QVariant::toReal(bool *ok = nullptr) const

Возвращает вариативное значение как qreal, если у вариативного значения есть userType() QMetaType::Double, QMetaType::Float, QMetaType::Bool, QMetaType::QByteArray, QMetaType::Int, QMetaType::LongLong, QMetaType::QString, QMetaType::UInt или QMetaType::ULongLong; в противном случае возвращает 0.0.

Если ok не равен null: *ok устанавливается в true, если значение может быть преобразовано в double; в противном случае *ok устанавливается в false.

См. также canConvert() и convert().

QRect QVariant::toRect() const

Возвращает вариативное значение как QRect, если у вариативного значения есть userType() QMetaType::QRect; в противном случае возвращает невалидный QRect.

См. также canConvert() и convert().

QRectF QVariant::toRectF() const

Возвращает вариативное значение как QRectF, если у вариативного значения есть userType() QMetaType::QRect или QMetaType::QRectF; в противном случае возвращает невалидный QRectF.

См. также canConvert() и convert().

[since 5.0] QRegularExpression QVariant::toRegularExpression() const

Возвращает вариативное значение как QRegularExpression, если у вариативного значения есть userType() QRegularExpression; в противном случае возвращает пустой QRegularExpression.

Эта функция была добавлена в Qt 5.0.

См. также canConvert() и convert().

QSize QVariant::toSize() const

Возвращает вариативное значение как QSize, если у вариативного значения есть userType() QMetaType::QSize; в противном случае возвращает невалидный QSize.

См. также canConvert() и convert().

QSizeF QVariant::toSizeF() const

Возвращает вариативное значение как QSizeF, если у вариативного значения есть userType() QMetaType::QSizeF; в противном случае возвращает невалидный QSizeF.

См. также canConvert() и convert().

QString QVariant::toString() const

Возвращает вариативное значение как QString, если у вариативного значения есть userType(), включая, но не ограничиваясь:

QMetaType::QString, QMetaType::Bool, QMetaType::QByteArray, QMetaType::QChar, QMetaType::QDate, QMetaType::QDateTime, QMetaType::Double, QMetaType::Int, QMetaType::LongLong, QMetaType::QStringList, QMetaType::QTime, QMetaType::UInt, или QMetaType::ULongLong.

Вызов QVariant::toString() для неподдерживаемой переменной возвращает пустую строку.

См. также canConvert() и convert().

QStringList QVariant::toStringList() const

Возвращает переменную как QStringList, если у переменной userType() имеет значение QMetaType::QStringList, QMetaType::QString или QMetaType::QVariantList типа, который может быть преобразован в QString; в противном случае возвращает пустой список.

См. также canConvert() и convert().

QTime QVariant::toTime() const

Возвращает переменную как QTime, если у переменной userType() имеет значение QMetaType::QTime, QMetaType::QDateTime или QMetaType::QString; в противном случае возвращает недействительное время.

Если тип() равен QMetaType::QString, недействительное время будет возвращено, если строка не может быть обработана как время в формате Qt::ISODate.

См. также canConvert() и convert().

uint QVariant::toUInt(bool *ok = nullptr) const

Возвращает переменную как целое без знака, если у переменной userType() имеет значение QMetaType::UInt, QMetaType::Bool, QMetaType::QByteArray, QMetaType::QChar, QMetaType::Double, QMetaType::Int, QMetaType::LongLong, QMetaType::QString или QMetaType::ULongLong; в противном случае возвращает 0.

Если ok не равен null: *ok устанавливается в true, если значение может быть преобразовано в целое без знака; в противном случае *ok устанавливается в false.

Предупреждение: Если значение может быть преобразовано в QMetaType::ULongLong, но слишком велико для представления целым без знака, возникающий арифметический переполнение не будет отражён в ok. Простым решением является использование QString::toUInt().

См. также canConvert() и convert().

qulonglong QVariant::toULongLong(bool *ok = nullptr) const

Возвращает переменную как целое без знака 64-разрядное, если у переменной тип() QMetaType::ULongLong, QMetaType::Bool, QMetaType::QByteArray, QMetaType::QChar, QMetaType::Double, QMetaType::Int, QMetaType::LongLong, QMetaType::QString или QMetaType::UInt; в противном случае возвращает 0.

Если ok не равен null: *ok устанавливается в true, если значение может быть преобразовано в целое; в противном случае *ok устанавливается в false.

См. также canConvert() и convert().

QUrl QVariant::toUrl() const

Возвращает переменную как QUrl, если у переменной userType() имеет значение QMetaType::QUrl; в противном случае возвращает недействительный QUrl.

См. также canConvert() и convert().

[since 5.0] QUuid QVariant::toUuid() const

Возвращает переменную как QUuid, если у переменной тип() QMetaType::QUuid, QMetaType::QByteArray или QMetaType::QString; в противном случае возвращает QUuid по умолчанию.

Эта функция была добавлена в Qt 5.0.

См. также canConvert() и convert().

const char *QVariant::typeName() const

Возвращает имя типа, хранящегося в переменной. Возвращаемые строки описывают тип данных C++, используемый для хранения данных: например, "QFont", "QString" или "QVariantList". Недействительная переменная возвращает 0.

template <typename T> T QVariant::value() const

Возвращает сохранённое значение, преобразованное в тип шаблона T. Вызовите canConvert(), чтобы узнать, можно ли преобразовать тип. Если значение нельзя преобразовать, возвращается значение по умолчанию.

Если тип T поддерживается QVariant, эта функция ведет себя точно так же, как toString(), toInt() и т. д.

Пример:

QVariant v;

MyCustomStruct c;
if (v.canConvert<MyCustomStruct>())
    c = v.value<MyCustomStruct>();

v = 7;
int i = v.value<int>();                        // same as v.toInt()
QString s = v.value<QString>();                // same as v.toString(), s is now "7"
MyCustomStruct c2 = v.value<MyCustomStruct>(); // conversion failed, c2 is empty

Если QVariant содержит указатель на тип, производный от QObject, то T может быть любым типом QObject. Если указатель, хранящийся в QVariant, можно qobject_cast к T, то возвращается этот результат. В противном случае возвращается nullptr. Обратите внимание, что это работает только для подклассов QObject, которые используют макрос Q_OBJECT.

Если QVariant содержит последовательный контейнер и T равен QVariantList, элементы контейнера будут преобразованы в QVariant и возвращены как QVariantList.

QList<int> intList = {7, 11, 42};

QVariant variant = QVariant::fromValue(intList);
if (variant.canConvert<QVariantList>()) {
    QSequentialIterable iterable = variant.value<QSequentialIterable>();
    // Can use foreach:
    foreach (const QVariant &v, iterable) {
        qDebug() << v;
    }
    // Can use C++11 range-for:
    for (const QVariant &v : iterable) {
        qDebug() << v;
    }
    // Can use iterators:
    QSequentialIterable::const_iterator it = iterable.begin();
    const QSequentialIterable::const_iterator end = iterable.end();
    for ( ; it != end; ++it) {
        qDebug() << *it;
    }
}

См. также setValue(), fromValue(), canConvert() и Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE().

template <typename T> T QVariant::view()

Возвращает изменяемую проекцию шаблонного типа T на сохранённое значение. Вызовите canView(), чтобы узнать, поддерживается ли такая проекция. Если такую проекцию создать нельзя, возвращает сохранённое значение, преобразованное в тип шаблона T. Вызовите canConvert(), чтобы узнать, можно ли преобразовать тип. Если значение нельзя ни спроецировать, ни преобразовать, возвращается значение по умолчанию.

См. также canView() и Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE().

END_OF_DOCUMENT_MARKER

Связанные нечлены

[alias] QVariantHash

Синоним для QHash<QString, QVariant>.

[alias] QVariantList

Синоним для QList<QVariant>.

[alias] QVariantMap

Синоним для QMap<QString, QVariant>.

template <typename T> T qvariant_cast(const QVariant &value)

Возвращает переданное значение value, преобразованное к типу шаблона T.

Эта функция эквивалентна QVariant::value().

См. такжеQVariant::value().

bool operator!=(const QVariant &v1, const QVariant &v2)

Возвращает false, если v1 и v2 равны; в противном случае возвращает true.

QVariant использует оператор равенства типа, содержащегося в нём, для проверки равенства.

Переменные разных типов всегда сравниваются как неравные, за исключением нескольких случаев:

  • Если оба типа — числовые типы (целые и числа с плавающей точкой), Qt сравнит их, используя стандартные правила повышения типов C++.
  • Если один тип — числовой, а другой — QString, Qt попытается преобразовать QString в соответствующий числовой тип и, если это удалось, сравнит их.
  • Если оба варианта содержат указатели на типы, производные от QObject, QVariant проверит, связаны ли типы и указывают ли они на один и тот же объект.

bool operator==(const QVariant &v1, const QVariant &v2)

Возвращает true, если v1 и v2 равны; в противном случае возвращает false.

QVariant использует оператор равенства типа, содержащегося в нём, для проверки равенства.

Переменные разных типов всегда сравниваются как неравные, за исключением нескольких случаев:

  • Если оба типа — числовые типы (целые и числа с плавающей точкой), Qt сравнит их, используя стандартные правила повышения типов C++.
  • Если один тип — числовой, а другой — QString, Qt попытается преобразовать QString в соответствующий числовой тип и, если это удалось, сравнит их.
  • Если оба варианта содержат указатели на типы, производные от QObject, QVariant проверит, связаны ли типы и указывают ли они на один и тот же объект.

Результат функции не зависит от результата QVariant::isNull, что означает, что два значения могут быть равны, даже если одно из них является нулевым, а другое — нет.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qvariant.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API