LC::AN::FieldData Struct Reference

A single additional AdvancedNotifications field. More...

#include "ianemitter.h"

Collaboration diagram for LC::AN::FieldData:

Classes
struct	AllowedValue

Public Types
using	AllowedValues = QList<AllowedValue>

Public Attributes
QString	ID_
	The field ID.
QString	Name_
	The name of the field.
QString	Description_
	The description of the field.
QMetaType::Type	Type_ = QMetaType::UnknownType
	The type of this field.
QStringList	EventTypes_
	The types of the event that contain this field.
AllowedValues	AllowedValues_ = {}
	The allowed values of this field.

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 28 of file ianemitter.h.

Member Typedef Documentation

AllowedValues

using LC::AN::FieldData::AllowedValues = QList<AllowedValue>

Definition at line 82 of file ianemitter.h.

Member Data Documentation

AllowedValues_

AllowedValues LC::AN::FieldData::AllowedValues_ = {}

The allowed values of this field.

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

This only makes sense for Type_ being either QVariant::String or QVariant::StringList.

Definition at line 92 of file ianemitter.h.

Description_

QString LC::AN::FieldData::Description_

The description of the field.

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

Definition at line 48 of file ianemitter.h.

EventTypes_

QStringList LC::AN::FieldData::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 67 of file ianemitter.h.

ID_

QString LC::AN::FieldData::ID_

The field ID.

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

Definition at line 35 of file ianemitter.h.

Name_

QString LC::AN::FieldData::Name_

The name of the field.

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

Definition at line 41 of file ianemitter.h.

Type_

QMetaType::Type LC::AN::FieldData::Type_ = QMetaType::UnknownType

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 59 of file ianemitter.h.

---

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

• /home/abuild/rpmbuild/BUILD/leechcraft-doc-0.6.70+git.19214.g121e5318a7-build/leechcraft-0.6.70-19214-g121e5318a7/src/interfaces/an/ianemitter.h