• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

KTNEF Library

  • KTnef
  • KTNEFAttach
Public Types | Public Member Functions | List of all members
KTnef::KTNEFAttach Class Reference

#include <ktnefattach.h>

Inheritance diagram for KTnef::KTNEFAttach:
Inheritance graph
[legend]

Public Types

enum  ParseState { Unparsed = 0x0000, TitleParsed = 0x0001, DataParsed = 0x0002, InfoParsed = 0x0004 }
 

Public Member Functions

 KTNEFAttach ()
 
 ~KTNEFAttach ()
 
bool checkState (int state) const
 
bool dataParsed () const
 
QString displayName () const
 
int displaySize () const
 
QString extension () const
 
QString fileName () const
 
int index () const
 
bool infoParsed () const
 
QString mimeTag () const
 
QString name () const
 
int offset () const
 
void setDataParsed ()
 
void setDisplayName (const QString &str)
 
void setDisplaySize (int size)
 
void setExtension (const QString &str)
 
void setFileName (const QString &str)
 
void setIndex (int indx)
 
void setInfoParsed ()
 
void setMimeTag (const QString &str)
 
void setName (const QString &str)
 
void setOffset (int offset)
 
void setSize (int size)
 
void setTitleParsed ()
 
int size () const
 
bool titleParsed () const
 
void unsetDataParser ()
 
- Public Member Functions inherited from KTnef::KTNEFPropertySet
 KTNEFPropertySet ()
 
 ~KTNEFPropertySet ()
 
void addAttribute (int key, int type, const QVariant &value, bool overwrite=false)
 
void addProperty (int key, int type, const QVariant &value, const QVariant &name=QVariant(), bool overwrite=false)
 
QVariant attribute (int key) const
 
QMap< int, KTNEFProperty * > & attributes ()
 
const QMap< int, KTNEFProperty * > & attributes () const
 
void clear (bool deleteAll=false)
 
QString findNamedProp (const QString &name, const QString &fallback=QString(), bool convertToUpper=false) const
 
QString findProp (int key, const QString &fallback=QString(), bool convertToUpper=false) const
 
QMap< int, KTNEFProperty * > & properties ()
 
const QMap< int, KTNEFProperty * > & properties () const
 
QVariant property (int key) const
 

Detailed Description

Represents a TNEF attachment.

Definition at line 51 of file ktnefattach.h.

Member Enumeration Documentation

enum KTnef::KTNEFAttach::ParseState

The different attachment parsed states.

Enumerator
Unparsed 

Unparsed.

TitleParsed 

The title is parsed.

DataParsed 

The data is parsed.

InfoParsed 

The info is parsed.

Definition at line 57 of file ktnefattach.h.

Constructor & Destructor Documentation

KTNEFAttach::KTNEFAttach ( )

Constructs a TNEF attachment.

Private class that helps to provide binary compatibility between releases.

Definition at line 57 of file ktnefattach.cpp.

KTNEFAttach::~KTNEFAttach ( )

Destroys the TNEF attachment.

Definition at line 66 of file ktnefattach.cpp.

Member Function Documentation

bool KTNEFAttach::checkState ( int  state) const

Sets/Unsets the attachment state according to the state flag must be a ParseState type.

Parameters
statea ParseState type.
Returns
true if the state is turned-on; else returns false.

Definition at line 106 of file ktnefattach.cpp.

bool KTNEFAttach::dataParsed ( ) const

Returns true if the ParseState::DataParsed flag is set; else returns false.

Definition at line 96 of file ktnefattach.cpp.

QString KTNEFAttach::displayName ( ) const

Returns the display name of the attachment.

Definition at line 174 of file ktnefattach.cpp.

int KTNEFAttach::displaySize ( ) const

Returns the display size of the attachment.

Definition at line 132 of file ktnefattach.cpp.

QString KTNEFAttach::extension ( ) const

Returns the filename extension of the attachment.

Definition at line 194 of file ktnefattach.cpp.

QString KTNEFAttach::fileName ( ) const

Returns the filename of the attachment.

Definition at line 164 of file ktnefattach.cpp.

int KTNEFAttach::index ( ) const

Returns the index of the attachment.

Definition at line 153 of file ktnefattach.cpp.

bool KTNEFAttach::infoParsed ( ) const

Returns true if the InfoParsed flag is set; else returns false.

Definition at line 101 of file ktnefattach.cpp.

QString KTNEFAttach::mimeTag ( ) const

Returns the MIME tag of the attachment.

Definition at line 184 of file ktnefattach.cpp.

QString KTNEFAttach::name ( ) const

Returns the name of the attachment.

Definition at line 142 of file ktnefattach.cpp.

int KTNEFAttach::offset ( ) const

Returns the offset value of the attachment.

Definition at line 111 of file ktnefattach.cpp.

void KTNEFAttach::setDataParsed ( )

Sets the DataParsed flag for this attachment.

Definition at line 76 of file ktnefattach.cpp.

void KTNEFAttach::setDisplayName ( const QString &  str)

Sets the display name of this attachment to str.

Parameters
stris the attachment display name to set.

Definition at line 179 of file ktnefattach.cpp.

void KTNEFAttach::setDisplaySize ( int  size)

Sets the display size of the attachment to size.

Parameters
sizeis the attachment display size to set.

Definition at line 137 of file ktnefattach.cpp.

void KTNEFAttach::setExtension ( const QString &  str)

Sets the filename extension of this attachment to str.

Parameters
stris the attachment filename extension to set.

Definition at line 199 of file ktnefattach.cpp.

void KTNEFAttach::setFileName ( const QString &  str)

Sets the filename of this attachment to str.

Parameters
stris the attachment filename to set.

Definition at line 169 of file ktnefattach.cpp.

void KTNEFAttach::setIndex ( int  indx)

Sets the index of this attachment to indx.

Parameters
indxis the attachment index to set.

Definition at line 158 of file ktnefattach.cpp.

void KTNEFAttach::setInfoParsed ( )

Sets the InfoParsed flag for this attachment.

Definition at line 86 of file ktnefattach.cpp.

void KTNEFAttach::setMimeTag ( const QString &  str)

Sets the MIME tag of this attachment to str.

Parameters
stris the attachment MIME tag to set.

Definition at line 189 of file ktnefattach.cpp.

void KTNEFAttach::setName ( const QString &  str)

Sets the name of this attachment to str.

Parameters
stris attachment name to set.

Definition at line 147 of file ktnefattach.cpp.

void KTNEFAttach::setOffset ( int  offset)

Sets the offset value of this attachment to offset.

Parameters
offsetis the attachment offset to set.

Definition at line 116 of file ktnefattach.cpp.

void KTNEFAttach::setSize ( int  size)

Sets the size of the attachment to size.

Parameters
sizeis the attachment size to set.

Definition at line 127 of file ktnefattach.cpp.

void KTNEFAttach::setTitleParsed ( )

Sets the TitleParsed flag for this attachment.

Definition at line 71 of file ktnefattach.cpp.

int KTNEFAttach::size ( ) const

Returns the size of the attachment.

Definition at line 122 of file ktnefattach.cpp.

bool KTNEFAttach::titleParsed ( ) const

Returns true if the TitleParsed flag is set; else returns false.

Definition at line 91 of file ktnefattach.cpp.

void KTNEFAttach::unsetDataParser ( )

Unsets the DataParsed flag for this attachment.

Definition at line 81 of file ktnefattach.cpp.


The documentation for this class was generated from the following files:
  • ktnefattach.h
  • ktnefattach.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:01:10 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTNEF Library

Skip menu "KTNEF Library"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal