MythTV master
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
XmlSerializer Class Reference

#include <libmythupnp/serializers/xmlSerializer.h>

Inheritance diagram for XmlSerializer:
[legend]
Collaboration diagram for XmlSerializer:
[legend]

Public Member Functions

 XmlSerializer (QIODevice *pDevice, QString sRequestName)
 
virtual ~XmlSerializer ()
 
QString GetContentType () override
 
 XmlSerializer (const XmlSerializer &)=delete
 
XmlSerializer & operator= (const XmlSerializer &)=delete
 
- Public Member Functions inherited from Serializer
virtual void Serialize (const QObject *pObject, const QString &_sName=QString())
 
virtual void Serialize (const QVariant &vValue, const QString &sName)
 
virtual QString GetContentType ()=0
 
virtual void AddHeaders (QStringMap &headers)
 
 Serializer ()
 

Public Attributes

bool PropertiesAsAttributes {true}
 

Protected Member Functions

void BeginSerialize (QString &sName) override
 
void EndSerialize () override
 
void BeginObject (const QString &sName, const QObject *pObject) override
 
void EndObject (const QString &sName, const QObject *pObject) override
 
void AddProperty (const QString &sName, const QVariant &vValue, const QMetaObject *pMetaParent, const QMetaProperty *pMetaProp) override
 
void RenderValue (const QString &sName, const QVariant &vValue)
 
void RenderEnum (const QString &sName, const QVariant &vValue, const QMetaProperty *pMetaProp)
 
void RenderStringList (const QString &sName, const QStringList &list)
 
void RenderList (const QString &sName, const QVariantList &list)
 
void RenderMap (const QString &sName, const QVariantMap &map)
 
- Protected Member Functions inherited from Serializer
virtual void BeginSerialize (QString &)
 
virtual void EndSerialize ()
 
virtual void BeginObject (const QString &sName, const QObject *pObject)=0
 
virtual void EndObject (const QString &sName, const QObject *pObject)=0
 
virtual void AddProperty (const QString &sName, const QVariant &vValue, const QMetaObject *pMetaParent, const QMetaProperty *pMetaProp)=0
 
void SerializeObject (const QObject *pObject, const QString &sName)
 
void SerializeObjectProperties (const QObject *pObject)
 

Static Protected Member Functions

static QString GetItemName (const QString &sName)
 
static QString GetContentName (const QString &sName, const QMetaObject *pMetaObject, const QMetaProperty *pMetaProp)
 
static QString FindOptionValue (const QStringList &sOptions, const QString &sName)
 
- Static Protected Member Functions inherited from Serializer
static QString ReadPropertyMetadata (const QObject *pObject, const QString &sPropName, const QString &sKey)
 

Protected Attributes

QXmlStreamWriter * m_pXmlWriter {nullptr}
 
QString m_sRequestName
 
bool m_bIsRoot {true}
 
- Protected Attributes inherited from Serializer
QCryptographicHash m_hash
 

Detailed Description

Definition at line 32 of file xmlSerializer.h.

Constructor & Destructor Documentation

◆ XmlSerializer() [1/2]

XmlSerializer::XmlSerializer ( QIODevice *  pDevice,
QString  sRequestName 
)

Definition at line 31 of file xmlSerializer.cpp.

◆ ~XmlSerializer()

XmlSerializer::~XmlSerializer ( )
virtual

Definition at line 41 of file xmlSerializer.cpp.

◆ XmlSerializer() [2/2]

XmlSerializer::XmlSerializer ( const XmlSerializer &  )
delete

Member Function Documentation

◆ AddProperty()

void XmlSerializer::AddProperty ( const QString &  sName,
const QVariant &  vValue,
const QMetaObject *  pMetaParent,
const QMetaProperty *  pMetaProp 
)
overrideprotectedvirtual

Implements Serializer.

Definition at line 120 of file xmlSerializer.cpp.

◆ BeginObject()

void XmlSerializer::BeginObject ( const QString &  sName,
const QObject *  pObject 
)
overrideprotectedvirtual

Implements Serializer.

Definition at line 82 of file xmlSerializer.cpp.

◆ BeginSerialize()

void XmlSerializer::BeginSerialize ( QString &  sName)
overrideprotectedvirtual

Reimplemented from Serializer.

