KTnef::KTNEFParser Class
class KTnef::KTNEFParserProvides an @acronym TNEF parser. More...
| Header: | #include <ktnefparser.h> |
| CMake: | find_package(KPim6Tnef REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::Tnef) |
Public Functions
| KTNEFParser() | |
| ~KTNEFParser() | |
| bool | extractAll() |
| bool | extractFile(const QString &filename) const |
| bool | extractFileTo(const QString &filename, const QString &dirname) const |
| KTnef::KTNEFMessage * | message() const |
| bool | openDevice(QIODevice *device) |
| bool | openFile(const QString &filename) const |
| void | setDefaultExtractDir(const QString &dirname) |
Detailed Description
Member Function Documentation
KTNEFParser::KTNEFParser()
Constructs a @acronym TNEF parser object.
[noexcept] KTNEFParser::~KTNEFParser()
Destroys the @acronym TNEF parser object.
bool KTNEFParser::extractAll()
Extracts all @acronym TNEF attachments into the default directory.
Returns true if the extraction succeeds; otherwise false.
bool KTNEFParser::extractFile(const QString &filename) const
Extracts a @acronym TNEF attachment having filename filename into the default directory.
filename is the name of the file to extract the attachment into. Returns true if the extraction succeeds; otherwise false.
bool KTNEFParser::extractFileTo(const QString &filename, const QString &dirname) const
Extracts a @acronym TNEF attachment having filename filename into the directory dirname.
filename is the name of the file to extract the attachment into. dirname is the name of the directory where the filename should be written.
Returns true if the extraction succeeds; otherwise false.
KTnef::KTNEFMessage *KTNEFParser::message() const
Returns the KTNEFMessage used in the parsing process.
Returns a pointer to a KTNEFMessage object.
bool KTNEFParser::openDevice(QIODevice *device)
Opens the #QIODevice device for parsing.
device is the #QIODevice to open. Returns true if the open succeeded; otherwise false.
bool KTNEFParser::openFile(const QString &filename) const
Opens the filename for parsing.
filename is the name of the file to open. Returns true if the open succeeded; otherwise false.
void KTNEFParser::setDefaultExtractDir(const QString &dirname)
Sets the default extraction directory to dirname.
dirname is the name of the default extraction directory.