KTnef::KTNEFParser

Search for usage in LXR

KTnef::KTNEFParser Class Reference

#include <ktnefparser.h>

Public Member Functions

 KTNEFParser ()
 
 ~KTNEFParser ()
 
bool extractAll ()
 
bool extractFile (const QString &filename) const
 
bool extractFileTo (const QString &filename, const QString &dirname) const
 
KTNEFMessagemessage () const
 
bool openDevice (QIODevice *device)
 
bool openFile (const QString &filename) const
 
void setDefaultExtractDir (const QString &dirname)
 

Detailed Description

Provides an TNEF parser.

Definition at line 36 of file ktnefparser.h.

Constructor & Destructor Documentation

◆ KTNEFParser()

KTNEFParser::KTNEFParser ( )

Constructs a TNEF parser object.

Private class that helps to provide binary compatibility between releases.

Definition at line 104 of file ktnefparser.cpp.

◆ ~KTNEFParser()

KTNEFParser::~KTNEFParser ( )

Destroys the TNEF parser object.

Definition at line 109 of file ktnefparser.cpp.

Member Function Documentation

◆ extractAll()

bool KTNEFParser::extractAll ( )

Extracts all TNEF attachments into the default directory.

Returns
true if the extraction succeeds; otherwise false.

Definition at line 508 of file ktnefparser.cpp.

◆ extractFile()

bool KTNEFParser::extractFile ( const QString & filename) const

Extracts a TNEF attachment having filename filename into the default directory.

Parameters
filenameis the name of the file to extract the attachment into.
Returns
true if the extraction succeeds; otherwise false.

Definition at line 445 of file ktnefparser.cpp.

◆ extractFileTo()

bool KTNEFParser::extractFileTo ( const QString & filename,
const QString & dirname ) const

Extracts a TNEF attachment having filename filename into the directory dirname.

Parameters
filenameis the name of the file to extract the attachment into.
dirnameis the name of the directory where the filename should be written.
Returns
true if the extraction succeeds; otherwise false.

Definition at line 521 of file ktnefparser.cpp.

◆ message()

KTNEFMessage * KTNEFParser::message ( ) const

Returns the KTNEFMessage used in the parsing process.

Returns
a pointer to a KTNEFMessage object.

Definition at line 114 of file ktnefparser.cpp.

◆ openDevice()

bool KTNEFParser::openDevice ( QIODevice * device)

Opens the QIODevice device for parsing.

Parameters
deviceis the QIODevice to open.
Returns
true if the open succeeded; otherwise false.

Definition at line 545 of file ktnefparser.cpp.

◆ openFile()

bool KTNEFParser::openFile ( const QString & filename) const

Opens the filename for parsing.

Parameters
filenameis the name of the file to open.
Returns
true if the open succeeded; otherwise false.

Definition at line 531 of file ktnefparser.cpp.

◆ setDefaultExtractDir()

void KTNEFParser::setDefaultExtractDir ( const QString & dirname)

Sets the default extraction directory to dirname.

Parameters
dirnameis the name of the default extraction directory.

Definition at line 378 of file ktnefparser.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 21 2024 11:58:38 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.