LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
LC::ANFieldData Struct Reference

A single additional AdvancedNotifications field. More...

#include "ianemitter.h"

Public Attributes

QString ID_
 The field ID. More...
 
QString Name_
 The name of the field. More...
 
QString Description_
 The description of the field. More...
 
QVariant::Type Type_ = QVariant::Invalid
 The type of this field. More...
 
QStringList EventTypes_
 The types of the event that contain this field. More...
 
QVariantList AllowedValues_ = {}
 The allowed values of this field. More...
 

Detailed Description

A single additional AdvancedNotifications field.

This data structure describes an additional field in the AdvancedNotifications notification entities. The field ID (the name of the corresponding key in LC::Entity::Additional_ map) is stored in the ID_ member.

This structure also carries information about field name, type, description and such.

Definition at line 34 of file ianemitter.h.

Member Data Documentation

◆ AllowedValues_

QVariantList LC::ANFieldData::AllowedValues_ = {}

The allowed values of this field.

If this list is non-empty, only values from this list are allowed.

This currently only makes sense for QVariant::String and QVariant::StringList, in which case each QVariant in this list should be a QString.

Definition at line 90 of file ianemitter.h.

◆ Description_

QString LC::ANFieldData::Description_

The description of the field.

This member contains the human-readable description of this field.

Definition at line 60 of file ianemitter.h.

◆ EventTypes_

QStringList LC::ANFieldData::EventTypes_

The types of the event that contain this field.

This member contains the types of the events that contain this field. This field won't be checked in events of types not mentioned here.

Definition at line 79 of file ianemitter.h.

◆ ID_

QString LC::ANFieldData::ID_

The field ID.

The field ID is the value of the corresponding key in the LC::Entity::Additional_ map.

Definition at line 47 of file ianemitter.h.

◆ Name_

QString LC::ANFieldData::Name_

The name of the field.

This member contains the human-readable name of this field.

Definition at line 53 of file ianemitter.h.

◆ Type_

QVariant::Type LC::ANFieldData::Type_ = QVariant::Invalid

The type of this field.

This member contains the type of the value of this field - the value for the corresponding key (equal to ID_) in the LC::Entity::Additional_ map.

For now only QVariant::Int, QVariant::String and QVariant::StringList are supported.

Definition at line 71 of file ianemitter.h.


The documentation for this struct was generated from the following file: