quentier::enml::IENMLTagsConverter Class Reference

The IENMLTagsConverter interfaces provides methods which convert Evernote-specific markup tags such as en-crypt, en-media etc. into their counterparts which should be used in the HTML representation of note content. More...

#include <IENMLTagsConverter.h>

Public Member Functions
virtual QString	convertEnToDo (bool checked, quint32 index) const =0
virtual QString	convertEncryptedText (const QString &encryptedText, const QString &hint, utility::IEncryptor::Cipher cipher, quint32 index) const =0
virtual QString	convertDecryptedText (const QString &decryptedText, const QString &encryptedText, const QString &hint, utility::IEncryptor::Cipher cipher, quint32 index) const =0
virtual Result< QString, ErrorString >	convertResource (const qevercloud::Resource &resource) const =0

Detailed Description

The IENMLTagsConverter interfaces provides methods which convert Evernote-specific markup tags such as en-crypt, en-media etc. into their counterparts which should be used in the HTML representation of note content.

Member Function Documentation

convertDecryptedText()

virtual QString quentier::enml::IENMLTagsConverter::convertDecryptedText ( const QString & decryptedText, const QString & encryptedText, const QString & hint, utility::IEncryptor::Cipher cipher, quint32 index ) const

nodiscardpure virtual

Converts already decrypted en-crypt tag into its HTML counterpart

Parameters

decryptedText	decrypted text from en-crypt tag
encryptedText	encrypted text contained within en-crypt tag
hint	hint to be displayed when user tries to decrypt the text
cipher	cipher used to ecrypt the text
index	index of particular en-crypt tag within the note content so that different en-crypt tags can be differentiated

Returns

HTML representation of decrypted en-crypt tag

convertEncryptedText()

virtual QString quentier::enml::IENMLTagsConverter::convertEncryptedText ( const QString & encryptedText, const QString & hint, utility::IEncryptor::Cipher cipher, quint32 index ) const

nodiscardpure virtual

Converts en-crypt tag into its HTML counterpart

Parameters

encryptedText	encrypted text contained within en-crypt tag
hint	hint to be displayed when user tries to decrypt the text
cipher	cipher used to ecrypt the text
index	index of particular en-crypt tag within the note content so that different en-crypt tags can be differentiated

Returns

HTML representation of en-crypt tag

convertEnToDo()

virtual QString quentier::enml::IENMLTagsConverter::convertEnToDo ( bool checked, quint32 index ) const

nodiscardpure virtual

Converts en-todo tag into its HTML counterpart

Parameters

checked	indicates whether this todo is checked or not
index	index of particular en-todo tag within the note content so that different todo tags can be differentiated

Returns

HTML representation of en-todo tag

convertResource()

virtual Result< QString, ErrorString > quentier::enml::IENMLTagsConverter::convertResource ( const qevercloud::Resource & resource ) const

nodiscardpure virtual

Converts en-media tag representing a resource into its HTML counterpart

Parameters

resource

resource corresponding to en-media tag

Returns

Result with valid HTML representing the resource/en-media tag in case of success or error string in case of failure