KTnef::KTNEFWriter

KTnef::KTNEFWriter Class Reference

#include <ktnefwriter.h>

Public Types

enum  AlarmAction { Display }
 
enum  MessageType {
  Appointment, MeetingCancelled, MeetingRequest, MeetingNo,
  MeetingYes, MeetingTent
}
 
enum  Method {
  PublishNew, Obsolete, RequestNew, RequestUpdate,
  Unknown
}
 
enum  PartStat {
  NeedsAction, Accepted, Declined, Tentative,
  Delegated, Completed, InProcess
}
 
enum  Priority { High = 2, Normal = 3, Low = 1 }
 
enum  Role { ReqParticipant, OptParticipant, NonParticipant, Chair }
 

Public Member Functions

 KTNEFWriter ()
 
 ~KTNEFWriter ()
 
void addAttendee (const QString &name, Role role, PartStat partstat, bool rsvp, const QString &email)
 
void addProperty (int tag, int type, const QVariant &value)
 
void clearAttendees ()
 
void setAlarm (const QString &description, AlarmAction action, const QDateTime &wakeBefore)
 
void setCategories (const QStringList &categories)
 
void setDescription (const QString &description)
 
void setDtEnd (const QDateTime &dtEnd)
 
void setDtStamp (const QDateTime &dtStamp)
 
void setDtStart (const QDateTime &dtStart)
 
void setLocation (const QString &location)
 
void setMessageType (MessageType methodType)
 
void setMethod (Method method)
 
void setOrganizer (const QString &organizer)
 
void setPriority (Priority priority)
 
void setSender (const QString &name, const QString &email)
 
void setSummary (const QString &summary)
 
void setUID (const QString &uid)
 
bool writeFile (QIODevice &file) const
 
bool writeFile (QDataStream &stream) const
 
bool writeProperty (QDataStream &stream, int &bytes, int tag) const
 

Detailed Description

Manages the writing of TNEF attachments.

Definition at line 38 of file ktnefwriter.h.

Member Enumeration Documentation

The different alarm actions.

Enumerator
Display 

Display the alarm.

Definition at line 99 of file ktnefwriter.h.

The different types of messages.

Enumerator
Appointment 

Appointment.

MeetingCancelled 

The meeting is cancelled.

MeetingRequest 

Meeting request.

MeetingNo 

Negative response to a meeting request.

MeetingYes 

Affirmative response to a meeting request.

MeetingTent 

Tentative affirmative to a meeting request.

Definition at line 44 of file ktnefwriter.h.

The different types of message statuses.

Enumerator
PublishNew 

Publish new.

Obsolete 

Replace the message.

RequestNew 

Request a new message.

RequestUpdate 

Request an update.

Unknown 

Unknown.

Definition at line 56 of file ktnefwriter.h.

The different types of participant statuses.

Enumerator
NeedsAction 

No information about the task/invitation received.

Accepted 

Accepted the task/invitation.

Declined 

Declined the task/invitation.

Tentative 

Tentatively accepted the task/invitation.

Delegated 

Delegated the task to another.

Completed 

Completed the task.

InProcess 

Work on the task is in-progress.

Definition at line 77 of file ktnefwriter.h.

The different priorities.

Enumerator
High 

High priority task.

Normal 

Normal priority task.

Low 

Low priority task.

Definition at line 90 of file ktnefwriter.h.

The different types of meeting roles.

Enumerator
ReqParticipant 

Required participant.

OptParticipant 

Optional participant.

NonParticipant 

Non-participant.

Chair 

Meeting chairperson.

Definition at line 67 of file ktnefwriter.h.

Constructor & Destructor Documentation

KTNEFWriter::KTNEFWriter ( )

Constructs a TNEF writer object.

KTNEFWriterPrivate class that helps to provide binary compatibility between releases.

Definition at line 51 of file ktnefwriter.cpp.

KTNEFWriter::~KTNEFWriter ( )

Destroys the TNEF writer object.

Definition at line 68 of file ktnefwriter.cpp.

Member Function Documentation

void KTNEFWriter::addAttendee ( const QString name,
Role  role,
PartStat  partstat,
bool  rsvp,
const QString email 
)

Adds a meeting participant (attendee).

Parameters
nameis the name of the attendee
roleis the Role of the attendee
partstatis the status PartStat of the attendee
rsvpis true if the attendee will attend the meeting; else false
emailis the email address of the attendee

Definition at line 420 of file ktnefwriter.cpp.

void KTNEFWriter::addProperty ( int  tag,
int  type,
const QVariant value 
)

Adds a TNEF property.

Parameters
tagis the TNEF tag
typeis the property type
valueis the property value

Definition at line 73 of file ktnefwriter.cpp.

void KTNEFWriter::clearAttendees ( )

Clears the attendees list.

Definition at line 415 of file ktnefwriter.cpp.

void KTNEFWriter::setAlarm ( const QString description,
AlarmAction  action,
const QDateTime wakeBefore 
)

Sets the alarm.

Parameters
descriptionis the alarm description
actionis the alaram AlarmAction
wakeBeforeis the alarm Date/Time

Definition at line 505 of file ktnefwriter.cpp.

void KTNEFWriter::setCategories ( const QStringList categories)

Sets the category list to categories.

Parameters
categoriesis the list categories.

Definition at line 479 of file ktnefwriter.cpp.

void KTNEFWriter::setDescription ( const QString description)

Sets the description to description.

Parameters
descriptionis the description.

Definition at line 485 of file ktnefwriter.cpp.

void KTNEFWriter::setDtEnd ( const QDateTime dtEnd)

Sets the Ending Date and Time to dtEnd.

Parameters
dtEndis the ending date/time.

Definition at line 455 of file ktnefwriter.cpp.

void KTNEFWriter::setDtStamp ( const QDateTime dtStamp)

Sets the timestamp to dtStamp.

Parameters
dtStampis the timestamp.

Definition at line 473 of file ktnefwriter.cpp.

void KTNEFWriter::setDtStart ( const QDateTime dtStart)

Sets the Starting Date and Time to dtStart.

Parameters
dtStartis the starting date/time.

Definition at line 449 of file ktnefwriter.cpp.

void KTNEFWriter::setLocation ( const QString location)

Sets the Location to location.

Parameters
locationis the location.

Definition at line 461 of file ktnefwriter.cpp.

void KTNEFWriter::setMessageType ( MessageType  methodType)

Sets the MessageType to methodType.

Parameters
methodTypeis the MessageType.

Definition at line 371 of file ktnefwriter.cpp.

void KTNEFWriter::setMethod ( Method  method)

Sets the Method to method.

Parameters
methodis the Method.

Definition at line 410 of file ktnefwriter.cpp.

void KTNEFWriter::setOrganizer ( const QString organizer)

Sets the name of the organizer to organizer.

The organizer is any string identifier; it could be the name of a person, or the application that sent the invitation, for example.

Parameters
organizeris the organizer identifier.

Definition at line 433 of file ktnefwriter.cpp.

void KTNEFWriter::setPriority ( Priority  priority)

Sets the priority to priority.

Parameters
priorityis the Priority.

Definition at line 499 of file ktnefwriter.cpp.

void KTNEFWriter::setSender ( const QString name,
const QString email 
)

Sets the sender's name and email address.

Parameters
nameis the sender's name.
emailis the sender's email address.

Definition at line 358 of file ktnefwriter.cpp.

void KTNEFWriter::setSummary ( const QString summary)

Sets the summary to summary.

Parameters
summaryis the summary.

Definition at line 491 of file ktnefwriter.cpp.

void KTNEFWriter::setUID ( const QString uid)

Sets the UID to uid.

Parameters
uidis the UID.

Definition at line 466 of file ktnefwriter.cpp.

bool KTNEFWriter::writeFile ( QIODevice file) const

Writes the attachment to the QIODevice specified by file.

Parameters
fileis the QIODevice to write.
Returns
true if the write was successful; otherwise false.

Definition at line 317 of file ktnefwriter.cpp.

bool KTNEFWriter::writeFile ( QDataStream stream) const

Writes the attachment to the QDataStream specified by stream.

Parameters
streamis the QDataStream to write.
Returns
true if the write was successful; otherwise false.

Definition at line 327 of file ktnefwriter.cpp.

bool KTNEFWriter::writeProperty ( QDataStream stream,
int &  bytes,
int  tag 
) const

Writes a TNEF property to the QDataStream specified by stream.

A TNEF property has a 1 byte type (LVL_MESSAGE or LVL_ATTACHMENT), a 4 byte type/tag, a 4 byte length, the data and finally the checksum.

The checksum is a 16 byte int with all bytes in the data added.

Parameters
streamis the QDataStream to write
bytesis a pointer to an int type that will contain the number of bytes written to the stream
tagis the TNEF tag
Returns
false if an invalid TNEF tag was specified by tag or if there are no properties to write; else true.

Definition at line 114 of file ktnefwriter.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Jul 1 2020 23:15:00 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.