Definition at line 63 of file xmlSerializer.cpp.

◆ EndObject()

void XmlSerializer::EndObject ( const QString &  sName,
const QObject *  pObject 
)
overrideprotectedvirtual

Implements Serializer.

Definition at line 111 of file xmlSerializer.cpp.

◆ EndSerialize()

void XmlSerializer::EndSerialize ( void  )
overrideprotectedvirtual

Reimplemented from Serializer.

Definition at line 73 of file xmlSerializer.cpp.

◆ FindOptionValue()

QString XmlSerializer::FindOptionValue ( const QStringList &  sOptions,
const QString &  sName 
)
staticprotected

Definition at line 372 of file xmlSerializer.cpp.

Referenced by GetContentName().

◆ GetContentName()

QString XmlSerializer::GetContentName ( const QString &  sName,
const QMetaObject *  pMetaObject,
const QMetaProperty *  pMetaProp 
)
staticprotected

Definition at line 330 of file xmlSerializer.cpp.

Referenced by AddProperty().

◆ GetContentType()

QString XmlSerializer::GetContentType ( )
overridevirtual

Implements Serializer.

Definition at line 54 of file xmlSerializer.cpp.

◆ GetItemName()

QString XmlSerializer::GetItemName ( const QString &  sName)
staticprotected

Definition at line 313 of file xmlSerializer.cpp.

Referenced by GetContentName(), XmlPListSerializer::RenderList(), XmlPListSerializer::RenderMap(), RenderMap(), and XmlPListSerializer::SerializePListObjectProperties().

◆ operator=()

XmlSerializer & XmlSerializer::operator= ( const XmlSerializer &  )
delete

◆ RenderEnum()

void XmlSerializer::RenderEnum ( const QString &  sName,
const QVariant &  vValue,
const QMetaProperty *  pMetaProp 
)
protected

Definition at line 144 of file xmlSerializer.cpp.

Referenced by AddProperty().

◆ RenderList()

void XmlSerializer::RenderList ( const QString &  sName,
const QVariantList &  list 
)
protected

Definition at line 239 of file xmlSerializer.cpp.

Referenced by RenderValue().

◆ RenderMap()

void XmlSerializer::RenderMap ( const QString &  sName,
const QVariantMap &  map 
)
protected

Definition at line 278 of file xmlSerializer.cpp.

Referenced by RenderValue().

◆ RenderStringList()

void XmlSerializer::RenderStringList ( const QString &  sName,
const QStringList &  list 
)
protected

Definition at line 262 of file xmlSerializer.cpp.

Referenced by RenderValue().

◆ RenderValue()

void XmlSerializer::RenderValue ( const QString &  sName,
const QVariant &  vValue 
)
protected

Definition at line 169 of file xmlSerializer.cpp.

Referenced by AddProperty(), RenderList(), and RenderMap().

Member Data Documentation

◆ m_bIsRoot

bool XmlSerializer::m_bIsRoot {true}
protected

Definition at line 39 of file xmlSerializer.h.

Referenced by BeginObject().

◆ m_pXmlWriter

QXmlStreamWriter* XmlSerializer::m_pXmlWriter {nullptr}
protected

Definition at line 37 of file xmlSerializer.h.

Referenced by AddProperty(), XmlPListSerializer::BeginObject(), BeginObject(), XmlPListSerializer::BeginSerialize(), BeginSerialize(), XmlPListSerializer::EndObject(), EndObject(), XmlPListSerializer::EndSerialize(), EndSerialize(), RenderEnum(), XmlPListSerializer::RenderList(), RenderList(), XmlPListSerializer::RenderMap(), RenderMap(), XmlPListSerializer::RenderStringList(), RenderStringList(), RenderValue(), XmlPListSerializer::RenderValue(), XmlPListSerializer::SerializePListObjectProperties(), and ~XmlSerializer().

◆ m_sRequestName

QString XmlSerializer::m_sRequestName
protected

Definition at line 38 of file xmlSerializer.h.

◆ PropertiesAsAttributes

bool XmlSerializer::PropertiesAsAttributes {true}

Definition at line 74 of file xmlSerializer.h.

The documentation for this class was generated from the following files:
Generated on Tue Oct 28 2025 03:17:00 for MythTV by doxygen 1.9.4