KTNEF Library
KTnef::KTNEFParser Class Reference
Provides an TNEF parser. More...
#include <ktnefparser.h>
Public Member Functions | |
bool | extractAll () |
bool | extractFile (const QString &filename) const |
bool | extractFileTo (const QString &filename, const QString &dirname) const |
KTNEFParser () | |
KTNEFMessage * | message () const |
bool | openDevice (QIODevice *device) |
bool | openFile (const QString &filename) const |
void | setDefaultExtractDir (const QString &dirname) |
~KTNEFParser () |
Detailed Description
Provides an TNEF parser.Definition at line 49 of file ktnefparser.h.
Constructor & Destructor Documentation
KTNEFParser::KTNEFParser | ( | ) |
Constructs a TNEF parser object.
Private class that helps to provide binary compatibility between releases.
For internal use only.
Definition at line 116 of file ktnefparser.cpp.
KTNEFParser::~KTNEFParser | ( | ) |
Member Function Documentation
bool KTNEFParser::extractAll | ( | ) |
Extracts all TNEF attachments into the default directory.
- Returns:
- true if the extraction succeeds; otherwise false.
Definition at line 483 of file ktnefparser.cpp.
bool KTNEFParser::extractFile | ( | const QString & | filename | ) | const |
Extracts a TNEF attachment having filename filename
into the default directory.
- Parameters:
-
filename is the name of the file to extract the attachment into.
- Returns:
- true if the extraction succeeds; otherwise false.
Definition at line 439 of file ktnefparser.cpp.
bool KTNEFParser::extractFileTo | ( | const QString & | filename, | |
const QString & | dirname | |||
) | const |
Extracts a TNEF attachment having filename filename
into the directory dirname
.
- Parameters:
-
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.
Definition at line 495 of file ktnefparser.cpp.
KTNEFMessage * KTNEFParser::message | ( | ) | const |
Returns the KTNEFMessage used in the parsing process.
- Returns:
- a pointer to a KTNEFMessage object.
Definition at line 127 of file ktnefparser.cpp.
bool KTNEFParser::openDevice | ( | QIODevice * | device | ) |
Opens the QIODevice device
for parsing.
- Parameters:
-
device is the QIODevice to open.
- Returns:
- true if the open succeeded; otherwise false.
Definition at line 517 of file ktnefparser.cpp.
bool KTNEFParser::openFile | ( | const QString & | filename | ) | const |
Opens the filename
for parsing.
- Parameters:
-
filename is the name of the file to open.
- Returns:
- true if the open succeeded; otherwise false.
Definition at line 507 of file ktnefparser.cpp.
void KTNEFParser::setDefaultExtractDir | ( | const QString & | dirname | ) |
Sets the default extraction directory to dirname
.
- Parameters:
-
dirname is the name of the default extraction directory.
Definition at line 375 of file ktnefparser.cpp.
The documentation for this class was generated from the following files: